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 2004-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: HTTPMultiplexer.java,v 1.4 2005/07/22 23:40:36 tanderson Exp $
44   */
45  package org.exolab.jms.net.http;
46  
47  import java.io.DataInputStream;
48  import java.io.DataOutputStream;
49  import java.io.IOException;
50  import java.security.Principal;
51  
52  import org.exolab.jms.net.connector.Authenticator;
53  import org.exolab.jms.net.connector.ResourceException;
54  import org.exolab.jms.net.connector.SecurityException;
55  import org.exolab.jms.net.multiplexer.Endpoint;
56  import org.exolab.jms.net.multiplexer.Multiplexer;
57  import org.exolab.jms.net.multiplexer.MultiplexerListener;
58  import org.exolab.jms.net.uri.URI;
59  import org.exolab.jms.net.uri.URIHelper;
60  
61  
62  /***
63   * Multiplexes data over an HTTP connection.
64   *
65   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
66   * @version $Revision: 1.4 $ $Date: 2005/07/22 23:40:36 $
67   */
68  class HTTPMultiplexer extends Multiplexer {
69  
70      /***
71       * The client URI.
72       */
73      private URI _clientURI;
74  
75  
76      /***
77       * Construct a new client-side <code>HTTPMultiplexer</code>.
78       *
79       * @param listener  the multiplexer listener
80       * @param endpoint  the endpoint to multiplex messages over
81       * @param clientURI the local address that the connection is bound to
82       * @param principal the security principal
83       * @throws IOException       if an I/O error occurs
84       * @throws SecurityException if connection is refused by the server
85       */
86      public HTTPMultiplexer(MultiplexerListener listener, Endpoint endpoint,
87                             URI clientURI, Principal principal)
88              throws IOException, SecurityException {
89          if (clientURI == null) {
90              throw new IllegalArgumentException("Argument 'clientURI' is null");
91          }
92          _clientURI = clientURI;
93          initialise(listener, endpoint, true);
94          authenticate(principal);
95      }
96  
97      /***
98       * Construct a new server-side <code>HTTPMultiplexer</code>.
99       *
100      * @param listener      the multiplexer listener
101      * @param endpoint      the endpoint to multiplex messages over
102      * @param authenticator the connection authetnicator
103      * @throws IOException       if an I/O error occurs
104      * @throws ResourceException if the authenticator cannot authenticate
105      */
106     public HTTPMultiplexer(MultiplexerListener listener, Endpoint endpoint,
107                            Authenticator authenticator)
108             throws IOException, ResourceException {
109         super(listener, endpoint, authenticator);
110     }
111 
112     /***
113      * Returns the client URI.
114      *
115      * @return the client URI
116      */
117     public URI getClientURI() {
118         return _clientURI;
119     }
120 
121     /***
122      * Perform handshaking on initial connection, to verify protocol, and
123      * establish the client URI.
124      *
125      * @param out the endpoint's output stream
126      * @param in  the endpoint's input stream
127      * @throws IOException for any I/O error
128      */
129     protected void handshake(DataOutputStream out, DataInputStream in)
130             throws IOException {
131         super.handshake(out, in);
132         if (isClient()) {
133             out.writeUTF(_clientURI.toString());
134         } else {
135             String uri = in.readUTF();
136             _clientURI = URIHelper.parse(uri);
137         }
138     }
139 
140 }