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

Quick Search    Search Deep

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

java.lang.Object
  extended bygnu.javax.crypto.sasl.InputBuffer

public class InputBuffer
extends java.lang.Object

The implementation of an incoming SASL buffer.

The data elements this class caters for are described in [1].

References:

  1. Secure Remote Password Authentication Mechanism;
    draft-burdis-cat-srp-sasl-09,
    Keith Burdis and Raïf S. Naffah.


Field Summary
protected  java.io.ByteArrayInputStream in
          The internal buffer stream containing the buffer's contents.
protected  int length
          The length of the buffer, according to its header.
 
Constructor Summary
private InputBuffer()
          Trivial private constructor for use by the class method.
  InputBuffer(byte[] frame)
          Constructs a SASL buffer given the buffer's encoded form, including its header bytes.
 
Method Summary
 byte[] getEOS()
          Decodes a SASL EOS from the current buffer.
static InputBuffer getInstance(byte[] raw)
          Returns an instance of a SASL buffer given the buffer's encoded contents, excluding the buffer's header bytes.
static InputBuffer getInstance(byte[] raw, int offset, int len)
          Returns an instance of a SASL buffer given the buffer's encoded contents, excluding the buffer's header bytes.
 java.math.BigInteger getMPI()
          Decodes a SASL MPI from the current buffer.
 byte[] getOS()
          Decodes a SASL OS from the current buffer.
 long getScalar(int count)
          Decodes a SASL scalar quantity, count-octet long, from the current buffer.
 java.lang.String getText()
          Decodes a SASL Text from the current buffer.
 boolean hasMoreElements()
           
static int twoBytesToLength(byte[] b)
          Converts two octets into the number that they represent.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

in

protected java.io.ByteArrayInputStream in
The internal buffer stream containing the buffer's contents.


length

protected int length
The length of the buffer, according to its header.

Constructor Detail

InputBuffer

public InputBuffer(byte[] frame)
            throws SaslEncodingException

Constructs a SASL buffer given the buffer's encoded form, including its header bytes.


InputBuffer

private InputBuffer()
Trivial private constructor for use by the class method.

Method Detail

getInstance

public static InputBuffer getInstance(byte[] raw)

Returns an instance of a SASL buffer given the buffer's encoded contents, excluding the buffer's header bytes.

Calls the method with the same name and three arguments as: getInstance(raw, 0, raw.length).


getInstance

public static InputBuffer getInstance(byte[] raw,
                                      int offset,
                                      int len)

Returns an instance of a SASL buffer given the buffer's encoded contents, excluding the buffer's header bytes.


twoBytesToLength

public static int twoBytesToLength(byte[] b)
                            throws SaslEncodingException

Converts two octets into the number that they represent.


hasMoreElements

public boolean hasMoreElements()

getScalar

public long getScalar(int count)
               throws java.io.IOException

Decodes a SASL scalar quantity, count-octet long, from the current buffer.


getOS

public byte[] getOS()
             throws java.io.IOException

Decodes a SASL OS from the current buffer.


getEOS

public byte[] getEOS()
              throws java.io.IOException

Decodes a SASL EOS from the current buffer.


getMPI

public java.math.BigInteger getMPI()
                            throws java.io.IOException

Decodes a SASL MPI from the current buffer.


getText

public java.lang.String getText()
                         throws java.io.IOException

Decodes a SASL Text from the current buffer.