Package com.appiancorp.suiteapi.messaging

Class JmsConfiguration

java.lang.Object

com.appiancorp.common.config.AbstractConfiguration

com.appiancorp.suiteapi.messaging.JmsConfiguration

public class JmsConfiguration
extends com.appiancorp.common.config.AbstractConfiguration

Contains the values pulled out of jms.properties. Also contains the keys that should be used in jms.properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMBEDDED_BROKER_ENABLED_KEY
static final String	JMS_CONNECTION_FACTORY_RESOURCE

Fields inherited from class com.appiancorp.common.config.AbstractConfiguration

AE_HOME_KEY, CUSTOM_PROPERTIES_NAME, DELIMITER, SYS_PROPS_PREFIX

Constructor Summary

Constructors

Constructor	Description
JmsConfiguration()

Method Summary

Modifier and Type	Method	Description
String	getClientIdPrefix()	The prefix to use for auto-generated client IDs.
List<String>	getClientIds()	The client IDs to use for connecting to JMS.
int	getClientIdsSize()
List<String>	getConnectionFactoryNames()
String	getCreateConnectionPassword()	The password used for the JMS createConnection method.
String	getCreateConnectionUsername()	The username used for the JMS createConnection method.
String	getEmbeddedBrokerUrl()	The broker URL to use when running an embedded JMS broker
int	getMaxTopicConnections()	The maximum number of topic connections.
String	getProcessTopic()
String	getQueuePrefix()	The queue prefix.
String	getTopicPrefix()	The topic prefix.
String	getURL()	The java.naming.provider.url to use.
boolean	isEmbeddedBrokerEnabled()	Should a local embedded broker be started, if a jms/AppianProcessIntegrationConnectionFactory is also defined default true

Methods inherited from class com.appiancorp.common.config.AbstractConfiguration

cacheConfigurationValues, clearCache, getAeHome, getBoolean, getClass, getConfiguration, getDefaultFileRefreshMs, getDouble, getDuration, getHostAndPort, getHostAndPortSet, getInt, getInteger, getIntegerSet, getKeys, getList, getList, getLong, getNonZeroPositiveInt, getPositiveInt, getPositiveLong, getResourceBundleName, getResourceKey, getSet, getSet, getString, getString, getStringIgnoringCache, getVersion, getVersion, init, init, loadCustomPropertiesConfiguration, loadCustomPropertiesFile, loadFallbackPropertiesConfigurations, onReload, setBooleanKeyListener, subset

Methods inherited from class java.lang.Object

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

Field Details

JMS_CONNECTION_FACTORY_RESOURCE

public static final String JMS_CONNECTION_FACTORY_RESOURCE

See Also:

• Constant Field Values

EMBEDDED_BROKER_ENABLED_KEY

public static final String EMBEDDED_BROKER_ENABLED_KEY

See Also:

• Constant Field Values

Constructor Details

JmsConfiguration

public JmsConfiguration()

Method Details

getClientIds

public List<String> getClientIds()

The client IDs to use for connecting to JMS. These IDs are represented in a comma-delimited string in the file, and this string is split up into an array of client IDs. Either CLIENT_IDS_KEY or both CLIENT_ID_PREFIX_KEY and MAX_CONNECTIONS_KEY must be populated.

getClientIdPrefix

public String getClientIdPrefix()

The prefix to use for auto-generated client IDs. Either CLIENT_IDS_KEY or both CLIENT_ID_PREFIX_KEY and MAX_CONNECTIONS_KEY must be populated.

getMaxTopicConnections

public int getMaxTopicConnections()

The maximum number of topic connections. Either CLIENT_IDS_KEY or both CLIENT_ID_PREFIX_KEY and MAX_CONNECTIONS_KEY must be populated.

getConnectionFactoryNames

public List<String> getConnectionFactoryNames()

getProcessTopic

public String getProcessTopic()

getTopicPrefix

public String getTopicPrefix()

The topic prefix. This will be prepended to all topic names before sending an InternalJmsMessage to JMS. The topic prefix is often defined by the JMS provider.

getQueuePrefix

public String getQueuePrefix()

The queue prefix. This will be prepended to all queue names before sending an InternalJmsMessage to JMS. The topic prefix is often defined by the JMS provider.

getCreateConnectionUsername

public String getCreateConnectionUsername()

The username used for the JMS createConnection method.

getCreateConnectionPassword

public String getCreateConnectionPassword()

The password used for the JMS createConnection method.

getURL

public String getURL()

The java.naming.provider.url to use.

getClientIdsSize

public int getClientIdsSize()

getEmbeddedBrokerUrl

public String getEmbeddedBrokerUrl()

The broker URL to use when running an embedded JMS broker

isEmbeddedBrokerEnabled

public boolean isEmbeddedBrokerEnabled()

Should a local embedded broker be started, if a jms/AppianProcessIntegrationConnectionFactory is also defined default true