com.appiancorp.suiteapi.cfg

Interface Configuration

public interface Configuration

Interface that exposes the public configuration properties in custom.properties for use in custom code. To obtain an instance that implements the interface use ConfigurationLoader.getConfiguration().

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAbsoluteStaticPluginResource(java.lang.String moduleCompleteKey, java.lang.String resourceName) A helper method to return a url for 'plugin' resources.
java.lang.String	getAeLogs() Corresponds to conf.suite.AE_LOGS in custom.properties.
int	getAlertMessageLimit() Corresponds to conf.suite.ALERT_MESSAGE_LIMIT in custom.properties.
int	getAlertSubjectLimit() Corresponds to conf.suite.ALERT_SUBJECT_LIMIT in custom.properties.
java.util.Map<java.lang.String,java.lang.String>	getAliasMap() Corresponds to conf.mailhandler.alias.* in custom.properties.
java.lang.String	getAppianName() Corresponds to resources.appian.ap.application.appian.ap.appianName in custom.properties.
java.lang.String	getAppianVersion() Corresponds to Appian release version.
java.lang.String	getAppname() Corresponds to resources.appian.ap.application.appian.ap.appname in custom.properties.
int	getArvLimit() Corresponds to resources.appian.process.application.arv.limit in custom.properties.
int	getAutoArchiveDelay() Corresponds to conf.suite.AUTO_ARCHIVE_DELAY in custom.properties.
int	getAutocompleteCacheMaxSize() Corresponds to conf.suite.CACHE_MAX_SIZE in custom.properties.
int	getAutoDeleteDelay() Corresponds to conf.suite.AUTO_DELETE_DELAY in custom.properties.
java.io.File	getBasePath() Corresponds to conf.suite.BASE_PATH in custom.properties.
java.lang.String	getBaseUri() Corresponds to Appian server.
java.lang.String	getClientIdPrefix() Corresponds to conf.jms.clientIdPrefix.
java.util.List<java.lang.String>	getClientIds() Corresponds to conf.jms.clientIds in custom.properties.
int	getCollaborationAdministrationGroupId() Corresponds to resources.appian.ac.collaboration.COLLABORATION_ADMINISTRATION_GROUP_ID in custom.properties.
java.util.List<java.lang.String>	getConnectionFactoryNames() Corresponds to conf.jms.connectionFactory in custom.properties.
java.lang.String	getContextPath() Corresponds to conf.suite.APPLICATION_CONTEXT in custom.properties.
java.lang.String	getCopyright() Corresponds to resources.appian.ap.application.appian.ap.copyright in custom.properties.
java.lang.String	getCopyrightYear() Corresponds to resources.appian.ap.application.appian.ap.copyrightYear in custom.properties.
java.lang.String	getCreateConnectionPassword() Corresponds to conf.jms.createConnectionPassword in custom.properties.
java.lang.String	getCreateConnectionUsername() Corresponds to conf.jms.createConnectionUsername in custom.properties.
int	getDataCapArray() Corresponds to conf.suite.DATA_CAP_ARRAY in custom.properties.
int	getDataCapParagraphs() Corresponds to conf.suite.DATA_CAP_PARAGRAPHS in custom.properties.
int	getDataCapSentences() Corresponds to conf.suite.DATA_CAP_SENTENCES in custom.properties.
int	getDataCapWords() Corresponds to conf.suite.DATA_CAP_WORDS in custom.properties.
java.util.List<java.lang.String>	getDatasources() Deprecated.
int	getDataTruncSentences() Corresponds to conf.suite.DATA_TRUNC_SENTENCES in custom.properties.
java.lang.String	getDefaultEmailDomain() Corresponds to conf.mailhandler.email.domain.
java.lang.String	getDefaultEnvironment() Corresponds to conf.suite.DEFAULT_ENVIRONMENT in custom.properties.
int	getDefaultHomePageId() Corresponds to conf.suite.DEFAULT_HOME_PAGE_ID in custom.properties.
int	getDisplayNameMaxSize() Corresponds to resources.appian.ag.constants.ag.nn.maxsize in custom.properties.
int	getFirstNameMaxSize() Corresponds to resources.appian.ag.constants.ag.fn.maxsize in custom.properties.
int	getLastNameMaxSize() Corresponds to resources.appian.ag.constants.ag.ln.maxsize in custom.properties.
java.lang.String	getMailPassword() Corresponds to conf.mailhandler.mail.password in custom.properties.
java.util.List<java.lang.String>	getMailSmtpHosts() Corresponds to conf.mailhandler.mail.smtp.host.
int	getMailSmtpPort() Corresponds to conf.mailhandler.mail.smtp.port in custom.properties.
java.lang.String	getMailUser() Corresponds to conf.mailhandler.mail.user in custom.properties.
int	getMaxAutoCompleteSuggestions() Corresponds to conf.suite.MAX_AUTOCOMPLETE_SUGGESTIONS in custom.properties.
int	getMaxClientConnections() Corresponds to conf.jms.maxConnections.
int	getMaxExportRows() Deprecated. Not in use anymore
int	getMaxNumberOfMoveableObjects() Corresponds to resources.appian.ac.collaboration.MAX_NUMBER_MOVEABLE_OBJECTS in custom.properties.
int	getMaxUploadFileSize() Corresponds to resources.appian.ac.collaboration.MAX_UPLOAD_FILE_SIZE in custom.properties.
int	getMiddleNameMaxSize() Corresponds to resources.appian.ag.constants.ag.mn.maxsize in custom.properties.
int	getMinimumDocumentNameLength() Corresponds to resources.appian.ac.collaboration.MINIMUM_DOCUMENT_NAME_LENGTH in custom.properties.
java.lang.String	getNotificationSenderAddress() Corresponds to conf.mailhandler.ntf_sndr_addr in custom.properties.
java.lang.String	getPrivateScheme() Corresponds to conf.suite.PRIVATE_SCHEME in custom.properties.
java.net.URL	getPrivateSchemeLinkRoot() Combines getPrivateScheme(), getServerAndPort(), getContextPath() to form the URL base of private (internal) links.
java.lang.String	getProcessStatusIcon(long index) Corresponds to resources.appian.analytics.application.processstatus.icon.# in custom.properties.
java.lang.String	getProcessStatusIconDefault() Corresponds to resources.appian.analytics.application.processstatus.icon.default in custom.properties.
java.lang.String	getProcessTopic() Corresponds to conf.jms.processTopic in custom.properties.
java.net.URL	getPublicSchemeLinkRoot() Combines getScheme(), getServerAndPort(), getContextPath() to form the URL base of public links.
java.lang.String	getQueuePrefix() Corresponds to conf.jms.queuePrefix in custom.properties.
int	getRequestTimeoutInSeconds() Corresponds to conf.suite.REQUEST_TIMEOUT_IN_SEC in custom.properties.
java.lang.String	getScheme() Corresponds to conf.suite.SCHEME in custom.properties.
java.lang.String	getServerAndPort() Corresponds to conf.suite.SERVER_AND_PORT in custom.properties.
int	getSessionTimeoutWarn() Corresponds to resources.appian.ap.application.appian.ap.session.timeoutwarn in custom.properties.
java.lang.String	getTopicPrefix() Corresponds to conf.jms.topicPrefix in custom.properties.
java.lang.String	getVersion() Corresponds to resources.appian.ap.application.appian.ap.version in custom.properties.
java.lang.String	getWebServiceBaseUrl() Corresponds to resources.appian.webservices.application.webservice.baseurl in custom.properties.
boolean	isAutocompleteEnabled() Corresponds to conf.suite.AUTOCOMPLETE_ENABLED in custom.properties.
boolean	isMailSmtpAuth() Corresponds to conf.mailhandler.mail.smtp.auth in custom.properties.
boolean	isProduction() Corresponds to conf.suite.PRODUCTION in custom.properties.
boolean	isUddiEnabled() Determined by the settings in uddi-config.xml.

Method Detail

getMaxExportRows

@Deprecated
int getMaxExportRows()

Deprecated. Not in use anymore

Corresponds to resources.appian.analytics.application.maxexportrows in custom.properties. The default is 5000.

Returns:

the maximum number of rows that will be included when a report is exported or printed.

getProcessStatusIcon

java.lang.String getProcessStatusIcon(long index)

Corresponds to resources.appian.analytics.application.processstatus.icon.# in custom.properties.

Parameters:

index - - the index # of the icon

Returns:

a path to the process status icon image

getProcessStatusIconDefault

java.lang.String getProcessStatusIconDefault()

Corresponds to resources.appian.analytics.application.processstatus.icon.default in custom.properties.

Returns:

the path to the image for the default process status icon

getMaxUploadFileSize

int getMaxUploadFileSize()

Corresponds to resources.appian.ac.collaboration.MAX_UPLOAD_FILE_SIZE in custom.properties. The default is 1024000000 (~1GB).

Returns:

the maximum size in bytes that is allowed for a file upload

getCollaborationAdministrationGroupId

int getCollaborationAdministrationGroupId()

Corresponds to resources.appian.ac.collaboration.COLLABORATION_ADMINISTRATION_GROUP_ID in custom.properties. The default is group id 0.

Returns:

the id of the Collaboration Administrators group

getMinimumDocumentNameLength

int getMinimumDocumentNameLength()

Corresponds to resources.appian.ac.collaboration.MINIMUM_DOCUMENT_NAME_LENGTH in custom.properties. The default is 4 characters.

Returns:

the minimum number of characters required for a document name.

getMaxNumberOfMoveableObjects

int getMaxNumberOfMoveableObjects()

Corresponds to resources.appian.ac.collaboration.MAX_NUMBER_MOVEABLE_OBJECTS in custom.properties. The defualt is 4 objects.

Returns:

the number of Documents, Knowledge Center, or Folders that can be moved simultaneously.

getDatasources

@Deprecated
java.util.List<java.lang.String> getDatasources()

Deprecated.

Corresponds to conf.data.datasources in custom.properties. The datasources must be configured with the application server and registered via JNDI. These datasources are available to the Query Database smart service.

Returns:

the list of JNDI names of the datasources.

getLastNameMaxSize

int getLastNameMaxSize()

Corresponds to resources.appian.ag.constants.ag.ln.maxsize in custom.properties. Default is 35.

Returns:

the maximum length in characters of a user's last name

getMiddleNameMaxSize

int getMiddleNameMaxSize()

Corresponds to resources.appian.ag.constants.ag.mn.maxsize in custom.properties. Default is 35.

Returns:

the maximum length in characters of a user's name name

getFirstNameMaxSize

int getFirstNameMaxSize()

Corresponds to resources.appian.ag.constants.ag.fn.maxsize in custom.properties. Default is 35.

Returns:

the maximum length in characters of a user's first name

getDisplayNameMaxSize

int getDisplayNameMaxSize()

Corresponds to resources.appian.ag.constants.ag.nn.maxsize in custom.properties. Default is 35.

Returns:

the maximum length in characters of a user's nickname

getClientIds

java.util.List<java.lang.String> getClientIds()

Corresponds to conf.jms.clientIds in custom.properties. If this is not defined, both conf.jms.clientIdPrefix and conf.jms.maxConnections must be defined.

Returns:

the client IDs to use for connecting to the JMS provider

getClientIdPrefix

java.lang.String getClientIdPrefix()

Corresponds to conf.jms.clientIdPrefix. If the conf.jms.clientIds list is defined in custom.properties, that will be used. The default is "CLIENT_"

Returns:

the prefix to use for auto-generated client IDs to use for connecting to the JMS provider

getMaxClientConnections

int getMaxClientConnections()

Corresponds to conf.jms.maxConnections. Used in conjunction with conf.jms.clientIdPrefix to generated JMS client ids automatically. E.g., "CLIENT_3" Default is 20.

Returns:

the maximum number of connections

getConnectionFactoryNames

java.util.List<java.lang.String> getConnectionFactoryNames()

Corresponds to conf.jms.connectionFactory in custom.properties. Default is "jms/AppianProcessIntegrationConnectionFactory"

Returns:

the list of connection factory names for creating connections to the JMS provider

getProcessTopic

java.lang.String getProcessTopic()

Corresponds to conf.jms.processTopic in custom.properties. The default is "Process."

Returns:

the name of the Topic or Queue that contains messaged destined for Appian processes

getTopicPrefix

java.lang.String getTopicPrefix()

Corresponds to conf.jms.topicPrefix in custom.properties. Empty by default.

Returns:

the prefix prepended to all topic names before sending a message to JMS topics.

getQueuePrefix

java.lang.String getQueuePrefix()

Corresponds to conf.jms.queuePrefix in custom.properties. Empty by default.

Returns:

the prefix prepended to all topic names before sending a message to JMS topics.

getCreateConnectionUsername

java.lang.String getCreateConnectionUsername()

Corresponds to conf.jms.createConnectionUsername in custom.properties.

Returns:

the username used to connect to the JMS provider

getCreateConnectionPassword

java.lang.String getCreateConnectionPassword()

Corresponds to conf.jms.createConnectionPassword in custom.properties.

Returns:

the password used to connect to the JMS provider

getNotificationSenderAddress

java.lang.String getNotificationSenderAddress()

Corresponds to conf.mailhandler.ntf_sndr_addr in custom.properties. Default is appian-alerts@serverdomain.

Returns:

the sender address of notification emails sent from the system.

getMailSmtpHosts

java.util.List<java.lang.String> getMailSmtpHosts()

Corresponds to conf.mailhandler.mail.smtp.host. If the list is empty, no email messages will be sent from the system. Ports other than 25 can be combined with the host in the form "host:port." When sending email, the list of host is tried in sequential order until success.

Returns:

the list of SMTP hosts used for sending email.

getMailSmtpPort

int getMailSmtpPort()

Corresponds to conf.mailhandler.mail.smtp.port in custom.properties. Default is 25.

Returns:

the port used to connect to the SMTP host for sending emails

isMailSmtpAuth

boolean isMailSmtpAuth()

Corresponds to conf.mailhandler.mail.smtp.auth in custom.properties. If it is true, it is used in conjunction with getMailUser() and getMailPassword() to connect to the SMTP server to send email.

Returns:

whether or not smtp authentication is enabled

getMailUser

java.lang.String getMailUser()

Corresponds to conf.mailhandler.mail.user in custom.properties. If isMailSmtpAuth() is true, it is used in conjunction with getMailPassword() to connect to the SMTP server to send email.

Returns:

the username used to connect to the SMTP server

getMailPassword

java.lang.String getMailPassword()

Corresponds to conf.mailhandler.mail.password in custom.properties. If isMailSmtpAuth() is true, it is used in conjunction with getMailUser() to connect to the SMTP server to send email.

Returns:

the password used to connect to the SMTP server

getAliasMap

java.util.Map<java.lang.String,java.lang.String> getAliasMap()

Corresponds to conf.mailhandler.alias.* in custom.properties.

Returns:

a map of aliases to destinations for incoming email messages

getDefaultEmailDomain

java.lang.String getDefaultEmailDomain()

Corresponds to conf.mailhandler.email.domain. Default is determined automatically from the host machine's domain. REPLACE.com is returned if the machine's domain cannot be determined.

Returns:

the domain (part after the @ sign) for the from address for emails sent from the system if conf.mailhandler.ntf_sndr_addr is not set.

getAppname

java.lang.String getAppname()

Corresponds to resources.appian.ap.application.appian.ap.appname in custom.properties.

Returns:

the name of the software suite

getVersion

java.lang.String getVersion()

Corresponds to resources.appian.ap.application.appian.ap.version in custom.properties.

Returns:

the version of the software suite

See Also:

getAppianVersion()

getAppianVersion

java.lang.String getAppianVersion()

Corresponds to Appian release version. Unlike getVersion(), this version is not configurable.

Returns:

the version of the Appian suite

See Also:

getVersion()

getBaseUri

java.lang.String getBaseUri()

Corresponds to Appian server.

Returns:

the server, with port, with context path.

getCopyright

java.lang.String getCopyright()

Corresponds to resources.appian.ap.application.appian.ap.copyright in custom.properties. By default it is made up of getAppname(), getVersion(), getCopyrightYear(), getAppianName().

Returns:

the copyright statement

getCopyrightYear

java.lang.String getCopyrightYear()

Corresponds to resources.appian.ap.application.appian.ap.copyrightYear in custom.properties.

Returns:

the copyright year or year range

getAppianName

java.lang.String getAppianName()

Corresponds to resources.appian.ap.application.appian.ap.appianName in custom.properties.

Returns:

the name of the company

getSessionTimeoutWarn

int getSessionTimeoutWarn()

Corresponds to resources.appian.ap.application.appian.ap.session.timeoutwarn in custom.properties.

Returns:

the number of minutes before the timeout warning is displayed.

getArvLimit

int getArvLimit()

Corresponds to resources.appian.process.application.arv.limit in custom.properties. Default is 10.

Returns:

the limit to the number of rows processed by the Database Access node for return values

isProduction

boolean isProduction()

Corresponds to conf.suite.PRODUCTION in custom.properties. Default is true.

Returns:

whether or not the system is set to production mode

getAeLogs

java.lang.String getAeLogs()

Corresponds to conf.suite.AE_LOGS in custom.properties. Default is the "logs" directory in the installation directory.

Returns:

the path to the directory containing the log files.

getBasePath

java.io.File getBasePath()

Corresponds to conf.suite.BASE_PATH in custom.properties. Default is the "_admin" directory in the installation directory.

Returns:

the directory containing the file system data (accdocs, mini, models, etc.)

getContextPath

java.lang.String getContextPath()

Corresponds to conf.suite.APPLICATION_CONTEXT in custom.properties. Default is "suite."

Returns:

the application context used to build URLs for links

getServerAndPort

java.lang.String getServerAndPort()

Corresponds to conf.suite.SERVER_AND_PORT in custom.properties. The port portion is not needed if getScheme() is http and the port is 80 or if getScheme() is https and the port is 443.

Returns:

the host:port of the system

getScheme

java.lang.String getScheme()

Corresponds to conf.suite.SCHEME in custom.properties.

Returns:

the public facing URL scheme

getPrivateScheme

java.lang.String getPrivateScheme()

Corresponds to conf.suite.PRIVATE_SCHEME in custom.properties.

Returns:

the URL scheme used for internal server-to-server http communication

getPublicSchemeLinkRoot

java.net.URL getPublicSchemeLinkRoot()

Combines getScheme(), getServerAndPort(), getContextPath() to form the URL base of public links. E.g., "https://myserver.mydomain.com/suite"

Returns:

the base of public links

getPrivateSchemeLinkRoot

java.net.URL getPrivateSchemeLinkRoot()

Combines getPrivateScheme(), getServerAndPort(), getContextPath() to form the URL base of private (internal) links. E.g., "http://appserver1/suite"

Returns:

the base of private (internal) links

getDataCapWords

int getDataCapWords()

Corresponds to conf.suite.DATA_CAP_WORDS in custom.properties. Default is 500.

Returns:

the maximum number of characters for inputs that are intended to take words.

getDataCapSentences

int getDataCapSentences()

Corresponds to conf.suite.DATA_CAP_SENTENCES in custom.properties. Default is 500.

Returns:

the maximum number of characters for inputs that are intended to take sentences.

getDataCapParagraphs

int getDataCapParagraphs()

Corresponds to conf.suite.DATA_CAP_PARAGRAPHS in custom.properties. Default is 1000.

Returns:

the maximum number of characters for inputs that are intended to take paragraphs.

getDataCapArray

int getDataCapArray()

Corresponds to conf.suite.DATA_CAP_ARRAY in custom.properties. Default is 1000.

Returns:

the maximum number of items in an array.

getDataTruncSentences

int getDataTruncSentences()

Corresponds to conf.suite.DATA_TRUNC_SENTENCES in custom.properties. Default is 200.

Returns:

the maximum number of characters to display where output is capped (e.g., in grid cells).

getRequestTimeoutInSeconds

int getRequestTimeoutInSeconds()

Corresponds to conf.suite.REQUEST_TIMEOUT_IN_SEC in custom.properties. Default is 8 seconds.

Returns:

number of seconds of waiting for the next task in the chain to load before which the user will be redirected to the Task list

getAutoArchiveDelay

int getAutoArchiveDelay()

Corresponds to conf.suite.AUTO_ARCHIVE_DELAY in custom.properties. Default is 7 days.

Returns:

the default number of days used when configuring a model to auto-archive processes

getAutoDeleteDelay

int getAutoDeleteDelay()

Corresponds to conf.suite.AUTO_DELETE_DELAY in custom.properties. Default is 0 days. Requires the process model to be configured to automatically delete completed processes.

Returns:

the number of days used when configuring a model to auto-delete processes

getAlertSubjectLimit

int getAlertSubjectLimit()

Corresponds to conf.suite.ALERT_SUBJECT_LIMIT in custom.properties. Default is 150.

Returns:

the maximum number of characters allowed in an alert subject

getAlertMessageLimit

int getAlertMessageLimit()

Corresponds to conf.suite.ALERT_MESSAGE_LIMIT in custom.properties. Default is 1000.

Returns:

the maximum number of characters allowed in an alert message

isAutocompleteEnabled

boolean isAutocompleteEnabled()

Corresponds to conf.suite.AUTOCOMPLETE_ENABLED in custom.properties. Default is true.

Returns:

whether or not autocomplete is enabled.

getMaxAutoCompleteSuggestions

int getMaxAutoCompleteSuggestions()

Corresponds to conf.suite.MAX_AUTOCOMPLETE_SUGGESTIONS in custom.properties. Default is 12.

Returns:

the maximum number of suggestions to return with an autocomplete query

getAutocompleteCacheMaxSize

int getAutocompleteCacheMaxSize()

Corresponds to conf.suite.CACHE_MAX_SIZE in custom.properties. Default is 1000.

Returns:

the maximum number of items to cache for autocomplete

getDefaultHomePageId

int getDefaultHomePageId()

Corresponds to conf.suite.DEFAULT_HOME_PAGE_ID in custom.properties. Default is page 0.

Returns:

the id of the default home page that users see if they do not have a custom home page

getDefaultEnvironment

java.lang.String getDefaultEnvironment()

Corresponds to conf.suite.DEFAULT_ENVIRONMENT in custom.properties. Default is "apps." Possible values are "designer" or "apps."

Returns:

the name of the environment that users will log into if the URL contains only the context

getWebServiceBaseUrl

java.lang.String getWebServiceBaseUrl()

Corresponds to resources.appian.webservices.application.webservice.baseurl in custom.properties. Default is the same as getPublicSchemeLinkRoot() but may be set to a different value if the system is configured to expose web services through a different URL than the main site (uncommon).

Returns:

the base url of the web service WSDL and endpoint (part before "/webservice/processmodel/")

isUddiEnabled

boolean isUddiEnabled()

Determined by the settings in uddi-config.xml. If a element is present, this is true.

Returns:

whether or not the system is configured to publish WSDL urls to a UDDI registry

getAbsoluteStaticPluginResource

java.lang.String getAbsoluteStaticPluginResource(java.lang.String moduleCompleteKey,
                                                 java.lang.String resourceName)

A helper method to return a url for 'plugin' resources. Typical usage is to replace:

<%= request.getContextPath() %>/download/resources/plugin.key:module.key/resource.name with <%= webResourceManager.getStaticPluginResource(descriptor, resourceName) %>

This method returns a URL in an absolute format

Parameters:

moduleCompleteKey - complete plugin module key

resourceName - the name of the resource as defined in the plugin manifest

Returns:

A url that can be used to request 'plugin' resources.