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

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

All Implemented Interfaces:

Configuration, Deployment.Connector, Deployment.Module

public class ConnectorDeploymentDescriptor
extends ModuleDeploymentDescriptor
implements Deployment.Connector

Field Summary

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

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

ConnectorDeploymentDescriptor(String moduleId, ApplicationDeploymentDescriptor owner, URL url)

Method Summary

String	getEisType() The element eis-type contains information about the type of the EIS.
Boolean	getLicenseRequired() The licenseType specifies licensing requirements for the resource adapter module.
Deployment.ResourceAdapter	getResourceAdapter() Retrieve the connector's resource adapter
String	getResourceadapterVersion() The element resourceadapter-version specifies a string-based version of the resource adapter from the resource adapter provider.
String	getVendorName() The element vendor-name specifies the name of resource adapter provider vendor.
void	parseOpenMdxXml(Element element)
void	parseOpenMdxXml(Element element, Report report)
void	parseXml(Element element)
void	parseXml(Element element, Report report)
Report	verify() Verifies the configuration.
void	verify(Report report)

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

getApplicationClassPath, getComponentByName, getComponents, getDisplayName, getModuleClassPath, getModuleURI, getOwner, setApplicationClassPath, setModuleClassPath, validate

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, getDisplayName, getModuleClassPath, getModuleURI

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

validate

Constructor Detail

ConnectorDeploymentDescriptor

public ConnectorDeploymentDescriptor(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

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

verify

public void verify(Report report)

Overrides:

verify in class ModuleDeploymentDescriptor

getVendorName

public String getVendorName()

Description copied from interface: Deployment.Connector

The element vendor-name specifies the name of resource adapter provider vendor.

Specified by:

getVendorName in interface Deployment.Connector

Returns:

the vendor name

getEisType

public String getEisType()

Description copied from interface: Deployment.Connector

The element eis-type contains information about the type of the EIS. For example, the type of an EIS can be product name of EIS independent of any version info. This helps in identifying EIS instances that can be used with this resource adapter.

Specified by:

getEisType in interface Deployment.Connector

Returns:

the EIS type

getResourceadapterVersion

public String getResourceadapterVersion()

Description copied from interface: Deployment.Connector

The element resourceadapter-version specifies a string-based version of the resource adapter from the resource adapter provider.

Specified by:

getResourceadapterVersion in interface Deployment.Connector

Returns:

the resource adapter version

getLicenseRequired

public Boolean getLicenseRequired()

Description copied from interface: Deployment.Connector

The licenseType specifies licensing requirements for the resource adapter module. This type specifies whether a license is required to deploy and use this resource adapter, and an optional description of the licensing terms (examples: duration of license, number of connection restrictions). It is used by the license element.

The element license-required specifies whether a license is required to deploy and use the resource adapter.

Specified by:

getLicenseRequired in interface Deployment.Connector

Returns:

true if a license is required

getResourceAdapter

public Deployment.ResourceAdapter getResourceAdapter()

Description copied from interface: Deployment.Connector

Retrieve the connector's resource adapter

Specified by:

getResourceAdapter in interface Deployment.Connector

Returns:

the connector's resource adapter