javax.resource.cci.ResourceAdapterMetaData Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
package javax.resource.cci;
import 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
* @version 0.8
* @since 0.8
* @see javax.resource.cci.ConnectionFactory
**/
public interface ResourceAdapterMetaData {
/** Gets the version of the resource adapter.
*
* @return String representing version of the resource adapter
**/
public
String getAdapterVersion();
/** Gets the name of the vendor that has provided the resource
* adapter.
*
* @return String representing name of the vendor that has
* provided the resource adapter
**/
public
String getAdapterVendorName();
/** Gets a tool displayable name of the resource adapter.
*
* @return String representing the name of the resource adapter
**/
public
String getAdapterName();
/** Gets a tool displayable short desription of the resource
* adapter.
*
* @return String describing the resource adapter
**/
public
String getAdapterShortDescription();
/** Returns a string representation of the version of the
* connector architecture specification that is supported by
* the resource adapter.
*
* @return String representing the supported version of
* the connector architecture
**/
public
String getSpecVersion();
/** 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.
*
* @return Array of fully-qualified class names of
* InteractionSpec classes supported by this
* resource adapter's CCI implementation
* @see javax.resource.cci.InteractionSpec
**/
public
String[] getInteractionSpecsSupported();
/** 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.
*
* @return boolean depending on method support
* @see javax.resource.cci.Interaction
**/
public
boolean supportsExecuteWithInputAndOutputRecord();
/** Returns true if the implementation class for the Interaction
* interface implements public Record execute(InteractionSpec
* ispec, Record input) method; otherwise the method returns
* false.
*
* @return boolean depending on method support
* @see javax.resource.cci.Interaction
**/
public
boolean supportsExecuteWithInputRecordOnly();
/** Returns true if the resource adapter implements the LocalTransaction
* interface and supports local transaction demarcation on the
* underlying EIS instance through the LocalTransaction interface.
*
* @return true if resource adapter supports resource manager
* local transaction demarcation through LocalTransaction
* interface; false otherwise
* @see javax.resource.cci.LocalTransaction
**/
public
boolean supportsLocalTransactionDemarcation();
}