Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

gnu.javax.crypto.sasl
Class SaslInputStream  view SaslInputStream download SaslInputStream.java

java.lang.Object
  extended byjava.io.InputStream
      extended bygnu.javax.crypto.sasl.SaslInputStream
All Implemented Interfaces:
java.io.Closeable

public class SaslInputStream
extends java.io.InputStream

An input stream that uses either a javax.security.sasl.SaslClient or a javax.security.sasl.SaslServer to process the data through these entities' security layer filter(s).


Field Summary
private  javax.security.sasl.SaslClient client
           
private static boolean DEBUG
           
private static int debuglevel
           
private static java.io.PrintWriter err
           
private static java.lang.String ERROR
           
private  byte[] internalBuf
           
private  int maxRawSendSize
           
private static java.lang.String NAME
           
private  javax.security.sasl.SaslServer server
           
private  java.io.InputStream source
           
private static java.lang.String TRACE
           
private static java.lang.String WARN
           
 
Constructor Summary
SaslInputStream(javax.security.sasl.SaslClient client, java.io.InputStream source)
           
SaslInputStream(javax.security.sasl.SaslServer server, java.io.InputStream source)
           
 
Method Summary
 int available()
          This method returns the number of bytes that can be read from this stream before a read can block.
 void close()
          This method closes the stream.
private static void debug(java.lang.String level, java.lang.Object obj)
           
 int read()
          Reads the next byte of data from the input stream.
 int read(byte[] b, int off, int len)
          Reads up to len bytes of data from the underlying source input stream into an array of bytes.
private  byte[] readSaslBuffer()
          Reads a SASL buffer from the underlying source if at least 4 bytes are available.
 
Methods inherited from class java.io.InputStream
mark, markSupported, read, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

private static final java.lang.String NAME
See Also:
Constant Field Values

ERROR

private static final java.lang.String ERROR
See Also:
Constant Field Values

WARN

private static final java.lang.String WARN
See Also:
Constant Field Values

TRACE

private static final java.lang.String TRACE
See Also:
Constant Field Values

DEBUG

private static final boolean DEBUG
See Also:
Constant Field Values

debuglevel

private static final int debuglevel
See Also:
Constant Field Values

err

private static final java.io.PrintWriter err

client

private javax.security.sasl.SaslClient client

server

private javax.security.sasl.SaslServer server

maxRawSendSize

private int maxRawSendSize

source

private java.io.InputStream source

internalBuf

private byte[] internalBuf
Constructor Detail

SaslInputStream

public SaslInputStream(javax.security.sasl.SaslClient client,
                       java.io.InputStream source)
                throws java.io.IOException

SaslInputStream

public SaslInputStream(javax.security.sasl.SaslServer server,
                       java.io.InputStream source)
                throws java.io.IOException
Method Detail

debug

private static void debug(java.lang.String level,
                          java.lang.Object obj)

available

public int available()
              throws java.io.IOException
Description copied from class: java.io.InputStream
This method returns the number of bytes that can be read from this stream before a read can block. A return of 0 indicates that blocking might (or might not) occur on the very next read attempt.

This method always returns 0 in this class


close

public void close()
           throws java.io.IOException
Description copied from class: java.io.InputStream
This method closes the stream. Any futher attempts to read from the stream may generate an IOException

This method does nothing in this class, but subclasses may override this method in order to provide additional functionality.


read

public int read()
         throws java.io.IOException

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

From a SASL mechanism provider's perspective, if a security layer has been negotiated, the underlying source is expected to contain SASL buffers, as defined in RFC 2222. Four octets in network byte order in the front of each buffer identify the length of the buffer. The provider is responsible for performing any integrity checking or other processing on the buffer before returning the data as a stream of octets. For example, the protocol driver's request for a single octet from the stream might; i.e. an invocation of this method, may result in an entire SASL buffer being read and processed before that single octet can be returned.


read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Reads up to len bytes of data from the underlying source input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If b is null, a java.lang.NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an java.lang.IndexOutOfBoundsException is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

If the first byte cannot be read for any reason other than end of file, then an java.io.IOException is thrown. In particular, an java.io.IOException is thrown if the input stream has been closed.

From the SASL mechanism provider's perspective, if a security layer has been negotiated, the underlying source is expected to contain SASL buffers, as defined in RFC 2222. Four octets in network byte order in the front of each buffer identify the length of the buffer. The provider is responsible for performing any integrity checking or other processing on the buffer before returning the data as a stream of octets. The protocol driver's request for a single octet from the stream might result in an entire SASL buffer being read and processed before that single octet can be returned.


readSaslBuffer

private byte[] readSaslBuffer()
                       throws java.io.IOException
Reads a SASL buffer from the underlying source if at least 4 bytes are available.