Top Description Methods
javax.resource.cci

public Interface ResourceAdapterMetaData

Imports
javax.resource.ResourceException

The interface javax.resource.cci.ResourceAdapterMetaData provides information about capabilities of a resource adapter implementation. Note that this interface does not provide information about an EIS instance that is connected through the resource adapter.

A CCI client uses a ConnectionFactory.getMetaData to get metadata information about the resource adapter. The getMetaData method does not require that an active connection to an EIS instance should have been established.

The ResourceAdapterMetaData can be extended to provide more information specific to a resource adapter implementation.

Author
Rahul Sharma
Since
0.8
Version
0.8
See Also
javax.resource.cci.ConnectionFactory

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

String representing the name of the resource adapter
getAdapterName
()

Gets a tool displayable name of the resource adapter.

public String

Returns:

String describing the resource adapter
getAdapterShortDescription
()

Gets a tool displayable short desription of the resource adapter.

public String

Returns:

String representing name of the vendor that has provided the resource adapter
getAdapterVendorName
()

Gets the name of the vendor that has provided the resource adapter.

public String

Returns:

String representing version of the resource adapter
getAdapterVersion
()

Gets the version of the resource adapter.

public String[]

Returns:

Array of fully-qualified class names of InteractionSpec classes supported by this resource adapter's CCI implementation
getInteractionSpecsSupported
()

Returns an array of fully-qualified names of InteractionSpec types supported by the CCI implementation for this resource adapter.

public String

Returns:

String representing the supported version of the connector architecture
getSpecVersion
()

Returns a string representation of the version of the connector architecture specification that is supported by the resource adapter.

public boolean

Returns:

boolean depending on method support
supportsExecuteWithInputAndOutputRecord
()

Returns true if the implementation class for the Interaction interface implements public boolean execute(InteractionSpec ispec, Record input, Record output) method; otherwise the method returns false.

public boolean

Returns:

boolean depending on method support
supportsExecuteWithInputRecordOnly
()

Returns true if the implementation class for the Interaction interface implements public Record execute(InteractionSpec ispec, Record input) method; otherwise the method returns false.

public boolean

Returns:

true if resource adapter supports resource manager local transaction demarcation through LocalTransaction interface; false otherwise
supportsLocalTransactionDemarcation
()

Returns true if the resource adapter implements the LocalTransaction interface and supports local transaction demarcation on the underlying EIS instance through the LocalTransaction interface.

Method Detail

getAdapterNameback to summary
public String getAdapterName()

Gets a tool displayable name of the resource adapter.

Returns:String

String representing the name of the resource adapter

getAdapterShortDescriptionback to summary
public String getAdapterShortDescription()

Gets a tool displayable short desription of the resource adapter.

Returns:String

String describing the resource adapter

getAdapterVendorNameback to summary
public String getAdapterVendorName()

Gets the name of the vendor that has provided the resource adapter.

Returns:String

String representing name of the vendor that has provided the resource adapter

getAdapterVersionback to summary
public String getAdapterVersion()

Gets the version of the resource adapter.

Returns:String

String representing version of the resource adapter

getInteractionSpecsSupportedback to summary
public String[] getInteractionSpecsSupported()

Returns an array of fully-qualified names of InteractionSpec types supported by the CCI implementation for this resource adapter. Note that the fully-qualified class name is for the implementation class of an InteractionSpec. This method may be used by tools vendor to find information on the supported InteractionSpec types. The method should return an array of length 0 if the CCI implementation does not define specific InteractionSpec types.

Returns:String[]

Array of fully-qualified class names of InteractionSpec classes supported by this resource adapter's CCI implementation

See Also
javax.resource.cci.InteractionSpec
getSpecVersionback to summary
public String getSpecVersion()

Returns a string representation of the version of the connector architecture specification that is supported by the resource adapter.

Returns:String

String representing the supported version of the connector architecture

supportsExecuteWithInputAndOutputRecordback to summary
public boolean supportsExecuteWithInputAndOutputRecord()

Returns true if the implementation class for the Interaction interface implements public boolean execute(InteractionSpec ispec, Record input, Record output) method; otherwise the method returns false.

Returns:boolean

boolean depending on method support

See Also
javax.resource.cci.Interaction
supportsExecuteWithInputRecordOnlyback to summary
public boolean supportsExecuteWithInputRecordOnly()

Returns true if the implementation class for the Interaction interface implements public Record execute(InteractionSpec ispec, Record input) method; otherwise the method returns false.

Returns:boolean

boolean depending on method support

See Also
javax.resource.cci.Interaction
supportsLocalTransactionDemarcationback to summary
public boolean supportsLocalTransactionDemarcation()

Returns true if the resource adapter implements the LocalTransaction interface and supports local transaction demarcation on the underlying EIS instance through the LocalTransaction interface.

Returns:boolean

true if resource adapter supports resource manager local transaction demarcation through LocalTransaction interface; false otherwise

See Also
javax.resource.cci.LocalTransaction