public class

JmsMessageEndpointManager

extends GenericMessageEndpointManager
java.lang.Object
   ↳ org.springframework.jca.endpoint.GenericMessageEndpointManager
     ↳ org.springframework.jms.listener.endpoint.JmsMessageEndpointManager

Class Overview

Extension of the generic JCA 1.5 GenericMessageEndpointManager, adding JMS-specific support for ActivationSpec configuration.

Allows for defining a common JmsActivationSpecConfig object that gets converted into a provider-specific JCA 1.5 ActivationSpec object for activating the endpoint.

NOTE: This JCA-based endpoint manager supports standard JMS javax.jms.MessageListener endpoints only. It does not support Spring's SessionAwareMessageListener variant, simply because the JCA endpoint management contract does not allow for obtaining the current JMS javax.jms.Session.

See Also

Summary

Public Constructors
JmsMessageEndpointManager()
Public Methods
void afterPropertiesSet()
Prepares the message endpoint, and automatically activates it if the "autoStartup" flag is set to "true".
void setActivationSpecConfig(JmsActivationSpecConfig activationSpecConfig)
Specify the JmsActivationSpecConfig object that this endpoint manager should use for activating its listener.
void setActivationSpecFactory(JmsActivationSpecFactory activationSpecFactory)
Set the factory for concrete JCA 1.5 ActivationSpec objects, creating JCA ActivationSpecs based on JmsActivationSpecConfig objects.
void setDestinationResolver(DestinationResolver destinationResolver)
Set the DestinationResolver to use for resolving destination names into the JCA 1.5 ActivationSpec "destination" property.
void setMessageListener(MessageListener messageListener)
Set the JMS MessageListener for this endpoint.
void setTransactionManager(Object transactionManager)
Set the XA transaction manager to use for wrapping endpoint invocations, enlisting the endpoint resource in each such transaction.
[Expand]
Inherited Methods
From class org.springframework.jca.endpoint.GenericMessageEndpointManager
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

Public Constructors

public JmsMessageEndpointManager ()

Public Methods

public void afterPropertiesSet ()

Prepares the message endpoint, and automatically activates it if the "autoStartup" flag is set to "true".

Throws
ResourceException

public void setActivationSpecConfig (JmsActivationSpecConfig activationSpecConfig)

Specify the JmsActivationSpecConfig object that this endpoint manager should use for activating its listener.

This config object will be turned into a concrete JCA 1.5 ActivationSpec object through a JmsActivationSpecFactory.

public void setActivationSpecFactory (JmsActivationSpecFactory activationSpecFactory)

Set the factory for concrete JCA 1.5 ActivationSpec objects, creating JCA ActivationSpecs based on JmsActivationSpecConfig objects.

This factory is dependent on the concrete JMS provider, e.g. on ActiveMQ. The default implementation simply guesses the ActivationSpec class name from the provider's class name (e.g. "ActiveMQResourceAdapter" -> "ActiveMQActivationSpec" in the same package), and populates the ActivationSpec properties as suggested by the JCA 1.5 specification (plus a couple of autodetected vendor-specific properties).

See Also

public void setDestinationResolver (DestinationResolver destinationResolver)

Set the DestinationResolver to use for resolving destination names into the JCA 1.5 ActivationSpec "destination" property.

If not specified, destination names will simply be passed in as Strings. If specified, destination names will be resolved into Destination objects first.

Note that a DestinationResolver is usually specified on the JmsActivationSpecFactory (see setDestinationResolver(DestinationResolver)). This is simply a shortcut for parameterizing the default JmsActivationSpecFactory; it will replace any custom JmsActivationSpecFactory that might have been set before.

See Also

public void setMessageListener (MessageListener messageListener)

Set the JMS MessageListener for this endpoint.

This is a shortcut for configuring a dedicated JmsMessageEndpointFactory.

See Also

public void setTransactionManager (Object transactionManager)

Set the XA transaction manager to use for wrapping endpoint invocations, enlisting the endpoint resource in each such transaction.

The passed-in object may be a transaction manager which implements Spring's TransactionFactory interface, or a plain javax.transaction.TransactionManager.

If no transaction manager is specified, the endpoint invocation will simply not be wrapped in an XA transaction. Consult your resource provider's ActivationSpec documentation for the local transaction options of your particular provider.

This is a shortcut for configuring a dedicated JmsMessageEndpointFactory.

See Also