Package com.sun.enterprise.connectors.jms.system

Class ActiveJmsResourceAdapter

java.lang.Object

com.sun.enterprise.connectors.ActiveResourceAdapterImpl

com.sun.enterprise.connectors.ActiveOutboundResourceAdapter

com.sun.enterprise.connectors.inbound.ActiveInboundResourceAdapterImpl

com.sun.enterprise.connectors.jms.system.ActiveJmsResourceAdapter

All Implemented Interfaces:

ActiveResourceAdapter, ActiveInboundResourceAdapter, org.glassfish.hk2.api.PostConstruct, LazyServiceInitializer

@Service
@Singleton
@Named("mq-service")
public class ActiveJmsResourceAdapter
extends ActiveInboundResourceAdapterImpl
implements LazyServiceInitializer, org.glassfish.hk2.api.PostConstruct

Represents an active JMS resource adapter. This does additional configuration to ManagedConnectionFactory and ResourceAdapter java beans. XXX: For code management reasons, think about splitting this to a preHawk and postHawk RA (with postHawk RA extending preHawk RA).

Author:

Satish Kumar

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADDRESSLIST
static String	ADMINPASSWORD
static String	ADMINUSERNAME
static String	BROKERTYPE
static String	CONNECTION_URL
static String	DESTINATION
static String	DESTINATION_TYPE
static String	DIRECT
static String	DISABLED
static String	EMBEDDED
static String	GRIZZLY_PROXY_PREFIX
static String	JMS_SERVICE
static String	LOCAL
static String	MQ_DIR_NAME
static String	PHYSICAL_DESTINATION
static String	REMOTE

Fields inherited from class com.sun.enterprise.connectors.ActiveOutboundResourceAdapter

bootStrapContextImpl, resourceadapter_

Fields inherited from class com.sun.enterprise.connectors.ActiveResourceAdapterImpl

connectionDefs_, connectorRuntime_, desc_, jcl_, moduleName_

Constructor Summary

Constructors

Constructor	Description
ActiveJmsResourceAdapter()	Constructor for an active Jms Adapter.

Method Summary

Modifier and Type	Method	Description
void	addJmsHost(JmsHost host)	Adds the JmsHost to the MQAddressList of the resource adapter.
jakarta.resource.spi.ManagedConnectionFactory[]	createManagedConnectionFactories(ConnectorConnectionPool cpr, ClassLoader loader)	This is a temporay solution for obtaining all the MCFs corresponding to a JMS RA pool, this is to facilitate the recovery process where the XA resources of all RMs in the broker cluster are required.
jakarta.resource.spi.ManagedConnectionFactory	createManagedConnectionFactory(ConnectorConnectionPool cpr, ClassLoader loader)	Creates ManagedConnection Factory instance.
void	deleteJmsHost(JmsHost host)	Removes the JmsHost from the MQAddressList of the resource adapter.
void	destroy()	Destroys default pools and resources.
int	getAddressListCount()
static String	getBrokerInstanceName(JmsService js)
boolean	getDoBind()	Whether JMS should bind to a port
Set<String>	getGrizzlyListeners()
protected JmsHost	getJmsHost()
void	handleRequest(SelectableChannel selectableChannel)	Upon successful ACCEPT of every request on this port, the service is called upon to handle the request.
boolean	handles(ConnectorDescriptor cd, String moduleName)	Indicates whether a particular implementation of ActiveRA can handle the RAR in question.
void	initializeLazyListener(JmsService jmsService)	Start Grizzly based JMS lazy listener, which is going to initialize JMS container on first request.
boolean	initializeService()	Upon accepting the first request on the port (to which this listener is bound), the listener will select the appropriate provider and call this method to let the actual service initialize itself.
protected jakarta.resource.spi.ManagedConnectionFactory	instantiateMCF(String mcfClass, ClassLoader loader)
protected void	loadRAConfiguration()	Loads RA configuration for MQ Resource adapter.
protected Set	mergeRAConfiguration(ResourceAdapterConfig raConfig, List<Property> raConfigProps)	This is a HACK to remove the connection URL in the case of PE LOCAL/EMBEDDED before setting the properties to the RA.
void	postConstruct()
protected void	postRAConfiguration()	Method to perform any post RA configuration action by derivative subclasses.
void	reloadRA(JmsService js)	Recreates the ResourceAdapter using new values from JmsSerice.
protected void	setClusterBrokerList(String brokerList)
void	setMasterBroker(String newMasterBroker)
void	setup()	Does the necessary initial setup.
protected void	startResourceAdapter(jakarta.resource.spi.BootstrapContext bootstrapContext)	called by connector runtime to start the resource-adapter java bean
void	updateJmsHost(JmsHost host)	Updates the JmsHost information in the MQAddressList of the resource adapter.
void	updateMDBRuntimeInfo(EjbMessageBeanDescriptor descriptor_, BeanPoolDescriptor poolDescriptor)	This is the most appropriate time (??) to update the runtime info of a 1.3 MDB into 1.4 MDB.
void	validateActivationSpec(jakarta.resource.spi.ActivationSpec spec)	validate the activation-spec

Methods inherited from class com.sun.enterprise.connectors.inbound.ActiveInboundResourceAdapterImpl

addEndpointFactoryInfo, getAllEndpointFactories, getAllEndpointFactoryInfo, getEndpointFactoryInfo, init, removeEndpointFactoryInfo

Methods inherited from class com.sun.enterprise.connectors.ActiveOutboundResourceAdapter

addAdminObject, getBootStrapContext, getResourceAdapter

Methods inherited from class com.sun.enterprise.connectors.ActiveResourceAdapterImpl

createAllConnectorResources, createDefaultConnectorConnectionPools, createDefaultConnectorResources, deleteDefaultConnectorConnectionPools, deleteDefaultConnectorResources, destroyAllConnectorResources, getClassLoader, getDescriptor, getModuleName, isServer, isSystemRar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.enterprise.connectors.ActiveResourceAdapter

getClassLoader, getDescriptor, getModuleName, getResourceAdapter

Field Detail

CONNECTION_URL

public static final String CONNECTION_URL

See Also:

Constant Field Values

BROKERTYPE

public static final String BROKERTYPE

See Also:

Constant Field Values

ADMINUSERNAME

public static final String ADMINUSERNAME

See Also:

Constant Field Values

ADMINPASSWORD

public static final String ADMINPASSWORD

See Also:

Constant Field Values

DESTINATION

public static final String DESTINATION

See Also:

Constant Field Values

DESTINATION_TYPE

public static final String DESTINATION_TYPE

See Also:

Constant Field Values

PHYSICAL_DESTINATION

public static final String PHYSICAL_DESTINATION

See Also:

Constant Field Values

ADDRESSLIST

public static final String ADDRESSLIST

See Also:

Constant Field Values

JMS_SERVICE

public static final String JMS_SERVICE

See Also:

Constant Field Values

EMBEDDED

public static final String EMBEDDED

See Also:

Constant Field Values

LOCAL

public static final String LOCAL

See Also:

Constant Field Values

REMOTE

public static final String REMOTE

See Also:

Constant Field Values

DIRECT

public static final String DIRECT

See Also:

Constant Field Values

DISABLED

public static final String DISABLED

See Also:

Constant Field Values

MQ_DIR_NAME

public static final String MQ_DIR_NAME

See Also:

Constant Field Values

GRIZZLY_PROXY_PREFIX

public static final String GRIZZLY_PROXY_PREFIX

See Also:

Constant Field Values

Constructor Detail

ActiveJmsResourceAdapter

public ActiveJmsResourceAdapter()

Constructor for an active Jms Adapter.

Method Detail

postConstruct

public void postConstruct()

Specified by:

postConstruct in interface org.glassfish.hk2.api.PostConstruct

loadRAConfiguration

protected void loadRAConfiguration()
                            throws ConnectorRuntimeException

Loads RA configuration for MQ Resource adapter.

Overrides:

loadRAConfiguration in class ActiveOutboundResourceAdapter

Throws:

ConnectorRuntimeException - in case of an exception.

destroy

public void destroy()

Description copied from class: ActiveInboundResourceAdapterImpl

Destroys default pools and resources. Stops the Resource adapter java bean.

Specified by:

destroy in interface ActiveResourceAdapter

Overrides:

destroy in class ActiveInboundResourceAdapterImpl

getGrizzlyListeners

public Set<String> getGrizzlyListeners()

initializeLazyListener

public void initializeLazyListener(JmsService jmsService)
                            throws JmsInitialisationException

Start Grizzly based JMS lazy listener, which is going to initialize JMS container on first request.

Parameters:

jmsService -

Throws:

JmsInitialisationException

startResourceAdapter

protected void startResourceAdapter(jakarta.resource.spi.BootstrapContext bootstrapContext)
                             throws jakarta.resource.spi.ResourceAdapterInternalException

Description copied from class: ActiveOutboundResourceAdapter

called by connector runtime to start the resource-adapter java bean

Overrides:

startResourceAdapter in class ActiveOutboundResourceAdapter

Parameters:

bootstrapContext - BootstrapContext

Throws:

jakarta.resource.spi.ResourceAdapterInternalException

mergeRAConfiguration

protected Set mergeRAConfiguration(ResourceAdapterConfig raConfig,
                                   List<Property> raConfigProps)

This is a HACK to remove the connection URL in the case of PE LOCAL/EMBEDDED before setting the properties to the RA. If this was not done, MQ RA incorrectly assumed that the passed in connection URL is one additional URL, apart from the default URL derived from brokerhost:brokerport and reported a PE connection url limitation.

Overrides:

mergeRAConfiguration in class ActiveOutboundResourceAdapter

Parameters:

raConfig - resource-adapter-config

raConfigProps - resource-adapter bean configuration

Returns:

setup

public void setup()
           throws ConnectorRuntimeException

Description copied from class: ActiveOutboundResourceAdapter

Does the necessary initial setup. Creates the default pool and resource.

Specified by:

setup in interface ActiveResourceAdapter

Overrides:

setup in class ActiveOutboundResourceAdapter

Throws:

ConnectorRuntimeException - If there is a failure

postRAConfiguration

protected void postRAConfiguration()
                            throws ConnectorRuntimeException

Method to perform any post RA configuration action by derivative subclasses. For example, this method is used by ActiveJMSResourceAdapter to set unsupported javabean property types on its RA JavaBean runtime instance.

Throws:

ConnectorRuntimeException

getBrokerInstanceName

public static String getBrokerInstanceName(JmsService js)

handles

public boolean handles(ConnectorDescriptor cd,
                       String moduleName)

Description copied from class: ActiveInboundResourceAdapterImpl

Indicates whether a particular implementation of ActiveRA can handle the RAR in question.

Specified by:

handles in interface ActiveResourceAdapter

Overrides:

handles in class ActiveInboundResourceAdapterImpl

Parameters:

cd - ConnectorDescriptor

moduleName - resource adapter name

Returns:

boolean indiating whether a ActiveRA can handle the RAR

validateActivationSpec

public void validateActivationSpec(jakarta.resource.spi.ActivationSpec spec)

Description copied from interface: ActiveInboundResourceAdapter

validate the activation-spec

Specified by:

validateActivationSpec in interface ActiveInboundResourceAdapter

Overrides:

validateActivationSpec in class ActiveInboundResourceAdapterImpl

Parameters:

spec - activation-spec

reloadRA

public void reloadRA(JmsService js)
              throws ConnectorRuntimeException

Recreates the ResourceAdapter using new values from JmsSerice.

Parameters:

js - JmsService element of the domain.xml

Throws:

ConnectorRuntimeException - in case of any backend error.

addJmsHost

public void addJmsHost(JmsHost host)
                throws ConnectorRuntimeException

Adds the JmsHost to the MQAddressList of the resource adapter.

Parameters:

host - JmsHost element in the domain.xml

Throws:

ConnectorRuntimeException - in case of any backend error.

deleteJmsHost

public void deleteJmsHost(JmsHost host)
                   throws ConnectorRuntimeException

Removes the JmsHost from the MQAddressList of the resource adapter.

Parameters:

host - JmsHost element in the domain.xml

Throws:

ConnectorRuntimeException - in case of any backend error.

getJmsHost

protected JmsHost getJmsHost()

updateJmsHost

public void updateJmsHost(JmsHost host)
                   throws ConnectorRuntimeException

Updates the JmsHost information in the MQAddressList of the resource adapter.

Parameters:

host - JmsHost element in the domain.xml

Throws:

ConnectorRuntimeException - in case of any backend error.

getDoBind

public boolean getDoBind()

Whether JMS should bind to a port

Returns:

false in embedded mode, true otherwise

createManagedConnectionFactories

public jakarta.resource.spi.ManagedConnectionFactory[] createManagedConnectionFactories(ConnectorConnectionPool cpr,
                                                                                        ClassLoader loader)

This is a temporay solution for obtaining all the MCFs corresponding to a JMS RA pool, this is to facilitate the recovery process where the XA resources of all RMs in the broker cluster are required. Should be removed when a permanent solutuion is available from the broker.

Specified by:

createManagedConnectionFactories in interface ActiveResourceAdapter

Overrides:

createManagedConnectionFactories in class ActiveResourceAdapterImpl

Parameters:

cpr - ConnectorConnectionPool object

loader - Class Loader.

Returns:

instantiateMCF

protected jakarta.resource.spi.ManagedConnectionFactory instantiateMCF(String mcfClass,
                                                                       ClassLoader loader)
                                                                throws Exception

Overrides:

instantiateMCF in class ActiveResourceAdapterImpl

Throws:

Exception

createManagedConnectionFactory

public jakarta.resource.spi.ManagedConnectionFactory createManagedConnectionFactory(ConnectorConnectionPool cpr,
                                                                                    ClassLoader loader)

Creates ManagedConnection Factory instance. For any property that is for supporting AS7 imq properties, resource adapter has a set method setProperty(String,String). All as7 properties starts with "imq". MQ Adapter supports this only for backward compatibility.

Specified by:

createManagedConnectionFactory in interface ActiveResourceAdapter

Overrides:

createManagedConnectionFactory in class ActiveOutboundResourceAdapter

Parameters:

cpr - ConnectorConnectionPool object

loader - Class Loader.

Returns:

updateMDBRuntimeInfo

public void updateMDBRuntimeInfo(EjbMessageBeanDescriptor descriptor_,
                                 BeanPoolDescriptor poolDescriptor)
                          throws ConnectorRuntimeException

This is the most appropriate time (??) to update the runtime info of a 1.3 MDB into 1.4 MDB.

Assumptions :

0. Assume it is a 1.3 MDB if no RA mid is specified. 1. Use the default system JMS resource adapter.

2. The ActivationSpec of the default JMS RA will provide the setDestination, setDestinationType, setSubscriptionName methods. 3. The jndi-name of the 1.3 MDB is the value for the Destination property for the ActivationSpec. 4. The ActivationSpec provides setter methods for the properties defined in the CF that corresponds to the mdb-connection-factory JNDI name.

Specified by:

updateMDBRuntimeInfo in interface ActiveInboundResourceAdapter

Overrides:

updateMDBRuntimeInfo in class ActiveInboundResourceAdapterImpl

Parameters:

descriptor_ -

poolDescriptor -

Throws:

ConnectorRuntimeException

getAddressListCount

public int getAddressListCount()

initializeService

public boolean initializeService()

Description copied from interface: LazyServiceInitializer

Upon accepting the first request on the port (to which this listener is bound), the listener will select the appropriate provider and call this method to let the actual service initialize itself. All further accept requests on this port will wait while the service is initialized. Upon successful completion of service initialization, all pending requests are passed to the service using the handleRequest method

Specified by:

initializeService in interface LazyServiceInitializer

Returns:

Return true if service initialization went through fine; false otherwise

handleRequest

public void handleRequest(SelectableChannel selectableChannel)

Description copied from interface: LazyServiceInitializer

Upon successful ACCEPT of every request on this port, the service is called upon to handle the request. The service is provided the channel itself. The service can setup connection, its characteristics, decide on blocking/non-blocking modes etc. The service is expected to return control back to the listener ASAP without consuming this thread for processing the requst completely.

Specified by:

handleRequest in interface LazyServiceInitializer

Parameters:

selectableChannel - where the incoming request was accepted.

setMasterBroker

public void setMasterBroker(String newMasterBroker)

setClusterBrokerList

protected void setClusterBrokerList(String brokerList)