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

java.lang.Object
  org.openmdx.kernel.application.deploy.enterprise.AbstractDeploymentDescriptor
      org.openmdx.kernel.application.deploy.enterprise.ComponentDeploymentDescriptor
          org.openmdx.kernel.application.deploy.enterprise.BeanDeploymentDescriptor

All Implemented Interfaces:

Configuration, Deployment.AssemblyDescriptor, Deployment.Bean, Deployment.Component, Deployment.Pool

Direct Known Subclasses:

MessageDrivenBeanDeploymentDescriptor, SessionBeanDeploymentDescriptor

public class BeanDeploymentDescriptor
extends ComponentDeploymentDescriptor
implements Deployment.Bean

BeanDeploymentDescriptor

Field Summary

protected List

containerTransaction

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

name, report

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

protected

BeanDeploymentDescriptor(ModuleDeploymentDescriptor owner, URL url, List containerTransaction)

Method Summary

void	deploy(Context containerContext, Context applicationContext, Reference localReference, Reference remoteReference) This method deploys the Bean
List	getContainerTransaction() The container-transaction element specifies how the container must manage transaction scopes for the enterprise bean's method invocations.
String	getEjbClass() The ejb-classType contains the fully-qualified name of the enterprise bean's class.
EjbLocalReferenceDeploymentDescriptor	getEjbLocalReferenceByName(String name)
Collection	getEjbLocalReferences()
EjbRemoteReferenceDeploymentDescriptor	getEjbRemoteReferenceByName(String name)
Collection	getEjbRemoteReferences()
Collection	getEnvironmentEntries()
Integer	getInitialCapacity() The initial-capacity element identifies the initial number of instance which the openMDX Container will attempt to obtain during deployment.
String	getJndiName() Retrieves the JNDI name that has been configured for this bean in the deployment descriptor.
String	getLocalJndiName() Retrieves the local JNDI name that has been configured for this bean in the deployment descriptor.
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.
ModuleDeploymentDescriptor	getOwner()
ResourceEnvReferenceDeploymentDescriptor	getResourceEnvReferenceByName(String name)
Collection	getResourceEnvReferences()
ResourceReferenceDeploymentDescriptor	getResourceReferenceByName(String name)
Collection	getResourceReferences()
void	parseOpenMdxXml(Element element, Report report)
void	parseXml(Element element, Report report)
void	populate(Context componentContext) This method populates the contexts.
void	verify(Report report)

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

getName, parseOpenMdxXml, parseXml, validate, verify

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

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

getName

Methods inherited from interface org.openmdx.kernel.application.configuration.Configuration

validate, verify

Field Detail

containerTransaction

protected List containerTransaction

Constructor Detail

BeanDeploymentDescriptor

protected BeanDeploymentDescriptor(ModuleDeploymentDescriptor owner,
                                   URL url,
                                   List containerTransaction)

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

verify

public void verify(Report report)

Overrides:

verify in class ComponentDeploymentDescriptor

populate

public void populate(Context componentContext)
              throws NamingException

Description copied from interface: Deployment.Component

This method populates the contexts.

Specified by:

populate in interface Deployment.Component

Specified by:

populate in class ComponentDeploymentDescriptor

Throws:

NamingException

deploy

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

Description copied from interface: Deployment.Bean

This method deploys the Bean

Specified by:

deploy in interface Deployment.Bean

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".

localReference - Reference to the EJB's local home

remoteReference - Reference to the EJB's home

Throws:

NamingException

getOwner

public ModuleDeploymentDescriptor getOwner()

getEjbClass

public String getEjbClass()

Description copied from interface: Deployment.Bean

The ejb-classType contains the fully-qualified name of the enterprise bean's class. It is used by ejb-class elements.

Example:

• com.wombat.empl.EmployeeServiceBean

Specified by:

getEjbClass in interface Deployment.Bean

Returns:

the EJB class name

getJndiName

public String getJndiName()

Description copied from interface: Deployment.Bean

Retrieves the JNDI name that has been configured for this bean in the deployment descriptor.

Specified by:

getJndiName in interface Deployment.Bean

Returns:

the JNDI name

getLocalJndiName

public String getLocalJndiName()

Description copied from interface: Deployment.Bean

Retrieves the local JNDI name that has been configured for this bean in the deployment descriptor.

Specified by:

getLocalJndiName in interface Deployment.Bean

Returns:

the local JNDI name

getEnvironmentEntries

public Collection getEnvironmentEntries()

getEjbRemoteReferences

public Collection getEjbRemoteReferences()

getEjbLocalReferences

public Collection getEjbLocalReferences()

getResourceReferences

public Collection getResourceReferences()

getResourceEnvReferences

public Collection getResourceEnvReferences()

getEjbRemoteReferenceByName

public EjbRemoteReferenceDeploymentDescriptor getEjbRemoteReferenceByName(String name)

getEjbLocalReferenceByName

public EjbLocalReferenceDeploymentDescriptor getEjbLocalReferenceByName(String name)

getResourceReferenceByName

public ResourceReferenceDeploymentDescriptor getResourceReferenceByName(String name)

getResourceEnvReferenceByName

public ResourceEnvReferenceDeploymentDescriptor getResourceEnvReferenceByName(String name)

getContainerTransaction

public List getContainerTransaction()

Description copied from interface: Deployment.AssemblyDescriptor

The container-transaction element specifies how the container must manage transaction scopes for the enterprise bean's method invocations. The element consists of an optional description, a list of method elements, and a transaction attribute. The transaction attribute is to be applied to all the specified methods.

Specified by:

getContainerTransaction in interface Deployment.AssemblyDescriptor

Returns:

the EJB's container transactions

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()