org.jboss.messaging.ra
Class JBMResourceAdapter

java.lang.Object
  extended by org.jboss.messaging.ra.JBMResourceAdapter
All Implemented Interfaces:
javax.resource.spi.ResourceAdapter

public class JBMResourceAdapter
extends java.lang.Object
implements javax.resource.spi.ResourceAdapter

The resource adapter for JBoss Messaging

Version:
$Revision: $
Author:
Adrian Brock, Jesper Pedersen, Andy Taylor

Constructor Summary
JBMResourceAdapter()
          Constructor
 
Method Summary
 JBossConnectionFactory createDiscoveryFactory(java.lang.String discoveryGroup, java.lang.Integer discoveryGroupPort)
           
 JBossConnectionFactory createRemoteFactory(java.lang.String connectorClassName, java.util.Map<java.lang.String,java.lang.Object> connectionParameters)
           
 ClientSession createSession(ClientSessionFactory parameterFactory, int ackMode, java.lang.String user, java.lang.String pass, java.lang.Boolean preAck, java.lang.Integer dupsOkBatchSize, java.lang.Integer transactionBatchSize, boolean deliveryTransacted)
           
 ClientSession createSession(int ackMode, java.lang.String user, java.lang.String pass, java.lang.Boolean preAck, java.lang.Integer dupsOkBatchSize, java.lang.Integer transactionBatchSize, boolean deliveryTransacted)
           
 void endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory, javax.resource.spi.ActivationSpec spec)
          Endpoint activation
 void endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory, javax.resource.spi.ActivationSpec spec)
          Endpoint deactivation
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 java.lang.Boolean getAutoGroup()
          Get auto group
 java.util.Map<java.lang.String,java.lang.Object> getBackupConnectionParameters()
           
 java.lang.String getBackupConnectorClassName()
           
 java.lang.Boolean getBlockOnAcknowledge()
          Get block on acknowledge
 java.lang.Boolean getBlockOnNonPersistentSend()
          Get block on non persistent send
 java.lang.Boolean getBlockOnPersistentSend()
          Get block on persistent send
 java.lang.Long getCallTimeout()
          Get call timeout
 java.lang.Long getClientFailureCheckPeriod()
          Get client failure check period
 java.lang.String getClientID()
          Get the client ID
 java.util.Map<java.lang.String,java.lang.Object> getConnectionParameters()
           
 java.lang.Long getConnectionTTL()
          Get connection TTL
 java.lang.String getConnectorClassName()
           
 java.lang.Integer getConsumerMaxRate()
          Get consumer max rate
 java.lang.Integer getConsumerWindowSize()
          Get consumer window size
 java.lang.String getDiscoveryGroupAddress()
          Get the discovery group name
 java.lang.Integer getDiscoveryGroupPort()
          Get the discovery group port
 java.lang.Long getDiscoveryInitialWaitTimeout()
          Get discovery initial wait timeout
 java.lang.Long getDiscoveryRefreshTimeout()
          Get discovery refresh timeout
 java.lang.Integer getDupsOKBatchSize()
          Get dups ok batch size
 java.lang.Boolean getFailoverOnServerShutdown()
          Get failover on server shutdown
 JBossConnectionFactory getJBossConnectionFactory()
           
 java.lang.String getLoadBalancingPolicyClassName()
          Get load balancing policy class name
 java.lang.Integer getMaxConnections()
          Get max connections
 java.lang.Integer getMinLargeMessageSize()
          Get min large message size
 java.lang.String getPassword()
          Get the password
 java.lang.Boolean getPreAcknowledge()
          Get pre acknowledge
 java.lang.Integer getProducerMaxRate()
          Get producer max rate
 java.lang.Integer getProducerWindowSize()
          Get producer window size
protected  JBMRAProperties getProperties()
          Get the resource adapter properties
 java.lang.Integer getReconnectAttempts()
          Get number of reconnect attempts
 java.lang.Long getRetryInterval()
          Get retry interval
 java.lang.Double getRetryIntervalMultiplier()
          Get retry interval multiplier
 java.lang.Integer getTransactionBatchSize()
          Get transaction batch size
 java.lang.String getUserName()
          Get the user name
 java.lang.Boolean getUseXA()
          Get the use XA flag
 javax.resource.spi.work.WorkManager getWorkManager()
          Get the work manager
 javax.transaction.xa.XAResource[] getXAResources(javax.resource.spi.ActivationSpec[] specs)
          Get XA resources
 int hashCode()
          Return the hash code for the object
 java.lang.Boolean isFailoverOnServerShutdown()
          Get failover on server shutdown
 void setAutoGroup(java.lang.Boolean autoGroup)
          Set auto group
 void setBackupConnectorClassName(java.lang.String backupConnector)
           
 void setBackupTransportConfiguration(java.lang.String config)
           
 void setBlockOnAcknowledge(java.lang.Boolean blockOnAcknowledge)
          Set block on acknowledge
 void setBlockOnNonPersistentSend(java.lang.Boolean blockOnNonPersistentSend)
          Set block on non persistent send
 void setBlockOnPersistentSend(java.lang.Boolean blockOnPersistentSend)
          Set block on persistent send
 void setCallTimeout(java.lang.Long callTimeout)
          Set call timeout
 void setClientFailureCheckPeriod(java.lang.Long clientFailureCheckPeriod)
          Set client failure check period
 void setClientID(java.lang.String clientID)
          Set the client ID
 void setConnectionParameters(java.lang.String config)
           
 void setConnectionTTL(java.lang.Long connectionTTL)
          Set connection TTL
 void setConnectorClassName(java.lang.String connectorClassName)
           
 void setConsumerMaxRate(java.lang.Integer consumerMaxRate)
          Set consumer max rate
 void setConsumerWindowSize(java.lang.Integer consumerWindowSize)
          Set consumer window size
 void setDiscoveryGroupAddress(java.lang.String dgn)
          Set the discovery group name
 void setDiscoveryGroupPort(java.lang.Integer dgp)
          Set the discovery group port
 void setDiscoveryInitialWaitTimeout(java.lang.Long discoveryInitialWaitTimeout)
          Set discovery initial wait timeout
 void setDiscoveryRefreshTimeout(java.lang.Long discoveryRefreshTimeout)
          Set discovery refresh timeout
 void setDupsOKBatchSize(java.lang.Integer dupsOKBatchSize)
          Set dups ok batch size
 void setFailoverOnServerShutdown(java.lang.Boolean failoverOnServerShutdown)
          Set failover on server shutdown
 void setLoadBalancingPolicyClassName(java.lang.String loadBalancingPolicyClassName)
          Set load balancing policy class name
 void setMaxConnections(java.lang.Integer maxConnections)
          Set max connections
 void setMinLargeMessageSize(java.lang.Integer minLargeMessageSize)
          Set min large message size
 void setPassword(java.lang.String password)
          Set the password
 void setPreAcknowledge(java.lang.Boolean preAcknowledge)
          Set pre acknowledge
 void setProducerMaxRate(java.lang.Integer producerMaxRate)
          Set producer max rate
 void setProducerWindowSize(java.lang.Integer producerWindowSize)
          Set producer window size
 void setReconnectAttempts(java.lang.Integer reconnectAttempts)
          Set number of reconnect attempts
 void setRetryInterval(java.lang.Long retryInterval)
          Set retry interval
 void setRetryIntervalMultiplier(java.lang.Double retryIntervalMultiplier)
          Set retry interval multiplier
 void setTransactionBatchSize(java.lang.Integer transactionBatchSize)
          Set transaction batch size
protected  void setup()
          Setup the factory
 void setUserName(java.lang.String userName)
          Set the user name
 void setUseXA(java.lang.Boolean xa)
          Set the use XA flag
 void start(javax.resource.spi.BootstrapContext ctx)
          Start
 void stop()
          Stop
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JBMResourceAdapter

public JBMResourceAdapter()
Constructor

Method Detail

endpointActivation

public void endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory,
                               javax.resource.spi.ActivationSpec spec)
                        throws javax.resource.ResourceException
Endpoint activation

Specified by:
endpointActivation in interface javax.resource.spi.ResourceAdapter
Parameters:
endpointFactory - The endpoint factory
spec - The activation spec
Throws:
javax.resource.ResourceException - Thrown if an error occurs

endpointDeactivation

public void endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory endpointFactory,
                                 javax.resource.spi.ActivationSpec spec)
Endpoint deactivation

Specified by:
endpointDeactivation in interface javax.resource.spi.ResourceAdapter
Parameters:
endpointFactory - The endpoint factory
spec - The activation spec

getXAResources

public javax.transaction.xa.XAResource[] getXAResources(javax.resource.spi.ActivationSpec[] specs)
                                                 throws javax.resource.ResourceException
Get XA resources

Specified by:
getXAResources in interface javax.resource.spi.ResourceAdapter
Parameters:
specs - The activation specs
Returns:
The XA resources
Throws:
javax.resource.ResourceException - Thrown if an error occurs or unsupported

start

public void start(javax.resource.spi.BootstrapContext ctx)
           throws javax.resource.spi.ResourceAdapterInternalException
Start

Specified by:
start in interface javax.resource.spi.ResourceAdapter
Parameters:
ctx - The bootstrap context
Throws:
javax.resource.spi.ResourceAdapterInternalException - Thrown if an error occurs

stop

public void stop()
Stop

Specified by:
stop in interface javax.resource.spi.ResourceAdapter

setConnectorClassName

public void setConnectorClassName(java.lang.String connectorClassName)

getConnectorClassName

public java.lang.String getConnectorClassName()

getConnectionParameters

public java.util.Map<java.lang.String,java.lang.Object> getConnectionParameters()

setConnectionParameters

public void setConnectionParameters(java.lang.String config)

getBackupConnectorClassName

public java.lang.String getBackupConnectorClassName()

setBackupConnectorClassName

public void setBackupConnectorClassName(java.lang.String backupConnector)

getBackupConnectionParameters

public java.util.Map<java.lang.String,java.lang.Object> getBackupConnectionParameters()

setBackupTransportConfiguration

public void setBackupTransportConfiguration(java.lang.String config)

getDiscoveryGroupAddress

public java.lang.String getDiscoveryGroupAddress()
Get the discovery group name

Returns:
The value

setDiscoveryGroupAddress

public void setDiscoveryGroupAddress(java.lang.String dgn)
Set the discovery group name

Parameters:
dgn - The value

getDiscoveryGroupPort

public java.lang.Integer getDiscoveryGroupPort()
Get the discovery group port

Returns:
The value

setDiscoveryGroupPort

public void setDiscoveryGroupPort(java.lang.Integer dgp)
Set the discovery group port

Parameters:
dgp - The value

getDiscoveryRefreshTimeout

public java.lang.Long getDiscoveryRefreshTimeout()
Get discovery refresh timeout

Returns:
The value

setDiscoveryRefreshTimeout

public void setDiscoveryRefreshTimeout(java.lang.Long discoveryRefreshTimeout)
Set discovery refresh timeout

Parameters:
discoveryRefreshTimeout - The value

getDiscoveryInitialWaitTimeout

public java.lang.Long getDiscoveryInitialWaitTimeout()
Get discovery initial wait timeout

Returns:
The value

setDiscoveryInitialWaitTimeout

public void setDiscoveryInitialWaitTimeout(java.lang.Long discoveryInitialWaitTimeout)
Set discovery initial wait timeout

Parameters:
discoveryInitialWaitTimeout - The value

getLoadBalancingPolicyClassName

public java.lang.String getLoadBalancingPolicyClassName()
Get load balancing policy class name

Returns:
The value

setLoadBalancingPolicyClassName

public void setLoadBalancingPolicyClassName(java.lang.String loadBalancingPolicyClassName)
Set load balancing policy class name

Parameters:
loadBalancingPolicyClassName - The value

getClientFailureCheckPeriod

public java.lang.Long getClientFailureCheckPeriod()
Get client failure check period

Returns:
The value

setClientFailureCheckPeriod

public void setClientFailureCheckPeriod(java.lang.Long clientFailureCheckPeriod)
Set client failure check period

Parameters:
clientFailureCheckPeriod - The value

getConnectionTTL

public java.lang.Long getConnectionTTL()
Get connection TTL

Returns:
The value

setConnectionTTL

public void setConnectionTTL(java.lang.Long connectionTTL)
Set connection TTL

Parameters:
connectionTTL - The value

getCallTimeout

public java.lang.Long getCallTimeout()
Get call timeout

Returns:
The value

setCallTimeout

public void setCallTimeout(java.lang.Long callTimeout)
Set call timeout

Parameters:
callTimeout - The value

getDupsOKBatchSize

public java.lang.Integer getDupsOKBatchSize()
Get dups ok batch size

Returns:
The value

setDupsOKBatchSize

public void setDupsOKBatchSize(java.lang.Integer dupsOKBatchSize)
Set dups ok batch size

Parameters:
dupsOKBatchSize - The value

getTransactionBatchSize

public java.lang.Integer getTransactionBatchSize()
Get transaction batch size

Returns:
The value

setTransactionBatchSize

public void setTransactionBatchSize(java.lang.Integer transactionBatchSize)
Set transaction batch size

Parameters:
transactionBatchSize - The value

getConsumerWindowSize

public java.lang.Integer getConsumerWindowSize()
Get consumer window size

Returns:
The value

setConsumerWindowSize

public void setConsumerWindowSize(java.lang.Integer consumerWindowSize)
Set consumer window size

Parameters:
consumerWindowSize - The value

getConsumerMaxRate

public java.lang.Integer getConsumerMaxRate()
Get consumer max rate

Returns:
The value

setConsumerMaxRate

public void setConsumerMaxRate(java.lang.Integer consumerMaxRate)
Set consumer max rate

Parameters:
consumerMaxRate - The value

getProducerWindowSize

public java.lang.Integer getProducerWindowSize()
Get producer window size

Returns:
The value

setProducerWindowSize

public void setProducerWindowSize(java.lang.Integer producerWindowSize)
Set producer window size

Parameters:
producerWindowSize - The value

getProducerMaxRate

public java.lang.Integer getProducerMaxRate()
Get producer max rate

Returns:
The value

setProducerMaxRate

public void setProducerMaxRate(java.lang.Integer producerMaxRate)
Set producer max rate

Parameters:
producerMaxRate - The value

getMinLargeMessageSize

public java.lang.Integer getMinLargeMessageSize()
Get min large message size

Returns:
The value

setMinLargeMessageSize

public void setMinLargeMessageSize(java.lang.Integer minLargeMessageSize)
Set min large message size

Parameters:
minLargeMessageSize - The value

getBlockOnAcknowledge

public java.lang.Boolean getBlockOnAcknowledge()
Get block on acknowledge

Returns:
The value

setBlockOnAcknowledge

public void setBlockOnAcknowledge(java.lang.Boolean blockOnAcknowledge)
Set block on acknowledge

Parameters:
blockOnAcknowledge - The value

getBlockOnNonPersistentSend

public java.lang.Boolean getBlockOnNonPersistentSend()
Get block on non persistent send

Returns:
The value

setBlockOnNonPersistentSend

public void setBlockOnNonPersistentSend(java.lang.Boolean blockOnNonPersistentSend)
Set block on non persistent send

Parameters:
blockOnNonPersistentSend - The value

getBlockOnPersistentSend

public java.lang.Boolean getBlockOnPersistentSend()
Get block on persistent send

Returns:
The value

setBlockOnPersistentSend

public void setBlockOnPersistentSend(java.lang.Boolean blockOnPersistentSend)
Set block on persistent send

Parameters:
blockOnPersistentSend - The value

getAutoGroup

public java.lang.Boolean getAutoGroup()
Get auto group

Returns:
The value

setAutoGroup

public void setAutoGroup(java.lang.Boolean autoGroup)
Set auto group

Parameters:
autoGroup - The value

getMaxConnections

public java.lang.Integer getMaxConnections()
Get max connections

Returns:
The value

setMaxConnections

public void setMaxConnections(java.lang.Integer maxConnections)
Set max connections

Parameters:
maxConnections - The value

getPreAcknowledge

public java.lang.Boolean getPreAcknowledge()
Get pre acknowledge

Returns:
The value

setPreAcknowledge

public void setPreAcknowledge(java.lang.Boolean preAcknowledge)
Set pre acknowledge

Parameters:
preAcknowledge - The value

getRetryInterval

public java.lang.Long getRetryInterval()
Get retry interval

Returns:
The value

setRetryInterval

public void setRetryInterval(java.lang.Long retryInterval)
Set retry interval

Parameters:
retryInterval - The value

getRetryIntervalMultiplier

public java.lang.Double getRetryIntervalMultiplier()
Get retry interval multiplier

Returns:
The value

setRetryIntervalMultiplier

public void setRetryIntervalMultiplier(java.lang.Double retryIntervalMultiplier)
Set retry interval multiplier

Parameters:
retryIntervalMultiplier - The value

getReconnectAttempts

public java.lang.Integer getReconnectAttempts()
Get number of reconnect attempts

Returns:
The value

setReconnectAttempts

public void setReconnectAttempts(java.lang.Integer reconnectAttempts)
Set number of reconnect attempts

Parameters:
reconnectAttempts - The value

isFailoverOnServerShutdown

public java.lang.Boolean isFailoverOnServerShutdown()
Get failover on server shutdown

Returns:
The value

getFailoverOnServerShutdown

public java.lang.Boolean getFailoverOnServerShutdown()
Get failover on server shutdown

Returns:
The value

setFailoverOnServerShutdown

public void setFailoverOnServerShutdown(java.lang.Boolean failoverOnServerShutdown)
Set failover on server shutdown

Parameters:
failoverOnServerShutdown - The value

getUserName

public java.lang.String getUserName()
Get the user name

Returns:
The value

setUserName

public void setUserName(java.lang.String userName)
Set the user name

Parameters:
userName - The value

getPassword

public java.lang.String getPassword()
Get the password

Returns:
The value

setPassword

public void setPassword(java.lang.String password)
Set the password

Parameters:
password - The value

getClientID

public java.lang.String getClientID()
Get the client ID

Returns:
The value

setClientID

public void setClientID(java.lang.String clientID)
Set the client ID

Parameters:
clientID - The client id

getUseXA

public java.lang.Boolean getUseXA()
Get the use XA flag

Returns:
The value

setUseXA

public void setUseXA(java.lang.Boolean xa)
Set the use XA flag

Parameters:
xa - The value

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.

Overrides:
equals in class java.lang.Object
Parameters:
obj - Object with which to compare
Returns:
True if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()
Return the hash code for the object

Overrides:
hashCode in class java.lang.Object
Returns:
The hash code

getWorkManager

public javax.resource.spi.work.WorkManager getWorkManager()
Get the work manager

Returns:
The manager

createSession

public ClientSession createSession(int ackMode,
                                   java.lang.String user,
                                   java.lang.String pass,
                                   java.lang.Boolean preAck,
                                   java.lang.Integer dupsOkBatchSize,
                                   java.lang.Integer transactionBatchSize,
                                   boolean deliveryTransacted)
                            throws java.lang.Exception
Throws:
java.lang.Exception

createSession

public ClientSession createSession(ClientSessionFactory parameterFactory,
                                   int ackMode,
                                   java.lang.String user,
                                   java.lang.String pass,
                                   java.lang.Boolean preAck,
                                   java.lang.Integer dupsOkBatchSize,
                                   java.lang.Integer transactionBatchSize,
                                   boolean deliveryTransacted)
                            throws java.lang.Exception
Throws:
java.lang.Exception

createRemoteFactory

public JBossConnectionFactory createRemoteFactory(java.lang.String connectorClassName,
                                                  java.util.Map<java.lang.String,java.lang.Object> connectionParameters)
Parameters:
connectorClassName -
connectionParameters -

createDiscoveryFactory

public JBossConnectionFactory createDiscoveryFactory(java.lang.String discoveryGroup,
                                                     java.lang.Integer discoveryGroupPort)
Parameters:
discoveryGroup -
discoveryGroupPort -

getProperties

protected JBMRAProperties getProperties()
Get the resource adapter properties

Returns:
The properties

setup

protected void setup()
              throws MessagingException
Setup the factory

Throws:
MessagingException

getJBossConnectionFactory

public JBossConnectionFactory getJBossConnectionFactory()
                                                 throws javax.resource.ResourceException
Throws:
javax.resource.ResourceException


Copyright © 2006 JBoss Inc. All Rights Reserved.