View Javadoc

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 info@exolab.org.
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: AdminConnectionFactory.java,v 1.1 2004/11/26 01:50:38 tanderson Exp $
44   */
45  package org.exolab.jms.administration;
46  
47  import java.net.MalformedURLException;
48  
49  import javax.jms.JMSException;
50  
51  import org.exolab.jms.administration.net.JmsAdminConnectionImpl;
52  
53  
54  /***
55   * This class is a factory for creating {@link AdminConnection} instances.
56   *
57   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:50:38 $
58   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
59   * @author      <a href="mailto:knut@lerpold.no">Knut Lerpold</a>
60   * @see         JmsAdminServerIfc
61   */
62  public class AdminConnectionFactory {
63  
64      /***
65       * Attempt to establish an admin connection
66       *
67       * @param url the OpenJMS server URL
68       * @param username the admin user name
69       * @param password the admin user password
70       * @return an admin connection
71       * @throws JMSException if a connection cannot be established
72       * @throws MalformedURLException if <code>url</code> is invalid
73       */
74      private static AdminConnection getConnection(String url, String username,
75                                                   String password)
76          throws JMSException, MalformedURLException {
77          return new JmsAdminConnectionImpl(url, username, password);
78      }
79  
80      /***
81       * Create an unauthenticated admin connection, using the specified server
82       * URL
83       *
84       * @param url the OpenJMS server URL
85       * @return JmsAdminServerIfc the administration API
86       * @throws JMSException if a connection cannot be established
87       * @throws MalformedURLException if <code>url</code> is invalid
88       */
89      public static JmsAdminServerIfc create(String url)
90          throws JMSException, MalformedURLException {
91          return create(url, null, null);
92      }
93  
94      /***
95       * Create an authenticated admin connection, using the specified server
96       * URL, name, and password
97       *
98       * @param url the OpenJMS server URL
99       * @param username the admin user name
100      * @param password the admin user password
101      * @return JmsAdminServerIfc the administration API
102      * @throws JMSException if a connection cannot be established
103      */
104     public static JmsAdminServerIfc create(String url, String username,
105                                            String password)
106         throws JMSException, MalformedURLException {
107         return new JmsAdminConnectionImpl(url, username, password);
108     }
109 
110 }
111