java.lang.Object | |
↳ | org.springframework.jca.endpoint.GenericMessageEndpointManager |
Known Direct Subclasses |
Generic bean that manages JCA 1.5 message endpoints within a Spring application context, activating and deactivating the endpoint as part of the application context's lifecycle.
This class is completely generic in that it may work with any ResourceAdapter, any MessageEndpointFactory, and any ActivationSpec. It can be configured in standard bean style, for example through Spring's XML bean definition format, as follows:
<bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager"> <property name="resourceAdapter" ref="resourceAdapter"/> <property name="messageEndpointFactory"> <bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"> <property name="messageListener" ref="messageListener"/> </bean> </property> <property name="activationSpec"> <bean class="org.apache.activemq.ra.ActiveMQActivationSpec"> <property name="destination" value="myQueue"/> <property name="destinationType" value="javax.jms.Queue"/> </bean> </property> </bean>In this example, Spring's own
GenericMessageEndpointFactory
is used
to point to a standard message listener object that happens to be supported
by the specified target ResourceAdapter: in this case, a JMS
javax.jms.MessageListener object as supported by the ActiveMQ
message broker, defined as a Spring bean:
<bean id="messageListener" class="com.myorg.messaging.myMessageListener"> ... </bean>The target ResourceAdapter may be configured as a local Spring bean as well (the typical case) or obtained from JNDI (e.g. on WebLogic). For the example above, a local ResourceAdapter bean could be defined as follows (matching the "resourceAdapter" bean reference above):
<bean id="resourceAdapter" class="org.springframework.jca.support.ResourceAdapterFactoryBean"> <property name="resourceAdapter"> <bean class="org.apache.activemq.ra.ActiveMQResourceAdapter"> <property name="serverUrl" value="tcp://localhost:61616"/> </bean> </property> <property name="workManager"> <bean class="org.springframework.jca.work.SimpleTaskWorkManager"/> </property> </bean>For a different target resource, the configuration would simply point to a different ResourceAdapter and a different ActivationSpec object (which are both specific to the resource provider), and possibly a different message listener (e.g. a CCI javax.resource.cci.MessageListener for a resource adapter which is based on the JCA Common Client Interface).
The asynchronous execution strategy can be customized through the
"workManager" property on the ResourceAdapterFactoryBean (as shown above).
Check out SimpleTaskWorkManager
's
javadoc for its configuration options; alternatively, any other
JCA-compliant WorkManager can be used (e.g. Geronimo's).
Transactional execution is a responsibility of the concrete message endpoint,
as built by the specified MessageEndpointFactory. GenericMessageEndpointFactory
supports XA transaction participation through its "transactionManager" property,
typically with a Spring JtaTransactionManager
or a plain javax.transaction.TransactionManager implementation specified there.
<bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager"> <property name="resourceAdapter" ref="resourceAdapter"/> <property name="messageEndpointFactory"> <bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"> <property name="messageListener" ref="messageListener"/> <property name="transactionManager" ref="transactionManager"/> </bean> </property> <property name="activationSpec"> <bean class="org.apache.activemq.ra.ActiveMQActivationSpec"> <property name="destination" value="myQueue"/> <property name="destinationType" value="javax.jms.Queue"/> </bean> </property> </bean> <bean id="transactionManager" class="org.springframework.transaction.jta.JtaTransactionManager"/>Alternatively, check out your resource provider's ActivationSpec object, which should support local transactions through a provider-specific config flag, e.g. ActiveMQActivationSpec's "useRAManagedTransaction" bean property.
<bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager"> <property name="resourceAdapter" ref="resourceAdapter"/> <property name="messageEndpointFactory"> <bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"> <property name="messageListener" ref="messageListener"/> </bean> </property> <property name="activationSpec"> <bean class="org.apache.activemq.ra.ActiveMQActivationSpec"> <property name="destination" value="myQueue"/> <property name="destinationType" value="javax.jms.Queue"/> <property name="useRAManagedTransaction" value="true"/> </bean> </property> </bean>
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Prepares the message endpoint, and automatically activates it
if the "autoStartup" flag is set to "true".
| |||||||||||
Deactivates the message endpoint, preparing it for shutdown.
| |||||||||||
Return the JCA ActivationSpec to use for activating the endpoint.
| |||||||||||
Return the JCA MessageEndpointFactory to activate.
| |||||||||||
Return the phase in which this endpoint manager will be started and stopped.
| |||||||||||
Return the JCA ResourceAdapter to manage endpoints for.
| |||||||||||
Return the value for the 'autoStartup' property.
| |||||||||||
Return whether the configured message endpoint is currently active.
| |||||||||||
Set the JCA ActivationSpec to use for activating the endpoint.
| |||||||||||
Set whether to auto-start the endpoint activation after this endpoint
manager has been initialized and the context has been refreshed.
| |||||||||||
Set the JCA MessageEndpointFactory to activate, pointing to a
MessageListener object that the endpoints will delegate to.
| |||||||||||
Specify the phase in which this endpoint manager should be started
and stopped.
| |||||||||||
Set the JCA ResourceAdapter to manage endpoints for.
| |||||||||||
Activates the configured message endpoint.
| |||||||||||
Deactivates the configured message endpoint.
| |||||||||||
Indicates that a Lifecycle component must stop if it is currently running.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.beans.factory.DisposableBean
| |||||||||||
From interface
org.springframework.beans.factory.InitializingBean
| |||||||||||
From interface
org.springframework.context.Lifecycle
| |||||||||||
From interface
org.springframework.context.Phased
| |||||||||||
From interface
org.springframework.context.SmartLifecycle
|
Prepares the message endpoint, and automatically activates it if the "autoStartup" flag is set to "true".
ResourceException |
---|
Deactivates the message endpoint, preparing it for shutdown.
Return the JCA ActivationSpec to use for activating the endpoint.
Return the JCA MessageEndpointFactory to activate.
Return the phase in which this endpoint manager will be started and stopped.
Return the JCA ResourceAdapter to manage endpoints for.
Return the value for the 'autoStartup' property. If "true", this endpoint manager will start upon a ContextRefreshedEvent.
Return whether the configured message endpoint is currently active.
Set the JCA ActivationSpec to use for activating the endpoint.
Note that this ActivationSpec instance should not be shared across multiple ResourceAdapter instances.
Set whether to auto-start the endpoint activation after this endpoint manager has been initialized and the context has been refreshed.
Default is "true". Turn this flag off to defer the endpoint activation until an explicit {#start()} call.
Set the JCA MessageEndpointFactory to activate, pointing to a MessageListener object that the endpoints will delegate to.
A MessageEndpointFactory instance may be shared across multiple
endpoints (i.e. multiple GenericMessageEndpointManager instances),
with different ActivationSpec
objects applied.
Specify the phase in which this endpoint manager should be started and stopped. The startup order proceeds from lowest to highest, and the shutdown order is the reverse of that. By default this value is Integer.MAX_VALUE meaning that this endpoint manager starts as late as possible and stops as soon as possible.
Set the JCA ResourceAdapter to manage endpoints for.
Activates the configured message endpoint.
Deactivates the configured message endpoint.
Indicates that a Lifecycle component must stop if it is currently running.
The provided callback is used by the LifecycleProcessor to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the SmartLifecycle component does indeed stop.