Endpoint


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 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: Endpoint.java,v 1.1 2004/11/26 01:51:04 tanderson Exp $
44   */
45  package org.exolab.jms.net.multiplexer;
46  
47  import java.io.IOException  ;
48  import java.io.InputStream  ;
49  import java.io.OutputStream  ;
50  
51  import org.exolab.jms.net.uri.URI;
52  
53  
54  /**
55   * Communications endpoint
56   *
57   * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
58   * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:04 $
59   */
60  public interface Endpoint {
61  
62      /**
63       * Returns the URI that the endpoint is connected to
64       *
65       * @return the URI that the endpoint is connected to
66       */
67      URI getURI();
68  
69      /**
70       * Returns an input stream that reads from this endpoint
71       *
72       * @return an input stream that reads from this endpoint
73       * @throws IOException if an I/O error occurs while creating the input
74       *                     stream.
75       */
76      InputStream   getInputStream() throws IOException  ;
77  
78      /**
79       * Returns an output stream that writes to this endpoint
80       *
81       * @return an output stream that writes to this endpoint
82       * @throws IOException if an I/O error occurs while creating the output
83       *                     stream.
84       */
85      OutputStream   getOutputStream() throws IOException  ;
86  
87      /**
88       * Closes the endpoint
89       *
90       * @throws IOException if an I/O error occurs while closing the endpoint
91       */
92      void close() throws IOException  ;
93  }
94
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags