JMSConnector (Apache Axis)

java.lang.Object
- org.apache.axis.transport.jms.JMSConnector

Direct Known Subclasses:

QueueConnector, TopicConnector
```
public abstract class JMSConnector
extends Object
```
JMSConnector is an abstract class that encapsulates the work of connecting to JMS destinations. Its subclasses are TopicConnector and QueueConnector which further specialize connections to the pub-sub and the ptp domains. It also implements the capability to retry connections in the event of failures.

Author:

Jaime Meritt (jmeritt@sonicsoftware.com), Richard Chung (rchung@sonicsoftware.com), Dave Chappell (chappell@sonicsoftware.com), Ray Chun (rchun@sonicsoftware.com)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class JMSConnector.AsyncConnection

protected class JMSConnector.SyncConnection

Nested Classes
Modifier and Type	Class and Description
`protected class`	`JMSConnector.AsyncConnection`
`protected class`	`JMSConnector.SyncConnection`

Field Summary

Fields
Modifier and Type	Field and Description
`protected JMSVendorAdapter`	`m_adapter`
`protected boolean`	`m_allowReceive`
`protected long`	`m_connectRetryInterval`
`protected long`	`m_interactRetryInterval`
`protected JMSURLHelper`	`m_jmsurl`
`protected int`	`m_numRetries`
`protected int`	`m_numSessions`
`protected long`	`m_poolTimeout`
`protected JMSConnector.AsyncConnection`	`m_receiveConnection`
`protected JMSConnector.SyncConnection`	`m_sendConnection`
`protected long`	`m_timeoutTime`

Constructor Summary

Constructors
Constructor and Description
`JMSConnector(ConnectionFactory connectionFactory, int numRetries, int numSessions, long connectRetryInterval, long interactRetryInterval, long timeoutTime, boolean allowReceive, String clientID, String username, String password, JMSVendorAdapter adapter, JMSURLHelper jmsurl)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract JMSConnector.AsyncConnection`	`createAsyncConnection(ConnectionFactory factory, Connection connection, String threadName, String clientID, String username, String password)`
`protected Connection`	`createConnectionWithRetry(ConnectionFactory connectionFactory, String username, String password)`
`abstract JMSEndpoint`	`createEndpoint(Destination destination)`
`abstract JMSEndpoint`	`createEndpoint(String destinationName)`
`protected abstract JMSConnector.SyncConnection`	`createSyncConnection(ConnectionFactory factory, Connection connection, int numSessions, String threadName, String clientID, String username, String password)`
`String`	`getClientID()`
`ConnectionFactory`	`getConnectionFactory()`
`JMSURLHelper`	`getJMSURL()`
`int`	`getNumRetries()`
`String`	`getPassword()`
`String`	`getUsername()`
`JMSVendorAdapter`	`getVendorAdapter()`
`protected abstract Connection`	`internalConnect(ConnectionFactory connectionFactory, String username, String password)`
`int`	`numSessions()`
`void`	`shutdown()`
`void`	`start()`
`void`	`stop()`

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

Field Detail

m_numRetries
```
protected int m_numRetries
```

m_connectRetryInterval
```
protected long m_connectRetryInterval
```

m_interactRetryInterval
```
protected long m_interactRetryInterval
```

m_timeoutTime
```
protected long m_timeoutTime
```

m_poolTimeout
```
protected long m_poolTimeout
```

m_receiveConnection

protected JMSConnector.AsyncConnection m_receiveConnection

m_sendConnection

protected JMSConnector.SyncConnection m_sendConnection

m_numSessions
```
protected int m_numSessions
```

m_allowReceive
```
protected boolean m_allowReceive
```

m_adapter
```
protected JMSVendorAdapter m_adapter
```

m_jmsurl
```
protected JMSURLHelper m_jmsurl
```

Constructor Detail

JMSConnector

public JMSConnector(ConnectionFactory connectionFactory,
            int numRetries,
            int numSessions,
            long connectRetryInterval,
            long interactRetryInterval,
            long timeoutTime,
            boolean allowReceive,
            String clientID,
            String username,
            String password,
            JMSVendorAdapter adapter,
            JMSURLHelper jmsurl)
             throws JMSException

Throws:: JMSException

Method Detail

getNumRetries
```
public int getNumRetries()
```

numSessions
```
public int numSessions()
```

getConnectionFactory

public ConnectionFactory getConnectionFactory()

getClientID
```
public String getClientID()
```

getUsername
```
public String getUsername()
```

getPassword
```
public String getPassword()
```

getVendorAdapter

public JMSVendorAdapter getVendorAdapter()

getJMSURL
```
public JMSURLHelper getJMSURL()
```

createConnectionWithRetry

protected Connection createConnectionWithRetry(ConnectionFactory connectionFactory,
                                   String username,
                                   String password)
                                        throws JMSException

Throws:: JMSException

stop
```
public void stop()
```

start
```
public void start()
```

shutdown
```
public void shutdown()
```

createEndpoint

public abstract JMSEndpoint createEndpoint(String destinationName)
                                    throws JMSException

Throws:: JMSException

createEndpoint

public abstract JMSEndpoint createEndpoint(Destination destination)
                                    throws JMSException

Throws:: JMSException

internalConnect

protected abstract Connection internalConnect(ConnectionFactory connectionFactory,
                         String username,
                         String password)
                                       throws JMSException

Throws:: JMSException

createSyncConnection

protected abstract JMSConnector.SyncConnection createSyncConnection(ConnectionFactory factory,
                                               Connection connection,
                                               int numSessions,
                                               String threadName,
                                               String clientID,
                                               String username,
                                               String password)
                                                             throws JMSException

Throws:: JMSException

createAsyncConnection

protected abstract JMSConnector.AsyncConnection createAsyncConnection(ConnectionFactory factory,
                                                 Connection connection,
                                                 String threadName,
                                                 String clientID,
                                                 String username,
                                                 String password)
                                                               throws JMSException

Throws:: JMSException

Class JMSConnector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_numRetries

m_connectRetryInterval

m_interactRetryInterval

m_timeoutTime

m_poolTimeout

m_receiveConnection

m_sendConnection

m_numSessions

m_allowReceive

m_adapter

m_jmsurl

Constructor Detail

JMSConnector

Method Detail

getNumRetries

numSessions

getConnectionFactory

getClientID

getUsername

getPassword

getVendorAdapter

getJMSURL

createConnectionWithRetry

stop

start

shutdown

createEndpoint

createEndpoint

internalConnect

createSyncConnection

createAsyncConnection