java.lang.Object
- org.objectweb.joram.mom.dest.jms.JMSModule

All Implemented Interfaces:: jakarta.jms.ExceptionListener, Serializable, JMSModuleMBean

public class JMSModule
extends Object
implements jakarta.jms.ExceptionListener, Serializable, JMSModuleMBean

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected class`	`JMSModule.ReconnectionDaemon`	The `ReconnectionDaemon` thread is responsible for reconnecting the bridge module with the foreign JMS server in case of disconnection.
`protected class`	`JMSModule.StartupDaemon`	The `StartupDaemon` thread is responsible for retrieving the needed JMS administered objects from the JNDI server.

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`clientID`	JMS clientID field.
`protected jakarta.jms.Connection`	`cnx`	Connection to the foreign JMS server.
`protected jakarta.jms.ConnectionFactory`	`cnxFact`	Connection factory object for connecting to the foreign JMS server.
`protected String`	`cnxFactName`	ConnectionFactory JNDI name.
`private Crypto`	`crypto`
`private static String`	`CRYPTO_ALGO`
`private static String`	`CRYPTO_ALGO_PROPERTY`
`private static String`	`CRYPTO_DFLT_ALGO`
`private static int`	`CRYPTO_DFLT_ITERATION_COUNT`
`private static int`	`CRYPTO_DFLT_KEY_LENGTH`
`private static String`	`CRYPTO_DFLT_NONCE`
`private static String`	`CRYPTO_DFLT_PASSWORD`
`private static String`	`CRYPTO_DFLT_SALT`
`private static int`	`CRYPTO_ITERATION_COUNT`
`private static String`	`CRYPTO_ITERATION_COUNT_PROPERTY`
`private static int`	`CRYPTO_KEY_LENGTH`
`private static String`	`CRYPTO_KEY_LENGTH_PROPERTY`
`private static String`	`CRYPTO_NONCE`
`private static String`	`CRYPTO_NONCE_PROPERTY`
`private static String`	`CRYPTO_PASSWORD`
`private static int`	`CRYPTO_PASSWORD_MIN_LENGTH`
`private static String`	`CRYPTO_PASSWORD_PROPERTY`
`private static String`	`CRYPTO_SALT`
`private static int`	`CRYPTO_SALT_MIN_LENGTH`
`private static String`	`CRYPTO_SALT_PROPERTY`
`private static boolean`	`DEBUG`
`private static boolean`	`ENCRYPT_CONFIGURATION`
`private static String`	`ENCRYPT_CONFIGURATION_PROPERTY`
`static int`	`FAILING`
`protected String`	`jndiFactory`	Name of the JNDI factory class to use.
`protected String`	`jndiUrl`	JNDI URL.
`private List<JMSAcquisition.JmsListener>`	`listeners`
`private static Logger`	`logger`
`private String`	`name`	the name identifying the remote JMS provider
`protected boolean`	`notUsable`	`true` if the module is fully usable.
`protected String`	`notUsableMessage`	Message explaining why the module is not usable.
`static int`	`OK`
`protected String`	`password`	User password for connecting to the foreign JMS server.
`private String`	`password2`	Contains decrypted value of password field, this field is lazily initialized.
`protected JMSModule.ReconnectionDaemon`	`reconnectionDaemon`	Daemon used for the reconnection process.
`private static long`	`serialVersionUID`	define serialVersionUID for interoperability, fix with 5.15.0 value.
`static int`	`STARTING`
`private int`	`status`
`static int`	`UNKNOWN`
`protected String`	`userName`	User identification for connecting to the foreign JMS server.

Constructor Summary

Constructors
Constructor	Description
`JMSModule(String name, String cnxFactoryName, String jndiFactoryClass, String jndiUrl, String user, String password, String clientID)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`addExceptionListener(JMSAcquisition.JmsListener listener)`
`private String`	`decrypt(String cypherText, String nonce)`
`protected void`	`doConnect()`	Opens a connection with the foreign JMS server and creates the JMS resources for interacting with the foreign JMS destination.
`private String`	`encrypt(String clearText, String nonce)`
`String`	`getClientID()`	JMS clientID field.
`jakarta.jms.Connection`	`getCnx()`
`String`	`getCnxFactName()`	ConnectionFactory JNDI name.
`private Crypto`	`getCrypto()`
`protected Context`	`getInitialContext()`
`private String`	`getMBeanName()`
`String`	`getName()`
`String`	`getNamingFactory()`	Name of the JNDI factory class to use.
`String`	`getNamingURL()`	JNDI URL.
`String`	`getState()`
`int`	`getStatus()`
`String`	`getUserName()`
`boolean`	`isConnectionOpen()`
`void`	`onException(jakarta.jms.JMSException exc)`	Implements the `javax.jms.ExceptionListener` interface for catching the failures of the connection to the remote JMS server.
`(package private) void`	`removeExceptionListener(JMSAcquisition.JmsListener listener)`
`protected Object`	`retrieveJndiObject(String jndiName)`	Retrieves ConnectionFactory and Destination objects from JNDI.
`void`	`startLiveConnection()`	Launches the connection process to the foreign JMS server.
`void`	`stopLiveConnection()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    define serialVersionUID for interoperability, fix with 5.15.0 value. This value is identical in 5.15.0, 5.16.0, 5.16.3, 5.17 and next. It is different in 5.16.1 and 5.16.2 (and 5.17.0RC).
    
    See Also:
    
    Constant Field Values
  - logger
```
private static final Logger logger
```
  - DEBUG
```
private static final boolean DEBUG
```
  - ENCRYPT_CONFIGURATION_PROPERTY
```
private static final String ENCRYPT_CONFIGURATION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ENCRYPT_CONFIGURATION
```
private static final boolean ENCRYPT_CONFIGURATION
```
  - CRYPTO_ALGO_PROPERTY
```
private static final String CRYPTO_ALGO_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CRYPTO_DFLT_ALGO
```
private static final String CRYPTO_DFLT_ALGO
```
    See Also:
    
    Constant Field Values
  - CRYPTO_ALGO
```
private static final String CRYPTO_ALGO
```
  - CRYPTO_PASSWORD_PROPERTY
```
private static final String CRYPTO_PASSWORD_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CRYPTO_DFLT_PASSWORD
```
private static final String CRYPTO_DFLT_PASSWORD
```
    See Also:
    
    Constant Field Values
  - CRYPTO_PASSWORD
```
private static final String CRYPTO_PASSWORD
```
  - CRYPTO_PASSWORD_MIN_LENGTH
```
private static final int CRYPTO_PASSWORD_MIN_LENGTH
```
    See Also:
    
    Constant Field Values
  - CRYPTO_SALT_PROPERTY
```
private static final String CRYPTO_SALT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CRYPTO_DFLT_SALT
```
private static final String CRYPTO_DFLT_SALT
```
    See Also:
    
    Constant Field Values
  - CRYPTO_SALT
```
private static final String CRYPTO_SALT
```
  - CRYPTO_SALT_MIN_LENGTH
```
private static final int CRYPTO_SALT_MIN_LENGTH
```
    See Also:
    
    Constant Field Values
  - CRYPTO_NONCE_PROPERTY
```
private static final String CRYPTO_NONCE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CRYPTO_DFLT_NONCE
```
private static final String CRYPTO_DFLT_NONCE
```
    See Also:
    
    Constant Field Values
  - CRYPTO_NONCE
```
private static final String CRYPTO_NONCE
```
  - CRYPTO_ITERATION_COUNT_PROPERTY
```
private static final String CRYPTO_ITERATION_COUNT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CRYPTO_DFLT_ITERATION_COUNT
```
private static final int CRYPTO_DFLT_ITERATION_COUNT
```
    See Also:
    
    Constant Field Values
  - CRYPTO_ITERATION_COUNT
```
private static final int CRYPTO_ITERATION_COUNT
```
  - CRYPTO_KEY_LENGTH_PROPERTY
```
private static final String CRYPTO_KEY_LENGTH_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CRYPTO_DFLT_KEY_LENGTH
```
private static final int CRYPTO_DFLT_KEY_LENGTH
```
    See Also:
    
    Constant Field Values
  - CRYPTO_KEY_LENGTH
```
private static final int CRYPTO_KEY_LENGTH
```
  - notUsable
```
protected transient boolean notUsable
```
    true if the module is fully usable.
  - notUsableMessage
```
protected transient String notUsableMessage
```
    Message explaining why the module is not usable.
  - reconnectionDaemon
```
protected transient JMSModule.ReconnectionDaemon reconnectionDaemon
```
    Daemon used for the reconnection process.
  - cnx
```
protected transient volatile jakarta.jms.Connection cnx
```
    Connection to the foreign JMS server.
  - name
```
private String name
```
    the name identifying the remote JMS provider
  - userName
```
protected String userName
```
    User identification for connecting to the foreign JMS server.
  - password
```
protected String password
```
    User password for connecting to the foreign JMS server. This field may be encrypted if JMSConnections.ENCRYPT_CONFIGURATION_PROPERTY is defined to true.
  - password2
```
private transient String password2
```
    Contains decrypted value of password field, this field is lazily initialized. Note (AF): Only used if ENCRYPT_CONFIGURATION is true.
  - crypto
```
private transient Crypto crypto
```
  - jndiFactory
```
protected String jndiFactory
```
    Name of the JNDI factory class to use.
  - jndiUrl
```
protected String jndiUrl
```
    JNDI URL.
  - cnxFactName
```
protected String cnxFactName
```
    ConnectionFactory JNDI name.
  - clientID
```
protected String clientID
```
    JMS clientID field.
  - cnxFact
```
protected transient jakarta.jms.ConnectionFactory cnxFact
```
    Connection factory object for connecting to the foreign JMS server.
  - status
```
private int status
```
  - UNKNOWN
```
public static final int UNKNOWN
```
    See Also:
    
    Constant Field Values
  - STARTING
```
public static final int STARTING
```
    See Also:
    
    Constant Field Values
  - OK
```
public static final int OK
```
    See Also:
    
    Constant Field Values
  - FAILING
```
public static final int FAILING
```
    See Also:
    
    Constant Field Values
  - listeners
```
private transient List<JMSAcquisition.JmsListener> listeners
```
- Constructor Detail
  - JMSModule
```
public JMSModule(String name,
                 String cnxFactoryName,
                 String jndiFactoryClass,
                 String jndiUrl,
                 String user,
                 String password,
                 String clientID)
```
- Method Detail
  - getCnx
```
public jakarta.jms.Connection getCnx()
```
    Returns:
    
    the cnx
  - getName
```
public String getName()
```
  - getUserName
```
public String getUserName()
```
    Specified by:
    
    getUserName in interface JMSModuleMBean
    
    Returns:
    
    the user name
  - getCrypto
```
private Crypto getCrypto()
```
  - encrypt
```
private String encrypt(String clearText,
                       String nonce)
                throws UnsupportedEncodingException,
                       GeneralSecurityException
```
    Throws:
    
    UnsupportedEncodingException
    
    GeneralSecurityException
  - decrypt
```
private String decrypt(String cypherText,
                       String nonce)
                throws UnsupportedEncodingException,
                       GeneralSecurityException
```
    Throws:
    
    UnsupportedEncodingException
    
    GeneralSecurityException
  - getNamingFactory
```
public String getNamingFactory()
```
    Description copied from interface: JMSModuleMBean
    
    Name of the JNDI factory class to use.
    
    Specified by:
    
    getNamingFactory in interface JMSModuleMBean
  - getNamingURL
```
public String getNamingURL()
```
    Description copied from interface: JMSModuleMBean
    
    JNDI URL.
    
    Specified by:
    
    getNamingURL in interface JMSModuleMBean
  - getCnxFactName
```
public String getCnxFactName()
```
    Description copied from interface: JMSModuleMBean
    
    ConnectionFactory JNDI name.
    
    Specified by:
    
    getCnxFactName in interface JMSModuleMBean
    
    Returns:
    
    the cnxFactName
  - getClientID
```
public String getClientID()
```
    Description copied from interface: JMSModuleMBean
    
    JMS clientID field.
    
    Specified by:
    
    getClientID in interface JMSModuleMBean
  - stopLiveConnection
```
public void stopLiveConnection()
```
  - startLiveConnection
```
public void startLiveConnection()
```
    Launches the connection process to the foreign JMS server.
    
    Throws:
    
    IllegalStateException - If the module can't access the foreign JMS server.
    
    JMSException - If the needed JMS resources can't be created.
  - retrieveJndiObject
```
protected Object retrieveJndiObject(String jndiName)
                             throws Exception
```
    Retrieves ConnectionFactory and Destination objects from JNDI. This method converts 'old' javax.jms references to the new Jakarta JMS API. TODO (AF): We should replace this code by a call to Helper.retrieveJakartaJMSObjectFromJNDI method (org.ow2.joram.jndi package).
    
    Parameters:
    
    jndiName -
    
    Returns:
    
    Throws:
    
    Exception
  - getInitialContext
```
protected Context getInitialContext()
                             throws IOException,
                                    NamingException
```
    Throws:
    
    IOException
    
    NamingException
  - doConnect
```
protected void doConnect()
                  throws jakarta.jms.JMSException
```
    Opens a connection with the foreign JMS server and creates the JMS resources for interacting with the foreign JMS destination.
    
    Throws:
    
    jakarta.jms.JMSException - If the needed JMS resources could not be created.
  - onException
```
public void onException(jakarta.jms.JMSException exc)
```
    Implements the javax.jms.ExceptionListener interface for catching the failures of the connection to the remote JMS server.
    Reacts by launching a reconnection process.
    
    Specified by:
    
    onException in interface jakarta.jms.ExceptionListener
  - isConnectionOpen
```
public boolean isConnectionOpen()
```
  - getStatus
```
public int getStatus()
```
  - getState
```
public String getState()
```
    Specified by:
    
    getState in interface JMSModuleMBean
  - getMBeanName
```
private String getMBeanName()
```
  - removeExceptionListener
```
void removeExceptionListener(JMSAcquisition.JmsListener listener)
```
  - addExceptionListener
```
void addExceptionListener(JMSAcquisition.JmsListener listener)
```

Class JMSModule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

logger

DEBUG

ENCRYPT_CONFIGURATION_PROPERTY

ENCRYPT_CONFIGURATION

CRYPTO_ALGO_PROPERTY

CRYPTO_DFLT_ALGO

CRYPTO_ALGO

CRYPTO_PASSWORD_PROPERTY

CRYPTO_DFLT_PASSWORD

CRYPTO_PASSWORD

CRYPTO_PASSWORD_MIN_LENGTH

CRYPTO_SALT_PROPERTY

CRYPTO_DFLT_SALT

CRYPTO_SALT

CRYPTO_SALT_MIN_LENGTH

CRYPTO_NONCE_PROPERTY

CRYPTO_DFLT_NONCE

CRYPTO_NONCE

CRYPTO_ITERATION_COUNT_PROPERTY

CRYPTO_DFLT_ITERATION_COUNT

CRYPTO_ITERATION_COUNT

CRYPTO_KEY_LENGTH_PROPERTY

CRYPTO_DFLT_KEY_LENGTH

CRYPTO_KEY_LENGTH

notUsable

notUsableMessage

reconnectionDaemon

cnx

name

userName

password

password2

crypto

jndiFactory

jndiUrl

cnxFactName

clientID

cnxFact

status

UNKNOWN

STARTING

OK

FAILING

listeners

Constructor Detail

JMSModule

Method Detail

getCnx

getName

getUserName

getCrypto

encrypt

decrypt

getNamingFactory

getNamingURL

getCnxFactName

getClientID

stopLiveConnection

startLiveConnection

retrieveJndiObject

getInitialContext

doConnect

onException

isConnectionOpen

getStatus

getState

getMBeanName

removeExceptionListener

addExceptionListener