View Javadoc

1   /* (c) Copyright 2003 Caleigo AB, All rights reserved. 
2    * 
3    * This library is free software; you can redistribute it and/or
4    * modify it under the terms of the GNU Lesser General Public
5    * License as published by the Free Software Foundation; either
6    * version 2.1 of the License, or (at your option) any later version.
7    * 
8    * This library is distributed in the hope that it will be useful,
9    * but WITHOUT ANY WARRANTY; without even the implied warranty of
10   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11   * Lesser General Public License for more details.
12   * 
13   * You should have received a copy of the GNU Lesser General Public
14   * License along with this library; if not, write to the Free Software
15   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16   *  
17   */
18  
19  package org.caleigo.toolkit.tunnel;
20  
21  import java.io.*;
22  
23  /*** An ITunnelPacker packs and unpacks messages that are sent by an ITunnel.
24   *
25   * @author  Mattias Hagstrand
26   * @version 1.00
27   * 
28   *//* 
29   *
30   * WHEN        WHO               WHY & WHAT
31   * -----------------------------------------------------------------------------
32   * 2002-07-01  Mattias Hagstrand Creation
33   */
34  public interface ITunnelPacker
35  {
36      // Constants ---------------------------------------------------------------
37      
38      // Methods -----------------------------------------------------------------
39  
40      /***
41       * Creates and returns an InputStream that wrapps the provided InputStream.
42       * The returned InputStream can then be used to unpack messages. The returned
43       * InputStream must be stateless.
44       */
45      public InputStream createInputStream(InputStream in);
46      
47      /***
48       * Creates and returns an OutputStream that wrapps the provided OutputStream.
49       * The returned OutputStream can then be used to pack messages. The returned
50       * OutputStream must be stateless.
51       */
52      public OutputStream createOutputStream(OutputStream out);
53  }