Save This Page
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.endpoint;
38
39 import java.lang.NoSuchMethodException;
40 import javax.transaction.xa.XAResource;
41 import javax.resource.spi.UnavailableException;
42
43 /**
44 * This serves as a factory for creating message endpoints.
45 *
46 * @version 1.0
47 * @author Ram Jeyaraman
48 */
49 public interface MessageEndpointFactory {
50
51 /**
52 * This is used to create a message endpoint. The message endpoint is
53 * expected to implement the correct message listener type.
54 *
55 * @param xaResource an optional <code>XAResource</code>
56 * instance used to get transaction notifications when the message delivery
57 * is transacted.
58 *
59 * @return a message endpoint instance.
60 *
61 * @throws UnavailableException indicates a transient failure
62 * in creating a message endpoint. Subsequent attempts to create a message
63 * endpoint might succeed.
64 */
65 MessageEndpoint createEndpoint(XAResource xaResource)
66 throws UnavailableException;
67
68 /**
69 * This is used to find out whether message deliveries to a target method
70 * on a message listener interface that is implemented by a message
71 * endpoint will be transacted or not.
72 *
73 * The message endpoint may indicate its transacted delivery preferences
74 * (at a per method level) through its deployment descriptor. The message
75 * delivery preferences must not change during the lifetime of a
76 * message endpoint.
77 *
78 * @param method description of a target method. This information about
79 * the intended target method allows an application server to find out
80 * whether the target method call will be transacted or not.
81 *
82 * @throws NoSuchMethodException indicates that the specified method
83 * does not exist on the target endpoint.
84 *
85 * @return true, if message endpoint requires transacted message delivery.
86 */
87 boolean isDeliveryTransacted(java.lang.reflect.Method method)
88 throws NoSuchMethodException;
89 }
90
91
92