com.adaptris.core.wmq

Class NativeConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.AllowsRetriesConnection

com.adaptris.core.wmq.NativeConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, LicensedComponent, StateManagedComponent

Direct Known Subclasses:

AttachedConnection, DetachedConnection

public abstract class NativeConnection
extends AllowsRetriesConnection
implements LicensedComponent

Abstract Connection implementation that uses the native WebsphereMQ client.

Requires an Enterprise license

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor and Description
NativeConnection()

Method Summary

Modifier and Type	Method and Description
protected void	closeConnection()
KeyValuePairSet	getEnvironmentProperties()
java.lang.String	getQueueManager()
boolean	getRedirectExceptionLogging()
protected void	initConnection()
boolean	isEnabled(License license)
protected void	prepareConnection()
void	setEnvironmentProperties(KeyValuePairSet kvps) Set any additional properties that should be passed in as part of the constructor to MQQueueManager.
void	setQueueManager(java.lang.String s) Set the Queue manager associated with this connection.
void	setRedirectExceptionLogging(boolean b) Redirect logging done by MQException.

Methods inherited from class com.adaptris.core.AllowsRetriesConnection

connectionAttempts, connectionRetryInterval, createLoggingStatement, getConnectionAttempts, getConnectionRetryInterval, logWarning, setConnectionAttempts, setConnectionRetryInterval

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getLookupName, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setLookupName, setUniqueId, setWorkersFirstOnShutdown, start, startConnection, stop, stopConnection, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeConnection

public NativeConnection()

Method Detail

initConnection

protected void initConnection()
                       throws CoreException

Specified by:

initConnection in class AdaptrisConnectionImp

Throws:

CoreException

See Also:

AdaptrisConnectionImp.initConnection()

prepareConnection

protected void prepareConnection()
                          throws CoreException

Specified by:

prepareConnection in class AdaptrisConnectionImp

Throws:

CoreException

isEnabled

public boolean isEnabled(License license)

Specified by:

isEnabled in interface LicensedComponent

getQueueManager

public java.lang.String getQueueManager()

Returns:

the queueManager

setQueueManager

public void setQueueManager(java.lang.String s)

Set the Queue manager associated with this connection.

Parameters:

s - the queueManager to set

getEnvironmentProperties

public KeyValuePairSet getEnvironmentProperties()

Returns:

the environmentProperties

setEnvironmentProperties

public void setEnvironmentProperties(KeyValuePairSet kvps)

Set any additional properties that should be passed in as part of the constructor to MQQueueManager.

The properties specified within the KeyValuePairSet will override the default MQEnvironment properties. Complex properties such as Collections and byte[] are not supported.

These options are directly copied from the WebsphereMQ client API documentation. The literal values associated with each java constant should be used where appropriate. e.g. rather than using "MQC.CHANNEL_PROPERTY" as one of the keys you would use "channel" as that is the literal value the constant represents. Any options that aren't recognised by WebsphereMQ will be ignored.

Possible values from the WebsphereMQ 6 documentation are:

• MQC.CCSID_PROPERTY overrides CCSID
• MQC.CHANNEL_PROPERTY overrides channel
• MQC.CONNECT_OPTIONS_PROPERTY overrides connOptions
• MQC.HOST_NAME_PROPERTY overrides hostname
• MQC.LOCAL_ADDRESS_PROPERTY overrides localAddressSetting
• MQC.PASSWORD_PROPERTY overrides password
• MQC.PORT_PROPERTY overrides port
• MQC.SSL_CERT_STORE_PROPERTY overrides sslCertStores
• MQC.SSL_CIPHER_SUITE_PROPERTY overrides sslCipherSuite
• MQC.SSL_FIPS_REQUIRED overrides sslFipsRequired
• MQC.SSL_RESET_COUNT_PROPERTY . overrides sslResetCount
• MQC.SSL_PEER_NAME_PROPERTY . overrides sslPeerName
• MQC.SSL_SOCKET_FACTORY_PROPERTY overrides sslSocketFactory
• MQC.TRANSPORT_PROPERTY forces MQC.TRANSPORT_MQSERIES_BINDINGS or MQC.TRANSPORT_MQSERIES_CLIENT
• MQC.USER_ID_PROPERTY overrides userID

Parameters:

kvps - the environmentProperties to set

See Also:

MQEnvironment.properties, MQQueueManager.MQQueueManager(String, java.util.Hashtable)

getRedirectExceptionLogging

public boolean getRedirectExceptionLogging()

Returns:

the redirectExceptionLogging

setRedirectExceptionLogging

public void setRedirectExceptionLogging(boolean b)

Redirect logging done by MQException.

MQException exposes a static field log which receives additional logging when an Exception is raised. Set this to be true so that this logging is redirected to the Adapter logging framework rather than stderr.

The logging category will be this class with a level of ERROR.

Parameters:

b - the redirectExceptionLogging to set

closeConnection

protected void closeConnection()

Specified by:

closeConnection in class AdaptrisConnectionImp