org.eclipse.jst.j2ee.jca
Interface Connector

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject

public interface Connector
extends CompatibilityDescriptionGroup

The connector element is the root element of the deployment descriptor for the resource adapter. This element includes general information - vendor name, version, specification version supported, icon - about the resource adapter module. It also includes information specific to the implementation of the resource adapter library as specified through the element resourceadapter.

Since:
1.0

Method Summary
 java.lang.String getEisType()
           
 License getLicense()
           
 ResourceAdapter getResourceAdapter()
           
 java.lang.String getSpecVersion()
           
 java.lang.String getVendorName()
           
 java.lang.String getVersion()
          These values are used in the deployment descriptor, use getVersionID() to determine module versions
 int getVersionID()
          This returns the module version id.
 void setEisType(java.lang.String value)
           
 void setLicense(License value)
           
 void setResourceAdapter(ResourceAdapter value)
           
 void setSpecVersion(java.lang.String value)
           
 void setVendorName(java.lang.String value)
           
 void setVersion(java.lang.String value)
           
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 

Method Detail

getVersionID

public int getVersionID()
                 throws java.lang.IllegalStateException
This returns the module version id. Compare with J2EEVersionConstants to determine module level

Returns:
the version of the J2C module
Throws:
java.lang.IllegalStateException - if calling this function fails

getVendorName

public java.lang.String getVendorName()
Returns:
The value of the VendorName attribute Specifies the name of resource adapter provider vendor. Example: Wombat Corp.

setVendorName

public void setVendorName(java.lang.String value)
Parameters:
value - The new value of the VendorName attribute

getSpecVersion

public java.lang.String getSpecVersion()
Returns:
The value of the SpecVersion attribute Specifies the version of the connector architecture specification that is supported by this resource adapter. This information enables deployer to configure the resource adapter to support deployment and runtime requirements of the corresponding connector architecture specification.

setSpecVersion

public void setSpecVersion(java.lang.String value)
Parameters:
value - The new value of the SpecVersion attribute

getEisType

public java.lang.String getEisType()
Returns:
The value of the EisType attribute 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.

setEisType

public void setEisType(java.lang.String value)
Parameters:
value - The new value of the EisType attribute

getVersion

public java.lang.String getVersion()
These values are used in the deployment descriptor, use getVersionID() to determine module versions

Returns:
The value of the Version attribute Specifies a string-based version of the resource adapter from the resource adapter provider. Example: 1.0

setVersion

public void setVersion(java.lang.String value)
Parameters:
value - The new value of the Version attribute

getLicense

public License getLicense()
Returns:
The License reference Specifies licensing requirements for the resource adapter module. This element 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).

setLicense

public void setLicense(License value)
Parameters:
value - The new value of the License reference

getResourceAdapter

public ResourceAdapter getResourceAdapter()
Returns:
The ResourceAdapter reference

setResourceAdapter

public void setResourceAdapter(ResourceAdapter value)
Parameters:
value - The new value of the ResourceAdapter reference