Source for gnu.javax.net.ssl.SSLRecordHandler

   1: /* SSLRecordHandler.java -- a class that handles SSL record layer messages.
   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;
  40: 
  41: import java.nio.ByteBuffer;
  42: import javax.net.ssl.SSLException;
  43: 
  44: public abstract class SSLRecordHandler
  45: {
  46:   private final byte contentType;
  47: 
  48:   /**
  49:    * Create a new record handler for the given content type.
  50:    */
  51:   protected SSLRecordHandler (final byte contentType)
  52:   {
  53:     this.contentType = contentType;
  54:   }
  55: 
  56:   /**
  57:    * Handle an SSL record layer message, encapsulated in the supplied
  58:    * input buffer, and writing any output bytes to the output
  59:    * buffer. The input buffer is always only limited to the bytes that
  60:    * encapsulate the <em>fragment</em> of the record layer message
  61:    * &mdash; that is, the content-type, version, and length fields are
  62:    * not present in the input buffer, and the limit of the input
  63:    * buffer is always only as large as the fragment. If the message
  64:    * being read is not contained entirely within the given buffer,
  65:    * then the implementation should cache the bytes read as input, and
  66:    * wait until subsequent calls finish the object being read.
  67:    *
  68:    * <p>Technically, we expect only APPLICATION messages to ever
  69:    * produce output, but do suppose that extensions to the SSL
  70:    * protocol could allow other channels that produce output.
  71:    *
  72:    * @param input The input buffer.
  73:    * @param output The output buffer.
  74:    */
  75:   public abstract void handle (final ByteBuffer input,
  76:                                final ByteBuffer output)
  77:     throws SSLException;
  78: 
  79:   /**
  80:    * Returns the record layer content type that this handler is for.
  81:    *
  82:    * @return The content type value.
  83:    */
  84:   public final byte contentType ()
  85:   {
  86:     return contentType;
  87:   }
  88: 
  89:   public boolean equals (final Object o)
  90:   {
  91:     if (!(o instanceof SSLRecordHandler))
  92:       return false;
  93:     return ((SSLRecordHandler) o).contentType == contentType;
  94:   }
  95: 
  96:   public int hashCode ()
  97:   {
  98:     return contentType & 0xFF;
  99:   }
 100: }