ResourceAdapterAssociation


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.spi;
25  
26  import javax.resource.ResourceException  ;
27  
28  /**
29   * This interface specifies the methods to associate a 
30   * <code>ResourceAdapter</code> object with other objects that 
31   * implement this interface like 
32   * <code>ManagedConnectionFactory</code> and <code>ActivationSpec</code>.
33   *
34   * @version 1.0
35   * @author  Ram Jeyaraman
36   */
37  public interface ResourceAdapterAssociation {
38  
39      /**
40       * Get the associated <code>ResourceAdapter</code> object.
41       *
42       * @return the associated <code>ResourceAdapter</code> object.
43       */
44      ResourceAdapter   getResourceAdapter();
45  
46      /**
47       * Associate this object with a <code>ResourceAdapter</code> object. 
48       * Note, this method must be called exactly once. That is, the 
49       * association must not change during the lifetime of this object.
50       *
51       * @param ra <code>ResourceAdapter</code> object to be associated with.
52       *
53       * @throws ResourceException generic exception.
54       *
55       * @throws ResourceAdapterInternalException
56       *            resource adapter related error condition.
57       *
58       * @throws IllegalStateException indicates that this object is in an
59       * illegal state for the method invocation. For example, this occurs when
60       * this method is called more than once on the same object.
61       */
62      void setResourceAdapter(ResourceAdapter   ra) throws ResourceException  ;
63  }
64  
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags