1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact tma@netspace.net.au.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2001-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: Administrator.java,v 1.2 2004/02/02 03:50:09 tanderson Exp $
44 */
45 package org.exolab.jmscts.provider;
46
47 import javax.jms.JMSException;
48 import javax.naming.NamingException;
49
50
51 /***
52 * This interface specifies methods for obtaining and manipulating
53 * administered objects managed by the JMS provider.<br/>
54 * Although the JMS specification states that administered objects should
55 * be accessible via JNDI, not all providers implement this, and for those
56 * that do, there is no standard registration scheme (eg. some use LDAP).<br>
57 * This interface therefore avoids making assumptions on how administered
58 * objects are accessed.
59 *
60 * @version $Revision: 1.2 $ $Date: 2004/02/02 03:50:09 $
61 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
62 * @see Provider
63 */
64 public interface Administrator {
65
66 /***
67 * Returns the name of the QueueConnectionFactory bound in JNDI
68 *
69 * @return the default QueueConnectionFactory name
70 */
71 String getQueueConnectionFactory();
72
73 /***
74 * Returns the name of the TopicConnectionFactory bound in JNDI
75 *
76 * @return the default TopicConnectionFactory name
77 */
78 String getTopicConnectionFactory();
79
80 /***
81 * Returns the name of the XAQueueConnectionFactory bound in JNDI
82 *
83 * @return the default XAQueueConnectionFactory name
84 */
85 String getXAQueueConnectionFactory();
86
87 /***
88 * Returns the name of the XATopicConnectionFactory bound in JNDI
89 *
90 * @return the default XATopicConnectionFactory name
91 */
92 String getXATopicConnectionFactory();
93
94 /***
95 * Look up the named administered object in JNDI
96 *
97 * @param name the name that the administered object is bound to
98 * @return the administered object bound to name
99 * @throws NamingException if the object is not bound, or the lookup fails
100 */
101 Object lookup(String name) throws NamingException;
102
103 /***
104 * Create an administered destination
105 *
106 * @param name the destination name
107 * @param queue if true, create a queue, else create a topic
108 * @throws JMSException if the destination cannot be created
109 */
110 void createDestination(String name, boolean queue) throws JMSException;
111
112 /***
113 * Destroy an administered destination
114 *
115 * @param name the destination name
116 * @throws JMSException if the destination cannot be destroyed
117 */
118 void destroyDestination(String name) throws JMSException;
119
120 /***
121 * Determines if an administered destination exists
122 *
123 * @param name the destination name
124 * @throws JMSException for any internal JMS provider error
125 * @return <code>true</code> if the destination exists
126 */
127 boolean destinationExists(String name) throws JMSException;
128
129 }
This page was automatically generated by Maven