1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.resource.spi;
38
39 import javax.resource.ResourceException;
40
41 /**
42 * This interface specifies the methods to associate a
43 * <code>ResourceAdapter</code> object with other objects that
44 * implement this interface like
45 * <code>ManagedConnectionFactory</code> and <code>ActivationSpec</code>.
46 *
47 * @version 1.0
48 * @author Ram Jeyaraman
49 */
50 public interface ResourceAdapterAssociation {
51
52 /**
53 * Get the associated <code>ResourceAdapter</code> object.
54 *
55 * @return the associated <code>ResourceAdapter</code> object.
56 */
57 ResourceAdapter getResourceAdapter();
58
59 /**
60 * Associate this object with a <code>ResourceAdapter</code> object.
61 * Note, this method must be called exactly once. That is, the
62 * association must not change during the lifetime of this object.
63 *
64 * @param ra <code>ResourceAdapter</code> object to be associated with.
65 *
66 * @throws ResourceException generic exception.
67 *
68 * @throws ResourceAdapterInternalException
69 * resource adapter related error condition.
70 *
71 * @throws IllegalStateException indicates that this object is in an
72 * illegal state for the method invocation. For example, this occurs when
73 * this method is called more than once on the same object.
74 */
75 void setResourceAdapter(ResourceAdapter ra) throws ResourceException;
76 }
77
Save This Page