com.cleo.lexicom.beans

Class Options

java.lang.Object

com.cleo.security.encryption.ConfigEncryption

com.cleo.lexicom.beans.Options

All Implemented Interfaces:

com.cleo.clone.LexCloneable, com.cleo.lexicom.roots.ICheckPaths, com.cleo.security.encryption.IConfigEncryption, java.lang.Cloneable

public class Options
extends com.cleo.security.encryption.ConfigEncryption
implements java.lang.Cloneable, com.cleo.clone.LexCloneable, com.cleo.lexicom.roots.ICheckPaths

Options is used to get/set various VersaLex system level options. Refer to ILexiCom.getOptions().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Options.DBConnection Database connection configuration (VLTrader and Harmony only)

Nested classes/interfaces inherited from interface com.cleo.lexicom.roots.ICheckPaths

com.cleo.lexicom.roots.ICheckPaths.CheckPath, com.cleo.lexicom.roots.ICheckPaths.UnauthorizedPath

Field Summary

Fields

Modifier and Type	Field and Description
static long	ADMIN_USERS_AUTH_TOKEN_EXPIRATION_DEFAULT
static long	ADMIN_USERS_AUTH_TOKEN_EXPIRATION_MIN
static java.lang.String	AdminUsersAuthTokenExpiration Other property - Authentication tokens issued to admin users expire after this interval
static java.lang.String	ClientSSHFTPCipherPattern Other properties - client ssh ftp properties
static java.lang.String	ClientSSHFTPKexPattern
static java.lang.String	ClientSSHFTPMacPattern
static java.lang.String	ClientSSHFTPPublicKeyPattern
static java.lang.String	ClusterNetworkNotFullyReachable Other property - If true will keep elasticsearch from trying to replicate across the cluster
static int	CorePoolSize
static java.lang.String	DEFAULT_WEB_THEME Default web theme
static java.lang.String	DISABLE_ANONYMOUS_ACCESS_TOKENS_IN_PORTAL_DEFAULT
static java.lang.String	DisableAnonymousAccessTokensInPortal Other property - Disables generation and use of links that can be used to access files/folders in Portal without an authenticated user.
static java.lang.String	DisableUnifyInPortal Other property - Disable Unify In Portal
static java.lang.String	DocumentDBHealthCheckRetryAttempts Other property - Number of consecutive health checks that must fail before a document db restart is attempted
static java.lang.String	DocumentDBMaximumResultWindow Other property - Maximum value of from + size for searches to a document db index
static java.lang.String	DocumentDBQueryMaximumTotalHits Other property - Maximum query total hits for the document db
static java.lang.String	DocumentDBQueryPageSize Other property - Maximum query page size for the document db
static java.lang.String	EmailAndExecuteOnResolution Other properties - email notification tuning
static java.lang.String	EmailLocalAndPartnerActivationNotifications
static java.lang.String	HighPriorityTransfersPercentageAvailableBandwidth Other property - Percentage of the detected available bandwidth that is allotted to transfers marked as high priority.
static java.lang.String	LDAPSSLMaximumProtocolVersion
static java.lang.String	MaximumNumberOfConcurrentUsers Other property - Maximum number of concurrent web UI users
static java.lang.String	MaximumNumberOfTriggerEventThreads Other property - Maximum number of Trigger Event execution Thread Pool Threads
static java.lang.String	MaximumTriggerPersistorFileSize Other property - Maximum size of the trigger persistant file.
static java.lang.String	NOSSL
static long	PORTAL_ANON_DL_TOKEN_EXPIRATION_DEFAULT
static java.lang.String	PORTAL_APPLICATION_NAME_DEFAULT
static long	PORTAL_AUTH_TOKEN_EXPIRATION_DEFAULT
static long	PORTAL_AUTH_TOKEN_EXPIRATION_MIN
static java.lang.String	PORTAL_CUSTOM_FORGOT_PASSWORD_URL_DEFAULT
static int	PORTAL_IDLE_TIMEOUT_DEFAULT
static long	PORTAL_SELF_REGISTRATION_EXPIRATION_DEFAULT
static long	PORTAL_SELF_REGISTRATION_EXPIRATION_MIN
static long	PORTAL_SHARING_DATA_CACHE_EXPIRATION_DEFAULT
static long	PORTAL_TWO_FACTOR_AUTHENTICATION_REGISTRATION_EXPIRATION_DEFAULT
static long	PORTAL_TWO_FACTOR_AUTHENTICATION_REGISTRATION_EXPIRATION_MIN
static java.lang.String	PortalAnonymousDLTokenExpiration Other property - Portal anonymous download token expiration.
static java.lang.String	PortalApplicationName Other property - Application name that can be configured when the default 'Cleo Portal' is not appropriate.
static java.lang.String	PortalAuthTokenExpiration Other property - Authentication tokens issued to Portal users expire upon this duration after creation
static java.lang.String	PortalCustomForgotPasswordURL Other property - Portal forgot password redirect URL
static java.lang.String	PortalForgotPasswordLinkExpiration Other property - Portal forgot password links received in email expire upon this duration after creation
static java.lang.String	PortalIdleTimeout Other property - Idle timeout setting for Portal
static java.lang.String	PortalSelfRegistrationLinkExpiration Other property - Portal self registration links received in email expire upon this duration after creation
static java.lang.String	PortalSharingDataCacheExpiration Other property - Portal sharing data cache expiration
static java.lang.String	PortalTwoFactorAuthenticationLinkExpiration Other property - Portal two-factor authentication registration links received in email expire upon this duration after creation
static java.lang.String	RunSchedulerAutomaticallyAtStartup Other property - Indicates whether the schedule should automatically startup at system startup
static java.lang.String	SchedulerTimeoutDirOps
static java.lang.String	SchedulerTimeoutFileOps Other properties - timeouts and wait time for slow performing shares
static java.lang.String	SchedulerWaitTimeForNonresponsiveFileSystems
static java.lang.String	SSL30
static java.lang.String	TLS10
static java.lang.String	TLS11
static java.lang.String	TLS12
static java.lang.String	TLS13
static int	TRANSFER_LOG_DATABASE Database transfer logging (VLTrader and Harmony only)
static int	TRANSFER_LOG_OFF No transfer logging (VLTrader and Harmony only)
static int	TRANSFER_LOG_XML XML transfer logging (VLTrader and Harmony only)

Fields inherited from class com.cleo.security.encryption.ConfigEncryption

enc, ENC, encryptDecryptObj, PASS_PHRASE

Method Summary

Modifier and Type	Method and Description
boolean	allowPasswordRuleOverride() Returns whether password rules can be overridden in user hosts
Options.DBConnection	findDBConnection(java.lang.String connectionStr) Find the configured database connection (VLTrader and Harmony only)
java.lang.String	getBrowserEditPassword() Returns the hashed web UI edit password
java.lang.String	getBrowserViewOnlyPassword() Returns the hashed web UI view-only password
java.lang.String	getInbox() testClass Get the default system payload inbox
int	getIntegratedWebUITimeout() Get the integrated web UI timeout
java.lang.String	getInterval(java.lang.String name) Get one of the interval properties
java.lang.String	getOther(java.lang.String name) Get one of the other properties
java.lang.String	getOutbox() Get the default system payload outbox
java.util.ArrayList<com.cleo.lexicom.roots.ICheckPaths.CheckPath>	getPathsToCheck()
java.lang.String	getReceivedbox() Get the default system payload receivedbox The receivedbox is automatically populated with a copy of any payload received
java.lang.String	getSentbox() Get the default system payload sentbox The sentbox is automatically populated with a copy of any payload sent
static java.lang.String[]	getTransferLogDatabaseDDL(java.lang.String dbConnectionStr, boolean edi, boolean payload) Get the transfer log database DDL statements
int	getTransferLogging() Get transfer logging mode (VLTrader and Harmony only)
Options.DBConnection	getTransferLoggingDBConnection() Get transfer logging database connection configuration (VLTrader and Harmony only)
java.lang.String	getTransferLoggingDBConnectionStr() Get transfer logging database connection string (VLTrader and Harmony only)
java.util.ArrayList<java.lang.String>	getUnauthorizedPaths() Records all unauthorized paths for Options.
java.lang.String	getWebProductTitle() Get the web UI product title
java.lang.String	getWebTheme() Returns the current web theme
boolean	isBrowserViewOnlyDefaultMode() Returns whether the web UI default mode is view-only
boolean	isCleoSupportVisible() Indicates whether direct Cleo support links/buttons are hidden
boolean	isConnectorDebug(java.lang.String[] schemeNames)
boolean	isSoftwareUpdateEnabled() Indicates whether the VersaLex software update feature is enabled
Options.DBConnection	newDBConnection() Instantiate a new database connection configuration
void	removeDBConnection(java.lang.String connectionStr) Remove the configured database connection (VLTrader and Harmony only)
void	save() Save the current settings; passwords encrypted when saved
void	setBrowserEditPassword(java.lang.String browserEditPassword) Set the web UI edit password
void	setBrowserViewOnlyDefaultMode(boolean browserViewOnlyDefaultMode) Set whether the web UI default mode is view-only
void	setBrowserViewOnlyPassword(java.lang.String browserViewOnlyPassword) Set the web UI view-only password
void	setCleoSupportVisible(boolean cleoSupportVisible) Show/hide Cleo support request link and support bundle send button
void	setInbox(java.lang.String inbox) Set the default system payload inbox
void	setIntegratedWebUITimeout(int integratedWebUITimeout) Set the integrated web UI timeout
void	setInterval(java.lang.String name, java.lang.String value) Set one of the interval properties
void	setOther(java.lang.String name, java.lang.String value) Set one of the other properties
void	setOutbox(java.lang.String outbox) Set the default system payload outbox
void	setReceivedbox(java.lang.String receivedbox) Set the default system payload receivedbox The receivedbox is automatically populated with a copy of any payload received
void	setSentbox(java.lang.String sentbox) Set the default system payload sentbox The sentbox is automatically populated with a copy of any payload sent
void	setSoftwareUpdateEnabled(boolean softwareUpdateEnabled) Enable/disable the VersaLex software update feature
void	setTransferLogging(int transferLogging) Set transfer logging mode (VLTrader and Harmony only)
void	setTransferLoggingDBConnectionStr(java.lang.String transferLoggingDBConnectionStr) Set transfer logging database connection string (VLTrader and Harmony only)
void	setWebProductTitle(java.lang.String webProductTitle) Override the default web UI product title (e.g.
void	setWebTheme(java.lang.String webTheme) Set the theme for the web UI
java.lang.String	toString()
void	updateDBConnection(Options.DBConnection dbconnection) Update (or add) the database connection configuration (VLTrader and Harmony only)

Methods inherited from class com.cleo.security.encryption.ConfigEncryption

checkEncAttribute, clone, getActiveKeyID, getEnc, getEncryptDecrypt, getPassPhrase, hasPassPhrase, newEncryptDecrypt, setEnc, setEncAttribute, setPassPhrase

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TRANSFER_LOG_OFF

public static final int TRANSFER_LOG_OFF

No transfer logging (VLTrader and Harmony only)

See Also:

Constant Field Values

TRANSFER_LOG_DATABASE

public static final int TRANSFER_LOG_DATABASE

Database transfer logging (VLTrader and Harmony only)

See Also:

Constant Field Values

TRANSFER_LOG_XML

public static final int TRANSFER_LOG_XML

XML transfer logging (VLTrader and Harmony only)

See Also:

Constant Field Values

DEFAULT_WEB_THEME

public static final java.lang.String DEFAULT_WEB_THEME

Default web theme

See Also:

Constant Field Values

MaximumNumberOfConcurrentUsers

public static final java.lang.String MaximumNumberOfConcurrentUsers

Other property - Maximum number of concurrent web UI users

See Also:

Constant Field Values

HighPriorityTransfersPercentageAvailableBandwidth

public static final java.lang.String HighPriorityTransfersPercentageAvailableBandwidth

Other property - Percentage of the detected available bandwidth that is allotted to transfers marked as high priority.

See Also:

Constant Field Values

MaximumNumberOfTriggerEventThreads

public static final java.lang.String MaximumNumberOfTriggerEventThreads

Other property - Maximum number of Trigger Event execution Thread Pool Threads

See Also:

Constant Field Values

CorePoolSize

public static final int CorePoolSize

See Also:

Constant Field Values

MaximumTriggerPersistorFileSize

public static final java.lang.String MaximumTriggerPersistorFileSize

Other property - Maximum size of the trigger persistant file.

See Also:

Constant Field Values

ClusterNetworkNotFullyReachable

public static final java.lang.String ClusterNetworkNotFullyReachable

Other property - If true will keep elasticsearch from trying to replicate across the cluster

See Also:

Constant Field Values

PortalApplicationName

public static final java.lang.String PortalApplicationName

Other property - Application name that can be configured when the default 'Cleo Portal' is not appropriate.

See Also:

Constant Field Values

PORTAL_APPLICATION_NAME_DEFAULT

public static final java.lang.String PORTAL_APPLICATION_NAME_DEFAULT

PortalForgotPasswordLinkExpiration

public static final java.lang.String PortalForgotPasswordLinkExpiration

Other property - Portal forgot password links received in email expire upon this duration after creation

See Also:

Constant Field Values

PortalCustomForgotPasswordURL

public static final java.lang.String PortalCustomForgotPasswordURL

Other property - Portal forgot password redirect URL

See Also:

Constant Field Values

PORTAL_CUSTOM_FORGOT_PASSWORD_URL_DEFAULT

public static final java.lang.String PORTAL_CUSTOM_FORGOT_PASSWORD_URL_DEFAULT

See Also:

Constant Field Values

PortalAuthTokenExpiration

public static final java.lang.String PortalAuthTokenExpiration

Other property - Authentication tokens issued to Portal users expire upon this duration after creation

See Also:

Constant Field Values

PORTAL_AUTH_TOKEN_EXPIRATION_DEFAULT

public static final long PORTAL_AUTH_TOKEN_EXPIRATION_DEFAULT

See Also:

Constant Field Values

PORTAL_AUTH_TOKEN_EXPIRATION_MIN

public static final long PORTAL_AUTH_TOKEN_EXPIRATION_MIN

See Also:

Constant Field Values

PortalSelfRegistrationLinkExpiration

public static final java.lang.String PortalSelfRegistrationLinkExpiration

Other property - Portal self registration links received in email expire upon this duration after creation

See Also:

Constant Field Values

PORTAL_SELF_REGISTRATION_EXPIRATION_DEFAULT

public static final long PORTAL_SELF_REGISTRATION_EXPIRATION_DEFAULT

PORTAL_SELF_REGISTRATION_EXPIRATION_MIN

public static final long PORTAL_SELF_REGISTRATION_EXPIRATION_MIN

See Also:

Constant Field Values

PortalTwoFactorAuthenticationLinkExpiration

public static final java.lang.String PortalTwoFactorAuthenticationLinkExpiration

Other property - Portal two-factor authentication registration links received in email expire upon this duration after creation

See Also:

Constant Field Values

PORTAL_TWO_FACTOR_AUTHENTICATION_REGISTRATION_EXPIRATION_DEFAULT

public static final long PORTAL_TWO_FACTOR_AUTHENTICATION_REGISTRATION_EXPIRATION_DEFAULT

PORTAL_TWO_FACTOR_AUTHENTICATION_REGISTRATION_EXPIRATION_MIN

public static final long PORTAL_TWO_FACTOR_AUTHENTICATION_REGISTRATION_EXPIRATION_MIN

See Also:

Constant Field Values

PortalAnonymousDLTokenExpiration

public static final java.lang.String PortalAnonymousDLTokenExpiration

Other property - Portal anonymous download token expiration. This determines how long anonymous links to files/folders will be active for.

See Also:

Constant Field Values

PORTAL_ANON_DL_TOKEN_EXPIRATION_DEFAULT

public static final long PORTAL_ANON_DL_TOKEN_EXPIRATION_DEFAULT

DisableAnonymousAccessTokensInPortal

public static final java.lang.String DisableAnonymousAccessTokensInPortal

Other property - Disables generation and use of links that can be used to access files/folders in Portal without an authenticated user.

See Also:

Constant Field Values

DISABLE_ANONYMOUS_ACCESS_TOKENS_IN_PORTAL_DEFAULT

public static final java.lang.String DISABLE_ANONYMOUS_ACCESS_TOKENS_IN_PORTAL_DEFAULT

See Also:

Constant Field Values

PortalSharingDataCacheExpiration

public static final java.lang.String PortalSharingDataCacheExpiration

Other property - Portal sharing data cache expiration

See Also:

Constant Field Values

PORTAL_SHARING_DATA_CACHE_EXPIRATION_DEFAULT

public static final long PORTAL_SHARING_DATA_CACHE_EXPIRATION_DEFAULT

See Also:

Constant Field Values

PortalIdleTimeout

public static final java.lang.String PortalIdleTimeout

Other property - Idle timeout setting for Portal

See Also:

Constant Field Values

PORTAL_IDLE_TIMEOUT_DEFAULT

public static final int PORTAL_IDLE_TIMEOUT_DEFAULT

See Also:

Constant Field Values

DisableUnifyInPortal

public static final java.lang.String DisableUnifyInPortal

Other property - Disable Unify In Portal

See Also:

Constant Field Values

AdminUsersAuthTokenExpiration

public static final java.lang.String AdminUsersAuthTokenExpiration

Other property - Authentication tokens issued to admin users expire after this interval

See Also:

Constant Field Values

ADMIN_USERS_AUTH_TOKEN_EXPIRATION_DEFAULT

public static final long ADMIN_USERS_AUTH_TOKEN_EXPIRATION_DEFAULT

See Also:

Constant Field Values

ADMIN_USERS_AUTH_TOKEN_EXPIRATION_MIN

public static final long ADMIN_USERS_AUTH_TOKEN_EXPIRATION_MIN

See Also:

Constant Field Values

DocumentDBQueryPageSize

public static final java.lang.String DocumentDBQueryPageSize

Other property - Maximum query page size for the document db

See Also:

Constant Field Values

DocumentDBQueryMaximumTotalHits

public static final java.lang.String DocumentDBQueryMaximumTotalHits

Other property - Maximum query total hits for the document db

See Also:

Constant Field Values

DocumentDBMaximumResultWindow

public static final java.lang.String DocumentDBMaximumResultWindow

Other property - Maximum value of from + size for searches to a document db index

See Also:

Constant Field Values

DocumentDBHealthCheckRetryAttempts

public static final java.lang.String DocumentDBHealthCheckRetryAttempts

Other property - Number of consecutive health checks that must fail before a document db restart is attempted

See Also:

Constant Field Values

RunSchedulerAutomaticallyAtStartup

public static final java.lang.String RunSchedulerAutomaticallyAtStartup

Other property - Indicates whether the schedule should automatically startup at system startup

See Also:

Constant Field Values

LDAPSSLMaximumProtocolVersion

public static final java.lang.String LDAPSSLMaximumProtocolVersion

See Also:

Constant Field Values

SchedulerTimeoutFileOps

public static final java.lang.String SchedulerTimeoutFileOps

Other properties - timeouts and wait time for slow performing shares

See Also:

Constant Field Values

SchedulerTimeoutDirOps

public static final java.lang.String SchedulerTimeoutDirOps

See Also:

Constant Field Values

SchedulerWaitTimeForNonresponsiveFileSystems

public static final java.lang.String SchedulerWaitTimeForNonresponsiveFileSystems

See Also:

Constant Field Values

EmailAndExecuteOnResolution

public static final java.lang.String EmailAndExecuteOnResolution

Other properties - email notification tuning

See Also:

Constant Field Values

EmailLocalAndPartnerActivationNotifications

public static final java.lang.String EmailLocalAndPartnerActivationNotifications

See Also:

Constant Field Values

ClientSSHFTPCipherPattern

public static final java.lang.String ClientSSHFTPCipherPattern

Other properties - client ssh ftp properties

See Also:

Constant Field Values

ClientSSHFTPMacPattern

public static final java.lang.String ClientSSHFTPMacPattern

See Also:

Constant Field Values

ClientSSHFTPKexPattern

public static final java.lang.String ClientSSHFTPKexPattern

See Also:

Constant Field Values

ClientSSHFTPPublicKeyPattern

public static final java.lang.String ClientSSHFTPPublicKeyPattern

See Also:

Constant Field Values

NOSSL

public static final java.lang.String NOSSL

See Also:

Constant Field Values

SSL30

public static final java.lang.String SSL30

See Also:

Constant Field Values

TLS10

public static final java.lang.String TLS10

See Also:

Constant Field Values

TLS11

public static final java.lang.String TLS11

See Also:

Constant Field Values

TLS12

public static final java.lang.String TLS12

See Also:

Constant Field Values

TLS13

public static final java.lang.String TLS13

See Also:

Constant Field Values

Method Detail

getInbox

public java.lang.String getInbox()

testClass Get the default system payload inbox

Returns:

default inbox directory path (cannot be null)

getOutbox

public java.lang.String getOutbox()

Get the default system payload outbox

Returns:

default outbox directory path (cannot be null)

getSentbox

public java.lang.String getSentbox()

Get the default system payload sentbox

The sentbox is automatically populated with a copy of any payload sent

Returns:

default sentbox directory path (can be null)

getReceivedbox

public java.lang.String getReceivedbox()

Get the default system payload receivedbox

The receivedbox is automatically populated with a copy of any payload received

Returns:

default receivedbox directory path (can be null)

isConnectorDebug

public boolean isConnectorDebug(java.lang.String[] schemeNames)

getTransferLogging

public int getTransferLogging()

Get transfer logging mode (VLTrader and Harmony only)

Returns:

either TRANSFER_LOG_OFF, TRANSFER_LOG_DATABASE, or TRANSFER_LOG_XML

getTransferLoggingDBConnectionStr

public java.lang.String getTransferLoggingDBConnectionStr()

Get transfer logging database connection string (VLTrader and Harmony only)

Returns:

the transfer logging database connection string

getTransferLoggingDBConnection

public Options.DBConnection getTransferLoggingDBConnection()

Get transfer logging database connection configuration (VLTrader and Harmony only)

Returns:

the transfer logging database connection configuration

findDBConnection

public Options.DBConnection findDBConnection(java.lang.String connectionStr)

Find the configured database connection (VLTrader and Harmony only)

Parameters:

connectionStr - the database connection string

Returns:

the database connection configuration

removeDBConnection

public void removeDBConnection(java.lang.String connectionStr)

Remove the configured database connection (VLTrader and Harmony only)

Parameters:

connectionStr - the database connection string

getBrowserViewOnlyPassword

public java.lang.String getBrowserViewOnlyPassword()

Returns the hashed web UI view-only password

Returns:

the hashed web UI view-only password

getBrowserEditPassword

public java.lang.String getBrowserEditPassword()

Returns the hashed web UI edit password

Returns:

the hashed web UI edit password

isBrowserViewOnlyDefaultMode

public boolean isBrowserViewOnlyDefaultMode()

Returns whether the web UI default mode is view-only

Returns:

true if the web UI default mode is view-only

getOther

public java.lang.String getOther(java.lang.String name)

Get one of the other properties

Parameters:

name - property name (e.g. MaximumNumberOfConcurrentUsers)

Returns:

property value

getInterval

public java.lang.String getInterval(java.lang.String name)

Get one of the interval properties

Parameters:

name - property name (e.g. MaximumNumberOfConcurrentUsers)

Returns:

property value

allowPasswordRuleOverride

public boolean allowPasswordRuleOverride()

Returns whether password rules can be overridden in user hosts

Returns:

true if password rules can be overridden in user hosts; false otherwise

getWebTheme

public java.lang.String getWebTheme()

Returns the current web theme

Returns:

either DEFAULT_WEB_THEME or some custom setting

isSoftwareUpdateEnabled

public boolean isSoftwareUpdateEnabled()

Indicates whether the VersaLex software update feature is enabled

Returns:

false if the software update feature is disabled

isCleoSupportVisible

public boolean isCleoSupportVisible()

Indicates whether direct Cleo support links/buttons are hidden

Returns:

false if direct Cleo support links/buttons are hidden

getWebProductTitle

public java.lang.String getWebProductTitle()

Get the web UI product title

Returns:

the web UI product title

getIntegratedWebUITimeout

public int getIntegratedWebUITimeout()

Get the integrated web UI timeout

Returns:

the integrated web UI timeout (minutes)

setInbox

public void setInbox(java.lang.String inbox)

Set the default system payload inbox

Parameters:

inbox - default inbox directory path (cannot be null)

setOutbox

public void setOutbox(java.lang.String outbox)

Set the default system payload outbox

Parameters:

outbox - default outbox directory path (cannot be null)

setSentbox

public void setSentbox(java.lang.String sentbox)

Set the default system payload sentbox

The sentbox is automatically populated with a copy of any payload sent

Parameters:

sentbox - default sentbox directory path (can be null)

setReceivedbox

public void setReceivedbox(java.lang.String receivedbox)

Set the default system payload receivedbox

The receivedbox is automatically populated with a copy of any payload received

Parameters:

receivedbox - default receivedbox directory path (can be null)

setTransferLogging

public void setTransferLogging(int transferLogging)

Set transfer logging mode (VLTrader and Harmony only)

Parameters:

transferLogging - either TRANSFER_LOG_OFF, TRANSFER_LOG_DATABASE, or TRANSFER_LOG_XML

setTransferLoggingDBConnectionStr

public void setTransferLoggingDBConnectionStr(java.lang.String transferLoggingDBConnectionStr)

Set transfer logging database connection string (VLTrader and Harmony only)

Parameters:

transferLoggingDBConnectionStr - the transfer logging database connection string

getTransferLogDatabaseDDL

public static java.lang.String[] getTransferLogDatabaseDDL(java.lang.String dbConnectionStr,
                                                           boolean edi,
                                                           boolean payload)
                                                    throws java.lang.Exception

Get the transfer log database DDL statements

Parameters:

dbConnectionStr - the database connection string

edi - true to include database EDI logging DDL statements

payload - true to include database payload DDL statements

Returns:

the DDL statements

Throws:

java.lang.Exception

updateDBConnection

public void updateDBConnection(Options.DBConnection dbconnection)

Update (or add) the database connection configuration (VLTrader and Harmony only)

Parameters:

dbconnection - the database connection

setBrowserViewOnlyPassword

public void setBrowserViewOnlyPassword(java.lang.String browserViewOnlyPassword)

Set the web UI view-only password

Parameters:

browserViewOnlyPassword - the web UI view-only password

setBrowserEditPassword

public void setBrowserEditPassword(java.lang.String browserEditPassword)

Set the web UI edit password

Parameters:

browserEditPassword - the web UI edit password

setBrowserViewOnlyDefaultMode

public void setBrowserViewOnlyDefaultMode(boolean browserViewOnlyDefaultMode)

Set whether the web UI default mode is view-only

Parameters:

browserViewOnlyDefaultMode - true if the web UI default mode is view-only

setOther

public void setOther(java.lang.String name,
                     java.lang.String value)
              throws java.lang.Exception

Set one of the other properties

Parameters:

name - property name (e.g. MaximumNumberOfConcurrentUsers)

value - appropriate property value

Throws:

java.lang.Exception

setInterval

public void setInterval(java.lang.String name,
                        java.lang.String value)
                 throws java.lang.Exception

Set one of the interval properties

Parameters:

name - property name

value - appropriate property value

Throws:

java.lang.Exception

setWebTheme

public void setWebTheme(java.lang.String webTheme)
                 throws java.lang.Exception

Set the theme for the web UI

Parameters:

webTheme - either DEFAULT_WEB_THEME or some custom setting

Throws:

java.lang.Exception

setSoftwareUpdateEnabled

public void setSoftwareUpdateEnabled(boolean softwareUpdateEnabled)

Enable/disable the VersaLex software update feature

Parameters:

softwareUpdateEnabled - false if the software update feature should be disabled

setCleoSupportVisible

public void setCleoSupportVisible(boolean cleoSupportVisible)

Show/hide Cleo support request link and support bundle send button

Parameters:

cleoSupportVisible - false if the direct Cleo support links/buttons should be hidden

setWebProductTitle

public void setWebProductTitle(java.lang.String webProductTitle)

Override the default web UI product title (e.g. Cleo VLTrader)

Parameters:

webProductTitle - the new web UI product title (can be an empty string)

setIntegratedWebUITimeout

public void setIntegratedWebUITimeout(int integratedWebUITimeout)

Set the integrated web UI timeout

Parameters:

integratedWebUITimeout - the integrated web UI timeout (minutes)

save

public void save()
          throws java.lang.Exception

Save the current settings; passwords encrypted when saved

Throws:

java.lang.Exception

newDBConnection

public Options.DBConnection newDBConnection()

Instantiate a new database connection configuration

getPathsToCheck

public java.util.ArrayList<com.cleo.lexicom.roots.ICheckPaths.CheckPath> getPathsToCheck()

Specified by:

getPathsToCheck in interface com.cleo.lexicom.roots.ICheckPaths

getUnauthorizedPaths

public java.util.ArrayList<java.lang.String> getUnauthorizedPaths()

Records all unauthorized paths for Options.

Returns:

an array list of infractions.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object