org.openmdx.kernel.application.deploy.spi
Interface Deployment.ResourceAdapter

All Superinterfaces:

Deployment.Pool

All Known Implementing Classes:

ResourceAdapterDecorator, ResourceAdapterDeploymentDescriptor

Enclosing interface:

Deployment

public static interface Deployment.ResourceAdapter
extends Deployment.Pool

A Java 2 Resource Adapter

The resourceadapterType specifies information about the resource adapter. The information includes fully qualified resource adapter Java class name, configuration properties, information specific to the implementation of the resource adapter library as specified through the outbound-resourceadapter and inbound-resourceadapter elements, and an optional set of administered objects.

Method Summary

void	deploy(Context containerContext, Context applicationContext, Reference reference) This method deploys the resource adapter
List	getAuthenticationMechanism() Get the supported authentication mechanisms.
Map	getConfigProperties() The connector architecture defines a set of well-defined properties all of type java.lang.String.
String	getConnectionFactoryImplClass() The element connectionfactory-impl-class specifies the fully qualified name of the ConnectionFactory class that implements resource adapter specific ConnectionFactory interface.
String	getConnectionFactoryInterface() The element connectionfactory-interface specifies the fully qualified name of the ConnectionFactory interface supported by the resource adapter
String	getConnectionImplClass() The connection-impl-classType specifies the fully qualified name of the Connection class that implements resource adapter specific Connection interface.
String	getConnectionInterface() The connection-interface element specifies the fully qualified name of the Connection interface supported by the resource adapter.
String	getManagedConnectionFactoryClass() The element managedconnectionfactory-class specifies the fully qualified name of the Java class that implements the javax.resource.spi.ManagedConnectionFactory interface.
boolean	getReauthenticationSupport() The element reauthentication-support specifies whether the resource adapter implementation supports re-authentication of existing Managed-Connection instance.
String	getTransactionSupport() The transaction-supportType specifies the level of transaction support provided by the resource adapter.

Methods inherited from interface org.openmdx.kernel.application.deploy.spi.Deployment.Pool

getInitialCapacity, getMaximumCapacity, getMaximumWait

Method Detail

getConfigProperties

Map getConfigProperties()

The connector architecture defines a set of well-defined properties all of type java.lang.String. These are as follows:

• ServerName
• PortNumber
• UserName
• Password
• ConnectionURL

A resource adapter provider can extend this property set to include properties specific to the resource adapter and its underlying EIS. Possible values include

• ServerName
• PortNumber
• UserName
• Password
• ConnectionURL

Property values may be instances of

• java.lang.Boolean
• java.lang.String
• java.lang.Integer
• java.lang.Double
• java.lang.Byte
• java.lang.Short
• java.lang.Long
• java.lang.Float
• java.lang.Character

Returns:

an instance mapping proerties to values.

getManagedConnectionFactoryClass

String getManagedConnectionFactoryClass()

The element managedconnectionfactory-class specifies the fully qualified name of the Java class that implements the javax.resource.spi.ManagedConnectionFactory interface. This Java class is provided as part of resource adapter's implementation of connector architecture specified contracts. The implementation of this class is required to be a JavaBean.

Example:

• com.wombat.ManagedConnectionFactoryImpl

Returns:

the managed connection factory class name

getConnectionFactoryInterface

String getConnectionFactoryInterface()

The element connectionfactory-interface specifies the fully qualified name of the ConnectionFactory interface supported by the resource adapter

Example:

• com.wombat.ConnectionFactory
• javax.resource.cci.ConnectionFactory

Returns:

the managed connection factory interface name

getConnectionFactoryImplClass

String getConnectionFactoryImplClass()

The element connectionfactory-impl-class specifies the fully qualified name of the ConnectionFactory class that implements resource adapter specific ConnectionFactory interface.

Example:

• com.wombat.ConnectionFactoryImpl

Returns:

the connection factory class name

getConnectionInterface

String getConnectionInterface()

The connection-interface element specifies the fully qualified name of the Connection interface supported by the resource adapter.

Example:

• javax.resource.cci.Connection

Returns:

the connection factory interface name

getConnectionImplClass

String getConnectionImplClass()

The connection-impl-classType specifies the fully qualified name of the Connection class that implements resource adapter specific Connection interface. It is used by the connection-impl-class elements.

Example:

• com.wombat.ConnectionImpl

Returns:

the connection class name

getTransactionSupport

String getTransactionSupport()

The transaction-supportType specifies the level of transaction support provided by the resource adapter. It is used by transaction-support elements.

The value must be one of the following:

• NoTransaction
• LocalTransaction
• XATransaction

Returns:

the kind of transaction support

getAuthenticationMechanism

List getAuthenticationMechanism()

Get the supported authentication mechanisms.

Note that this support is for the resource adapter and not for the underlying EIS instance. The optional description specifies any resource adapter specific requirement for the support of security contract and authentication mechanism.

Returns:

the supported authentication mechanisms

getReauthenticationSupport

boolean getReauthenticationSupport()

The element reauthentication-support specifies whether the resource adapter implementation supports re-authentication of existing Managed-Connection instance.

Note that this information is for the resource adapter implementation and not for the underlying EIS instance.

Returns:

true if reauthentication is supported

deploy

void deploy(Context containerContext,
            Context applicationContext,
            Reference reference)
            throws NamingException

This method deploys the resource adapter

Parameters:

containerContext - components are registered in the containerContext in order to be referenced by other components. It's URL for LinkRef's is "openmdx:container".

applicationContext - components may be registered in the applicationContext for application internal link resolutions. It's URL for LinkRef's is "openmdx:application".

reference - Reference to the connection factory

Throws:

NamingException