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 2000-2001,2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: HttpJmsAdminConnection.java,v 1.10 2003/08/18 10:16:12 tanderson Exp $
44 *
45 * Date Author Changes
46 * $Date jimm Created
47 */
48 package org.exolab.jms.administration.http;
49
50
51 import javax.jms.JMSException;
52
53 import org.apache.commons.logging.Log;
54 import org.apache.commons.logging.LogFactory;
55
56 import org.exolab.core.http.HttpClient;
57 import org.exolab.jms.administration.mipc.IpcJmsAdminConnection;
58
59
60 /***
61 * This class is repsonsible for opening an http connection to the server
62 * and passing and packing all requests for delivery.
63 *
64 * @version $Revision: 1.10 $ $Date: 2003/08/18 10:16:12 $
65 * @author <a href="mailto:mourikis@exolab.org">Jim Mourikis</a>
66 * @see org.exolab.core.http.HttpClient
67 */
68 public class HttpJmsAdminConnection extends IpcJmsAdminConnection {
69
70 /***
71 * The admin servlet path
72 */
73 private String _path;
74
75 /***
76 * The logger
77 */
78 private static final Log _log = LogFactory.getLog(
79 HttpJmsAdminConnection.class);
80
81
82 /***
83 * Create the connection to the server
84 *
85 * @param host the webserver host
86 * @param port the webserver port
87 * @param path the admin servlet path. May be null
88 * @param username the admin user name
89 * @param password the admin password
90 * @throws JMSException if a connection cannot be established
91 */
92 public HttpJmsAdminConnection(String host, int port, String path,
93 String username, String password)
94 throws JMSException {
95 super(host, port);
96
97 _path = path;
98 if (_path == null) {
99 _path = "/openjms/OpenJMSServer";
100 } else if (!_path.startsWith("/")) {
101 _path = "/" + _path;
102 }
103 connect(username, password);
104 }
105
106
107 public void close() {
108 if (getConnection() != null) {
109 try {
110 getConnection().close();
111 } catch (Exception exception) {
112 _log.debug("Exception during close", exception);
113 }
114 setConnection(null);
115 }
116 }
117
118 /***
119 * Create HTTP client connection.
120 *
121 * @param host The client to connect to
122 * @param port The port used to connect to the client above
123 * @throws JMSException If the connection fails.
124 */
125 protected void openConnection() throws JMSException {
126 try {
127 String url = getURL("http", getHost(), getPort());
128 setConnection(new HttpClient(url, "HttpJmsAdminConnection"));
129 } catch (Exception exception) {
130 throw new JMSException(exception.getMessage());
131 }
132 }
133
134 /***
135 * Returns the admin servlet path
136 *
137 * @return the admin servlet path
138 */
139 protected String getPath() {
140 return _path;
141 }
142
143 /***
144 * Returns the admin servlet URL
145 *
146 * @param scheme the connection protocol
147 * @param host the webserver host
148 * @param port the webserver port
149 * @return the admin servlet URL
150 */
151 protected String getURL(String scheme, String host, int port) {
152 return scheme + "://" + host + ":" + port + getPath();
153 }
154
155 }