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

java.lang.Object
  org.openmdx.kernel.application.deploy.enterprise.AbstractDeploymentDescriptor
      org.openmdx.kernel.application.deploy.enterprise.ModuleDeploymentDescriptor
          org.openmdx.kernel.application.deploy.enterprise.ApplicationClientDeploymentDescriptor

All Implemented Interfaces:

Configuration, Deployment.ApplicationClient, Deployment.Module

public class ApplicationClientDeploymentDescriptor
extends ModuleDeploymentDescriptor
implements Deployment.ApplicationClient

Field Summary

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

components, 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

ApplicationClientDeploymentDescriptor(String moduleId, ApplicationDeploymentDescriptor owner, URL url)

Method Summary

void	deploy(Context containerContext, Reference reference) This method deploys the resource adapter
String	getCallbackHandler() Retrieve the callback handler class name
String	getDisplayName() Retrieve a module's display name
EjbRemoteReferenceDeploymentDescriptor	getEjbRemoteReferenceByName(String name)
Collection	getEjbRemoteReferences()
Collection	getEnvironmentEntries()
String	getMainClass() Retrieve the main class defined in the META-INF/Manifest.mf file.
URL[]	getModuleClassPath() Retrieve the module's class path, e.g.
ResourceReferenceDeploymentDescriptor	getResourceReferenceByName(String name)
Collection	getResourceReferences()
void	parseOpenMdxXml(Element element)
void	parseOpenMdxXml(Element element, Report report)
void	parseXml(Element element)
void	parseXml(Element element, Report report)
void	populate(Context applicationClientContext, Map applicationClientEnvironment) This method populates the contexts.
void	setClientClassPath(URL[] clientClassPath)
void	setMainClass(String mainClass)
Report	validate() Validates the configuration.
Report	verify() Verifies the configuration.

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

getApplicationClassPath, getComponentByName, getComponents, getModuleURI, getOwner, setApplicationClassPath, setModuleClassPath, 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.Module

getApplicationClassPath, getComponents, getModuleURI

Constructor Detail

ApplicationClientDeploymentDescriptor

public ApplicationClientDeploymentDescriptor(String moduleId,
                                             ApplicationDeploymentDescriptor owner,
                                             URL url)

Method Detail

parseXml

public void parseXml(Element element)

Overrides:

parseXml in class ModuleDeploymentDescriptor

parseXml

public void parseXml(Element element,
                     Report report)

Overrides:

parseXml in class ModuleDeploymentDescriptor

parseOpenMdxXml

public void parseOpenMdxXml(Element element)

Overrides:

parseOpenMdxXml in class ModuleDeploymentDescriptor

parseOpenMdxXml

public void parseOpenMdxXml(Element element,
                            Report report)

Overrides:

parseOpenMdxXml in class ModuleDeploymentDescriptor

populate

public void populate(Context applicationClientContext,
                     Map applicationClientEnvironment)
              throws NamingException

Description copied from interface: Deployment.ApplicationClient

This method populates the contexts.

Specified by:

populate in interface Deployment.ApplicationClient

Throws:

NamingException

deploy

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

Description copied from interface: Deployment.ApplicationClient

This method deploys the resource adapter

Specified by:

deploy in interface Deployment.ApplicationClient

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

reference - Reference to the application clients provileged action wrapping its main method invocation

Throws:

NamingException

getDisplayName

public String getDisplayName()

Description copied from interface: Deployment.Module

Retrieve a module's display name

Specified by:

getDisplayName in interface Deployment.Module

Overrides:

getDisplayName in class ModuleDeploymentDescriptor

Returns:

a module's display name

getCallbackHandler

public String getCallbackHandler()

Description copied from interface: Deployment.ApplicationClient

Retrieve the callback handler class name

Specified by:

getCallbackHandler in interface Deployment.ApplicationClient

Returns:

callback handler class

getModuleClassPath

public URL[] getModuleClassPath()

Description copied from interface: Deployment.Module

Retrieve the module's class path, e.g. a collection containing

• the JAR's URL in case of an enterprise java bean
• the WAR's META-INF/classes directory and its META-INF/lib JARs in case of a web application

Specified by:

getModuleClassPath in interface Deployment.Module

Overrides:

getModuleClassPath in class ModuleDeploymentDescriptor

Returns:

the module's local class path

setClientClassPath

public void setClientClassPath(URL[] clientClassPath)

getMainClass

public String getMainClass()

Description copied from interface: Deployment.ApplicationClient

Retrieve the main class defined in the META-INF/Manifest.mf file.

Specified by:

getMainClass in interface Deployment.ApplicationClient

Returns:

main class

setMainClass

public void setMainClass(String mainClass)

verify

public Report verify()

Description copied from interface: Configuration

Verifies the configuration. All configuration entries are verified with the configuration entry descriptions. A verification requires that the configuration entry descriptions have been set.

The verification process verifies that:

• each entry has an entry description
• multi-valued entries do not have value holes
• the value cardinality is valid
• the value types are valid
• each entry from entry description list is present

Specified by:

verify in interface Configuration

Overrides:

verify in class ModuleDeploymentDescriptor

Returns:

A validation report

validate

public Report validate()

Description copied from interface: Configuration

Validates the configuration. A concrete configuration validates the configuration entries. Validation goes beyond simple verification:

• Detects missing entries and adds its defaults
• Rejects unsupported entries
• Checks the version and possibly upgrades the configuration to the most current version

To accomplish this the validator needs more information than is required for just a simple verification.

Specified by:

validate in interface Configuration

Overrides:

validate in class ModuleDeploymentDescriptor

Returns:

A validation report

See Also:

Configuration.verify()

getEnvironmentEntries

public Collection getEnvironmentEntries()

getEjbRemoteReferences

public Collection getEjbRemoteReferences()

getResourceReferences

public Collection getResourceReferences()

getEjbRemoteReferenceByName

public EjbRemoteReferenceDeploymentDescriptor getEjbRemoteReferenceByName(String name)

getResourceReferenceByName

public ResourceReferenceDeploymentDescriptor getResourceReferenceByName(String name)