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

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

All Implemented Interfaces:

Configuration, Deployment.Module

Direct Known Subclasses:

ApplicationClientDeploymentDescriptor, ConnectorDeploymentDescriptor

public class ModuleDeploymentDescriptor
extends AbstractDeploymentDescriptor
implements Deployment.Module

Field Summary

protected List	components
protected String	displayName
protected Report	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

	ModuleDeploymentDescriptor(String moduleId, ApplicationDeploymentDescriptor owner, URL url)
protected	ModuleDeploymentDescriptor(String moduleId, ApplicationDeploymentDescriptor owner, URL url, Report report)

Method Summary

URL[]	getApplicationClassPath() Retrieve the class path for classes referenced by the module, which should be loaded by the application's class loader, e.g.
BeanDeploymentDescriptor	getComponentByName(String name)
Collection	getComponents() Retrieve a module's components
String	getDisplayName() Retrieve a module's display name
URL[]	getModuleClassPath() Retrieve the module's class path, e.g.
String	getModuleURI() Retrieve a module's URI
ApplicationDeploymentDescriptor	getOwner()
void	parseOpenMdxXml(Element element)
void	parseOpenMdxXml(Element element, Report report)
void	parseXml(Element element)
void	parseXml(Element element, Report report)
void	setApplicationClassPath(URL[] applicationClassPath)
void	setModuleClassPath(URL[] moduleClassPath)
Report	validate() Validates the configuration.
Report	verify() Verifies the configuration.
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

Field Detail

report

protected final Report report

components

protected final List components

displayName

protected String displayName

Constructor Detail

ModuleDeploymentDescriptor

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

ModuleDeploymentDescriptor

protected ModuleDeploymentDescriptor(String moduleId,
                                     ApplicationDeploymentDescriptor owner,
                                     URL url,
                                     Report report)

Method Detail

parseXml

public void parseXml(Element element)

parseXml

public void parseXml(Element element,
                     Report report)

Specified by:

parseXml in class AbstractDeploymentDescriptor

parseOpenMdxXml

public void parseOpenMdxXml(Element element)

parseOpenMdxXml

public void parseOpenMdxXml(Element element,
                            Report report)

Specified by:

parseOpenMdxXml in class AbstractDeploymentDescriptor

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

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

Returns:

A validation report

See Also:

Configuration.verify()

verify

public void verify(Report report)

Overrides:

verify in class AbstractDeploymentDescriptor

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

Returns:

the module's local class path

setModuleClassPath

public void setModuleClassPath(URL[] moduleClassPath)

getApplicationClassPath

public URL[] getApplicationClassPath()

Description copied from interface: Deployment.Module

Retrieve the class path for classes referenced by the module, which should be loaded by the application's class loader, e.g. URLs based on the Classpath: entry in the META-INF/Manifest.mf file.

Specified by:

getApplicationClassPath in interface Deployment.Module

Returns:

the module's application class path

setApplicationClassPath

public void setApplicationClassPath(URL[] applicationClassPath)

getComponents

public Collection getComponents()

Description copied from interface: Deployment.Module

Retrieve a module's components

Specified by:

getComponents in interface Deployment.Module

Returns:

a module's components

getDisplayName

public String getDisplayName()

Description copied from interface: Deployment.Module

Retrieve a module's display name

Specified by:

getDisplayName in interface Deployment.Module

Returns:

a module's display name

getModuleURI

public String getModuleURI()

Description copied from interface: Deployment.Module

Retrieve a module's URI

Specified by:

getModuleURI in interface Deployment.Module

Returns:

the module URI

getComponentByName

public BeanDeploymentDescriptor getComponentByName(String name)

getOwner

public ApplicationDeploymentDescriptor getOwner()