ResourceAdapterMetaData


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  
24  package javax.resource.cci;
25  
26  import javax.resource.ResourceException  ;
27  
28  /** The interface <code>javax.resource.cci.ResourceAdapterMetaData</code> 
29   *  provides information about capabilities of a resource adapter 
30   *  implementation. Note that this interface does not provide information 
31   *  about an EIS instance that is connected through the resource adapter.
32   *
33   *  <p>A CCI client uses a <code>ConnectionFactory.getMetaData</code> to 
34   *  get metadata information about the resource adapter. The 
35   *  <code>getMetaData</code> method does not require that an active 
36   *  connection to an EIS instance should have been established.
37   *
38   *  <p>The ResourceAdapterMetaData can be extended to provide more 
39   *  information specific to a resource adapter implementation.
40   *  
41   *  @author  Rahul Sharma
42   *  @version 0.8
43   *  @since   0.8
44   *  @see     javax.resource.cci.ConnectionFactory
45  **/
46  
47  public interface ResourceAdapterMetaData {
48  
49    /** Gets the version of the resource adapter.
50     *
51     *  @return   String representing version of the resource adapter
52    **/
53    public 
54    String   getAdapterVersion();
55      
56    /** Gets the name of the vendor that has provided the resource 
57     *  adapter.
58     *
59     *  @return   String representing name of the vendor that has 
60     *            provided the resource adapter
61    **/
62    public 
63    String   getAdapterVendorName();
64    
65    /** Gets a tool displayable name of the resource adapter.
66     *
67     *  @return   String representing the name of the resource adapter
68    **/
69    public 
70    String   getAdapterName();
71      
72    /** Gets a tool displayable short desription of the resource
73     *  adapter.
74     *
75     *  @return   String describing the resource adapter
76    **/
77    public 
78    String   getAdapterShortDescription();
79  
80    /** Returns a string representation of the version of the 
81     *  connector architecture specification that is supported by
82     *  the resource adapter.
83     *
84     *  @return   String representing the supported version of 
85     *            the connector architecture
86    **/
87    public 
88    String   getSpecVersion();
89  
90    /** Returns an array of fully-qualified names of InteractionSpec
91     *  types supported by the CCI implementation for this resource
92     *  adapter. Note that the fully-qualified class name is for 
93     *  the implementation class of an InteractionSpec. This method 
94     *  may be used by tools vendor to find information on the 
95     *  supported InteractionSpec types. The method should return 
96     *  an array of length 0 if the CCI implementation does not 
97     *  define specific InteractionSpec types.
98     *
99     *  @return   Array of fully-qualified class names of
100    *            InteractionSpec classes supported by this
101    *            resource adapter's CCI implementation
102    *  @see      javax.resource.cci.InteractionSpec
103   **/
104   public 
105   String  [] getInteractionSpecsSupported();
106 
107 
108   /** Returns true if the implementation class for the Interaction 
109    *  interface implements public boolean execute(InteractionSpec 
110    *  ispec, Record input, Record output) method; otherwise the 
111    *  method returns false.
112    *
113    *  @return   boolean depending on method support
114    *  @see      javax.resource.cci.Interaction
115   **/
116   public 
117   boolean supportsExecuteWithInputAndOutputRecord();
118 
119 
120   /** Returns true if the implementation class for the Interaction
121    *  interface implements public Record execute(InteractionSpec
122    *  ispec, Record input) method; otherwise the method returns 
123    *  false.
124    *
125    *  @return   boolean depending on method support
126    *  @see      javax.resource.cci.Interaction
127   **/
128   public 
129   boolean supportsExecuteWithInputRecordOnly();
130 
131 
132   /** Returns true if the resource adapter implements the LocalTransaction
133    *  interface and supports local transaction demarcation on the 
134    *  underlying EIS instance through the LocalTransaction interface.
135    *
136    *  @return  true if resource adapter supports resource manager
137    *           local transaction demarcation through LocalTransaction
138    *           interface; false otherwise
139    *  @see     javax.resource.cci.LocalTransaction
140   **/
141   public
142   boolean supportsLocalTransactionDemarcation();
143 }
144
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags