com.sonicsw.esb.mgmtapi.config
Interface IJMSConnectionConfig

public interface IJMSConnectionConfig

A facade on IConnectionConfig providing direct access to JMS related configuration values. To obtain an instance of this this interface use IConnectionConfig.getAdapter(com.sonicsw.esb.mgmtapi.config.IConnectionConfig.ConnectionType), passing in IConnectionConfig.JMS_CONNECTION_TYPE

Method Summary

java.lang.String	getBrokerURLs()
java.lang.String	getCompressionFactory()
int	getConnectTimeout()
java.lang.String	getJmsConnectionID()
java.lang.String	getLoginSPIClassName()
int	getMaxReceiveSessionsPerConnection()
int	getMaxRedeliveryCount()
int	getMaxSessionAtLeastOnce()
int	getMaxSessionBestEffort()
int	getMaxSessionExactlyOnce()
int	getMaxWebServiceSessions()
int	getMonitorInterval() Gets the interval in seconds over which administrative monitoring of flow control will occur.
java.lang.String	getPassword()
long	getPingInterval()
int	getReconnectTimeout()
int	getSocketConnectTimeout()
java.lang.String	getSslCACertLocation()
java.lang.String	getSslCertForm()
java.lang.String	getSslChainFile()
java.lang.String	getSslCipherSuite()
java.lang.String	getSslPrivateKeyFile()
java.lang.String	getSslPrivateKeyPassword()
java.lang.String	getSslProviderClassName()
java.lang.String	getUserName()
boolean	isEnableCompression()
boolean	isFTEnabled()
boolean	isLoadBalancingEnabled()
void	setBrokerURLs(java.lang.String brokerURLs) Set the connection URL string which will be used to establish the connection.
void	setCompressionFactory(java.lang.String compressionFactory)
void	setConnectTimeout(int connectTimeout) Set the amount of time to attempt to establish an initial connection (in seconds)
void	setEnableCompression(boolean enableCompression)
void	setFTEnabled(boolean enabled) Enable (MQ) Fault tolerance is enabled
void	setJmsConnectionID(java.lang.String jmsConnectionID) Set the JMS connection ID used for this connection.
void	setLoadBalancingEnabled(boolean loadBalancingEnabled) Enable or disable (MQ) load-balancing on this connection.
void	setLoginSPIClassName(java.lang.String loginSPIClassName)
void	setMaxReceiveSessionsPerConnection(int maxSessionCount) set the maximum number of sessions used to send messages w/ best effort QOS
void	setMaxRedeliveryCount(int maxRedeliveryCount) set the maximum number of re-deliveries for a message.
void	setMaxSessionAtLeastOnce(int maxSessionCount) set the maximum number of sessions used to send messages w/ At least once (ALO) QOS.
void	setMaxSessionBestEffort(int maxSessionCount) set the maximum number of sessions used to send messages w/ best effort QOS
void	setMaxSessionExactlyOnce(int maxSessionCount) set the maximum number of sessions used to send messages w/ At least once (ALO) QOS.
void	setMaxWebServiceSessions(int maxWebServiceSessions) set the maximum number of sessions used to send HTTP requests.
void	setMonitorInterval(int monitorInterval) Sets the interval in seconds over which administrative monitoring of flow control will occur.
void	setPassword(java.lang.String password) Set the password used to authenticate to the broker
void	setPingInterval(long pingInterval) set the interval (in milliseconds) used to verify connection liveliness
void	setReconnectTimeout(int reconnectTimeout) Set the amount of time to attempt to reestablish a fault tolerant connection
void	setSocketConnectTimeout(int socketConnectTimeout) Set the socket connect timeout.
void	setSslCACertLocation(java.lang.String sslCACertLocation) Set file system directory in which CA certificates are searched
void	setSslCertForm(java.lang.String sslCertForm) Set the format the SSL certificate is stored in ( e.g.
void	setSslChainFile(java.lang.String sslChainFile) Set the file location which contains the SSL certificate chain.
void	setSslCipherSuite(java.lang.String sslCipherSuite) Set the set of allowed cipher suites for this connection.
void	setSslPrivateKeyFile(java.lang.String sslPrivateKeyFile)
void	setSslPrivateKeyPassword(java.lang.String sslPrivateKeyPassword) Set the password used to access the private key.
void	setSslProviderClassName(java.lang.String sslProviderClassName) Set the currently configured SSL provide name
void	setUserName(java.lang.String userName)

Method Detail

getBrokerURLs

java.lang.String getBrokerURLs()

Returns:

the URL to which a connection will be established. See the MQ programming book for advanced features (e.g. FT, load balancing etc).

setBrokerURLs

void setBrokerURLs(java.lang.String brokerURLs)

Set the connection URL string which will be used to establish the connection.

Parameters:

brokerURLs -

getUserName

java.lang.String getUserName()

Returns:

the user name used to authenticate to the broker

setUserName

void setUserName(java.lang.String userName)

Parameters:

userName - the user name used to authenticate to the broker

getPassword

java.lang.String getPassword()

Returns:

the password used to authenticate to the broker

setPassword

void setPassword(java.lang.String password)

Set the password used to authenticate to the broker

Parameters:

password - - the password

getLoginSPIClassName

java.lang.String getLoginSPIClassName()

Returns:

if custom login SPI is used, return the class name used.

setLoginSPIClassName

void setLoginSPIClassName(java.lang.String loginSPIClassName)

Parameters:

loginSPIClassName - - the custom login SPI class name to be used.

getMaxReceiveSessionsPerConnection

int getMaxReceiveSessionsPerConnection()

Returns:

the maximum number of sessions used to receive messages

setMaxReceiveSessionsPerConnection

void setMaxReceiveSessionsPerConnection(int maxSessionCount)

set the maximum number of sessions used to send messages w/ best effort QOS

Parameters:

maxSessionCount - - the number of sessions. 0 means unlimited, 1 means single

getMaxSessionBestEffort

int getMaxSessionBestEffort()

Returns:

the maximum number of sessions used to send messages w/ best effort QOS

setMaxSessionBestEffort

void setMaxSessionBestEffort(int maxSessionCount)

set the maximum number of sessions used to send messages w/ best effort QOS

Parameters:

maxSessionCount - - the number of sessions

getMaxSessionAtLeastOnce

int getMaxSessionAtLeastOnce()

Returns:

the maximum number of sessions used to send messages w/ At least once (ALO) QOS.

setMaxSessionAtLeastOnce

void setMaxSessionAtLeastOnce(int maxSessionCount)

set the maximum number of sessions used to send messages w/ At least once (ALO) QOS.

Parameters:

maxSessionCount - - the number of sessions

getMaxSessionExactlyOnce

int getMaxSessionExactlyOnce()

Returns:

the maximum number of sessions used to send messages w/ Exactly once QOS

setMaxSessionExactlyOnce

void setMaxSessionExactlyOnce(int maxSessionCount)

set the maximum number of sessions used to send messages w/ At least once (ALO) QOS.

Parameters:

maxSessionCount - - the number of sessions

getMaxWebServiceSessions

int getMaxWebServiceSessions()

Returns:

the maximum number of sessions used to send HTTP requests.

setMaxWebServiceSessions

void setMaxWebServiceSessions(int maxWebServiceSessions)

set the maximum number of sessions used to send HTTP requests.

Parameters:

maxWebServiceSessions - - the number of sessions

getMaxRedeliveryCount

int getMaxRedeliveryCount()

Returns:

the maximum number of re-deliveries for a message.

setMaxRedeliveryCount

void setMaxRedeliveryCount(int maxRedeliveryCount)

set the maximum number of re-deliveries for a message.

Parameters:

maxRedeliveryCount - - the maximum number of re-deliveries

getPingInterval

long getPingInterval()

Returns:

the interval (in milliseconds) used to verify connection liveliness

setPingInterval

void setPingInterval(long pingInterval)

set the interval (in milliseconds) used to verify connection liveliness

Parameters:

pingInterval - - interval (in milliseconds)

isFTEnabled

boolean isFTEnabled()

Returns:

true if (MQ) Fault tolerance is enabled

setFTEnabled

void setFTEnabled(boolean enabled)

Enable (MQ) Fault tolerance is enabled

Parameters:

enabled - true - enable MQ fault tolerance feature on this connection

getConnectTimeout

int getConnectTimeout()

Returns:

amount of time to attempt to establish an initial connection (in seconds)

setConnectTimeout

void setConnectTimeout(int connectTimeout)

Set the amount of time to attempt to establish an initial connection (in seconds)

Parameters:

connectTimeout - - time in seconds

getReconnectTimeout

int getReconnectTimeout()

Returns:

the amount of time to attempt to reestablish a fault tolerant connection

setReconnectTimeout

void setReconnectTimeout(int reconnectTimeout)

Set the amount of time to attempt to reestablish a fault tolerant connection

Parameters:

reconnectTimeout - - time in seconds

getJmsConnectionID

java.lang.String getJmsConnectionID()

Returns:

the JMS connection ID used for this connection.

setJmsConnectionID

void setJmsConnectionID(java.lang.String jmsConnectionID)

Set the JMS connection ID used for this connection.

Parameters:

jmsConnectionID -

isLoadBalancingEnabled

boolean isLoadBalancingEnabled()

Returns:

true if (MQ) load-balancing is enabled for this connection

setLoadBalancingEnabled

void setLoadBalancingEnabled(boolean loadBalancingEnabled)

Enable or disable (MQ) load-balancing on this connection.

Parameters:

loadBalancingEnabled -

getSslCACertLocation

java.lang.String getSslCACertLocation()

Returns:

- file system directory in which CA certificates are searched

setSslCACertLocation

void setSslCACertLocation(java.lang.String sslCACertLocation)

Set file system directory in which CA certificates are searched

Parameters:

sslCACertLocation - - file system path

getSslChainFile

java.lang.String getSslChainFile()

Returns:

the file containing certificate chain

setSslChainFile

void setSslChainFile(java.lang.String sslChainFile)

Set the file location which contains the SSL certificate chain.

Parameters:

sslChainFile -

getSslPrivateKeyFile

java.lang.String getSslPrivateKeyFile()

Returns:

the file containing the SSL private key

setSslPrivateKeyFile

void setSslPrivateKeyFile(java.lang.String sslPrivateKeyFile)

Parameters:

sslPrivateKeyFile - - the file containing the SSL private key

getSslPrivateKeyPassword

java.lang.String getSslPrivateKeyPassword()

Returns:

- the password used to access the private key.

setSslPrivateKeyPassword

void setSslPrivateKeyPassword(java.lang.String sslPrivateKeyPassword)

Set the password used to access the private key.

getSslCertForm

java.lang.String getSslCertForm()

Returns:

the format in which the certificate is stored in.

setSslCertForm

void setSslCertForm(java.lang.String sslCertForm)

Set the format the SSL certificate is stored in ( e.g. PKCS7 )

Parameters:

sslCertForm - - the format the certificate is stored in. One of:

• 'LIST'
• 'PKCS7'
• 'PKCS12'

getSslCipherSuite

java.lang.String getSslCipherSuite()

Returns:

the configured set (, separated list) of allowed cipher suites for this connection

setSslCipherSuite

void setSslCipherSuite(java.lang.String sslCipherSuite)

Set the set of allowed cipher suites for this connection.

Parameters:

sslCipherSuite - - a , separated list of cipher suite names.

getSslProviderClassName

java.lang.String getSslProviderClassName()

Returns:

- the currently configured SSL provide name

setSslProviderClassName

void setSslProviderClassName(java.lang.String sslProviderClassName)

Set the currently configured SSL provide name

Parameters:

sslProviderClassName - one of:

• 'progress.message.net.ssl.jsse.jsseSSLImpl' - Java JSSE SSL implementation
• 'progress.message.net.ssl.jsafe.jsafeSSLImpl' - RSA Jsafe SSL implementation (Use only if you also have licensed the RSA jars)

isEnableCompression

boolean isEnableCompression()

Returns:

if compression is enabled on the connection.

setEnableCompression

void setEnableCompression(boolean enableCompression)

Parameters:

enableCompression - enable or disable compression on the connection.

getCompressionFactory

java.lang.String getCompressionFactory()

Returns:

the optional custom compression factory classname.

setCompressionFactory

void setCompressionFactory(java.lang.String compressionFactory)

Parameters:

compressionFactory - set the optional custom compression factory classname.

setSocketConnectTimeout

void setSocketConnectTimeout(int socketConnectTimeout)

Set the socket connect timeout.

Parameters:

socketConnectTimeout - value in milliseconds, 0 means infinite

getSocketConnectTimeout

int getSocketConnectTimeout()

Returns:

the socket connect timeout in milliseconds

setMonitorInterval

void setMonitorInterval(int monitorInterval)

Sets the interval in seconds over which administrative monitoring of flow control will occur.

Parameters:

monitorInterval - the interval

getMonitorInterval

int getMonitorInterval()

Gets the interval in seconds over which administrative monitoring of flow control will occur.

Returns:

the interval