org.openmdx.kernel.application.deploy.enterprise
Class ResourceAdapterDeploymentDescriptor

java.lang.Object
  org.openmdx.kernel.application.deploy.enterprise.AbstractDeploymentDescriptor
      org.openmdx.kernel.application.deploy.enterprise.ResourceAdapterDeploymentDescriptor

All Implemented Interfaces:

Deployment.Pool, Deployment.ResourceAdapter

public class ResourceAdapterDeploymentDescriptor
extends AbstractDeploymentDescriptor
implements Deployment.ResourceAdapter

Field Summary

Fields inherited from class org.openmdx.kernel.application.deploy.enterprise.AbstractDeploymentDescriptor

REPORT_APPLICATION_NAME, REPORT_APPLICATION_VERSION, REPORT_CONNECTOR_NAME, REPORT_CONNECTOR_VERSION, REPORT_EJB_CLIENT_NAME, REPORT_EJB_COMPONENT_NAME, REPORT_EJB_MODULE_NAME, REPORT_EJB_VERSION

Constructor Summary

ResourceAdapterDeploymentDescriptor()

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	getConnectionFactoryJndiName()
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	getCredentialInterface()
Integer	getInitialCapacity() The initial-capacity element identifies the initial number of instance which the openMDX Container will attempt to obtain during deployment.
String	getManagedConnectionFactoryClass() The element managedconnectionfactory-class specifies the fully qualified name of the Java class that implements the javax.resource.spi.ManagedConnectionFactory interface.
Integer	getMaximumCapacity() The maximum-capacity element identifies the maximum number of managed connections which the openMDX Container will allow.
Long	getMaximumWait() The maximum-wait element defines the time in milliseconds to wait for an instance to be returned to the pool when there are maximum-capacity active instances.
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.
void	parseOpenMdxXml(Element element, Report report)
void	parseXml(Element element, Report report)
void	verify(Report report)

Methods inherited from class org.openmdx.kernel.application.deploy.enterprise.AbstractDeploymentDescriptor

createUniqueLocalApplicationContextLink, createUniqueRemoteApplicationContextLink, getChildrenByTagName, getElementContent, getOptionalChild, getUniqueChild

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceAdapterDeploymentDescriptor

public ResourceAdapterDeploymentDescriptor()

Method Detail

parseXml

public void parseXml(Element element,
                     Report report)

Specified by:

parseXml in class AbstractDeploymentDescriptor

parseOpenMdxXml

public void parseOpenMdxXml(Element element,
                            Report report)

Specified by:

parseOpenMdxXml in class AbstractDeploymentDescriptor

getConfigProperties

public Map getConfigProperties()

Description copied from interface: Deployment.ResourceAdapter

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

Specified by:

getConfigProperties in interface Deployment.ResourceAdapter

Returns:

an instance mapping proerties to values.

verify

public void verify(Report report)

Overrides:

verify in class AbstractDeploymentDescriptor

getManagedConnectionFactoryClass

public String getManagedConnectionFactoryClass()

Description copied from interface: Deployment.ResourceAdapter

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

Specified by:

getManagedConnectionFactoryClass in interface Deployment.ResourceAdapter

Returns:

the managed connection factory class name

getConnectionFactoryInterface

public String getConnectionFactoryInterface()

Description copied from interface: Deployment.ResourceAdapter

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

Specified by:

getConnectionFactoryInterface in interface Deployment.ResourceAdapter

Returns:

the managed connection factory interface name

getConnectionFactoryImplClass

public String getConnectionFactoryImplClass()

Description copied from interface: Deployment.ResourceAdapter

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

Specified by:

getConnectionFactoryImplClass in interface Deployment.ResourceAdapter

Returns:

the connection factory class name

getConnectionInterface

public String getConnectionInterface()

Description copied from interface: Deployment.ResourceAdapter

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

Example:

• javax.resource.cci.Connection

Specified by:

getConnectionInterface in interface Deployment.ResourceAdapter

Returns:

the connection factory interface name

getConnectionImplClass

public String getConnectionImplClass()

Description copied from interface: Deployment.ResourceAdapter

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

Specified by:

getConnectionImplClass in interface Deployment.ResourceAdapter

Returns:

the connection class name

getTransactionSupport

public String getTransactionSupport()

Description copied from interface: Deployment.ResourceAdapter

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

Specified by:

getTransactionSupport in interface Deployment.ResourceAdapter

Returns:

the kind of transaction support

getCredentialInterface

public String getCredentialInterface()

getReauthenticationSupport

public boolean getReauthenticationSupport()

Description copied from interface: Deployment.ResourceAdapter

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.

Specified by:

getReauthenticationSupport in interface Deployment.ResourceAdapter

Returns:

true if reauthentication is supported

getAuthenticationMechanism

public List getAuthenticationMechanism()

Description copied from interface: Deployment.ResourceAdapter

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.

Specified by:

getAuthenticationMechanism in interface Deployment.ResourceAdapter

Returns:

the supported authentication mechanisms

getConnectionFactoryJndiName

public String getConnectionFactoryJndiName()

getInitialCapacity

public Integer getInitialCapacity()

Description copied from interface: Deployment.Pool

The initial-capacity element identifies the initial number of instance which the openMDX Container will attempt to obtain during deployment.

The default initial capacity is 1.

Specified by:

getInitialCapacity in interface Deployment.Pool

Returns:

the initial number of pool instances

getMaximumCapacity

public Integer getMaximumCapacity()

Description copied from interface: Deployment.Pool

The maximum-capacity element identifies the maximum number of managed connections which the openMDX Container will allow. Requests beyond this limit will result in an Exception being returned to the caller.

The default maximum capacity is java.lang.Integer.MAX_VALUE, i.e.2³¹-1.

Specified by:

getMaximumCapacity in interface Deployment.Pool

Returns:

the maximum number of pool instances that are allowed.

getMaximumWait

public Long getMaximumWait()

Description copied from interface: Deployment.Pool

The maximum-wait element defines the time in milliseconds to wait for an instance to be returned to the pool when there are maximum-capacity active instances.

A value of 0 will mean not to wait at all. When a request times out waiting for an instance an Exception is generated and the call aborted.

The default timeout value is java.lang.Long.MAX_VALUE, i.e. 2⁶³-1.

Specified by:

getMaximumWait in interface Deployment.Pool

Returns:

time in milliseconds to wait for an instance to be returned to the pool when there are maximum-capacity active instances

See Also:

Deployment.Pool.getMaximumCapacity()

deploy

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

Description copied from interface: Deployment.ResourceAdapter

This method deploys the resource adapter

Specified by:

deploy in interface Deployment.ResourceAdapter

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