jakarta.resource.cci.ResourceAdapterMetaData Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource.cci;
/** 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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.resource.cci.LocalTransaction
**/
public
boolean supportsLocalTransactionDemarcation();
}