libjava/classpath/gnu/javax/net/ssl/provider/RecordingInputStream.java

   1 /* RecordingInputStream.java -- Input stream that records data.
   2    Copyright (C) 2006  Free Software Foundation, Inc.
   3
   4 This file is a part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or (at
   9 your option) any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; if not, write to the Free Software
  18 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19 USA
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version.  */
  37
  38
  39 package gnu.javax.net.ssl.provider;
  40
  41 import java.io.ByteArrayOutputStream;
  42 import java.io.FilterInputStream;
  43 import java.io.InputStream;
  44 import java.io.IOException;
  45
  46 /**
  47  * A filter input stream that records every byte read from the underlying
  48  * input stream. This class is useful for protocols that require portions
  49  * of the communication to be saved, such as the handshake and key
  50  * derivation in SSL.
  51  *
  52  * @author Casey Marshall (rsdio@metastatic.org)
  53  */
  54 class RecordingInputStream extends FilterInputStream
  55 {
  56
  57   // Fields.
  58   // -------------------------------------------------------------------------
  59
  60   protected ByteArrayOutputStream sink;
  61
  62   // Constructors.
  63   // -------------------------------------------------------------------------
  64
  65   RecordingInputStream(InputStream in)
  66   {
  67     this(in, new ByteArrayOutputStream());
  68   }
  69
  70   RecordingInputStream(InputStream in, ByteArrayOutputStream sink)
  71   {
  72     super(in);
  73     this.sink = sink;
  74   }
  75
  76   // Instance methods.
  77   // -------------------------------------------------------------------------
  78
  79   public synchronized int read() throws IOException
  80   {
  81     int i = in.read();
  82     sink.write(i);
  83     return i;
  84   }
  85
  86   public synchronized int read(byte[] buf, int off, int len) throws IOException
  87   {
  88     int l = in.read(buf, off, len);
  89     sink.write(buf, off, l);
  90     return l;
  91   }
  92
  93   public synchronized int read(byte[] buf) throws IOException
  94   {
  95     return read(buf, 0, buf.length);
  96   }
  97
  98   public synchronized long skip(long len) throws IOException
  99   {
 100     long l = 0;
 101     int i = 0;
 102     byte[] buf = new byte[1024];
 103     while (l < len)
 104       {
 105         i = read(buf, 0, (int) Math.min((long) buf.length, len - l));
 106         if (i == -1)
 107           break;
 108         l += i;
 109       }
 110     return l;
 111   }
 112
 113   /**
 114    * Returns all bytes recorded after this instance was created, or the last
 115    * call to {@link resetSink()}.
 116    *
 117    * @return The recorded bytes.
 118    */
 119   byte[] getBytes()
 120   {
 121     return sink.toByteArray();
 122   }
 123
 124   /**
 125    * Clears the recording buffer off all previously-recorded bytes.
 126    */
 127   void resetSink()
 128   {
 129     sink.reset();
 130   }
 131 }