1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2000-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 may
9 * 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 mq/legal/LICENSE.txt. See the License for the specific language
12 * 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 mq/legal/LICENSE.txt. Sun designates
16 * this particular file as subject to the "Classpath" exception as provided by
17 * Sun in the GPL Version 2 section of the License file that accompanied this
18 * code. If applicable, add the following below the License Header, with the
19 * fields enclosed by brackets [] replaced by your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
21 *
22 * Contributor(s):
23 *
24 * If you wish your version of this file to be governed by only the CDDL or
25 * only the GPL Version 2, indicate your decision by adding "[Contributor]
26 * elects to include this software in this distribution under the [CDDL or GPL
27 * Version 2] license." If you don't indicate a single choice of license, a
28 * recipient has the option to distribute your version of this file under
29 * either the CDDL, the GPL Version 2 or to extend the choice of license to
30 * its licensees as provided above. However, if you add GPL Version 2 code
31 * and therefore, elected the GPL Version 2 license, then the option applies
32 * only if the new code is made subject to such option by the copyright holder.
33 */
34
35 /*
36 * @(#)Destination.java 1.18 07/02/07
37 */
38
39 package javax.jms;
40
41 /** A <CODE>Destination</CODE> object encapsulates a provider-specific
42 * address.
43 * The JMS API does not define a standard address syntax. Although a standard
44 * address syntax was considered, it was decided that the differences in
45 * address semantics between existing message-oriented middleware (MOM)
46 * products were too wide to bridge with a single syntax.
47 *
48 * <P>Since <CODE>Destination</CODE> is an administered object, it may
49 * contain
50 * provider-specific configuration information in addition to its address.
51 *
52 * <P>The JMS API also supports a client's use of provider-specific address
53 * names.
54 *
55 * <P><CODE>Destination</CODE> objects support concurrent use.
56 *
57 * <P>A <CODE>Destination</CODE> object is a JMS administered object.
58 *
59 * <P>JMS administered objects are objects containing configuration
60 * information that are created by an administrator and later used by
61 * JMS clients. They make it practical to administer the JMS API in the
62 * enterprise.
63 *
64 * <P>Although the interfaces for administered objects do not explicitly
65 * depend on the Java Naming and Directory Interface (JNDI) API, the JMS API
66 * establishes the convention that JMS clients find administered objects by
67 * looking them up in a JNDI namespace.
68 *
69 * <P>An administrator can place an administered object anywhere in a
70 * namespace. The JMS API does not define a naming policy.
71 *
72 * <P>It is expected that JMS providers will provide the tools an
73 * administrator needs to create and configure administered objects in a
74 * JNDI namespace. JMS provider implementations of administered objects
75 * should implement the <CODE>javax.naming.Referenceable</CODE> and
76 * <CODE>java.io.Serializable</CODE> interfaces so that they can be stored in
77 * all JNDI naming contexts. In addition, it is recommended that these
78 * implementations follow the JavaBeans<SUP><FONT SIZE="-2">TM</FONT></SUP>
79 * design patterns.
80 *
81 * <P>This strategy provides several benefits:
82 *
83 * <UL>
84 * <LI>It hides provider-specific details from JMS clients.
85 * <LI>It abstracts JMS administrative information into objects in the Java
86 * programming language ("Java objects")
87 * that are easily organized and administered from a common
88 * management console.
89 * <LI>Since there will be JNDI providers for all popular naming
90 * services, JMS providers can deliver one implementation
91 * of administered objects that will run everywhere.
92 * </UL>
93 *
94 * <P>An administered object should not hold on to any remote resources.
95 * Its lookup should not use remote resources other than those used by the
96 * JNDI API itself.
97 *
98 * <P>Clients should think of administered objects as local Java objects.
99 * Looking them up should not have any hidden side effects or use surprising
100 * amounts of local resources.
101 *
102 * @see javax.jms.Queue
103 * @see javax.jms.Topic
104 */
105
106 public interface Destination {
107 }