gnu.javax.crypto.sasl

Class OutputBuffer


public class OutputBuffer
extends Object

The implementation of an outgoing 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.

Constructor Summary

OutputBuffer()
The basic constructor.

Method Summary

byte[]
encode()
Returns the encoded form of the current buffer including the 4-byte length header.
void
setEOS(byte[] b)
Encodes a SASL EOS to the current buffer.
void
setMPI(BigInteger val)
Encodes a SASL MPI to the current buffer.
void
setOS(byte[] b)
Encodes a SASL OS to the current buffer.
void
setScalar(int count, int b)
Encodes a SASL scalar quantity, count-octet long, to the current buffer.
void
setText(String str)
Encodes a SASL Text to the current buffer.
byte[]
wrap()
Returns the encoded form of the current buffer excluding the 4-byte length header.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OutputBuffer

public OutputBuffer()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

encode

public byte[] encode()
            throws SaslEncodingException
Returns the encoded form of the current buffer including the 4-byte length header.
Throws:
SaslEncodingException - if an encoding size constraint is violated.

setEOS

public void setEOS(byte[] b)
            throws IOException
Encodes a SASL EOS to the current buffer.
Parameters:
b - the EOS element.
Throws:
IOException - if any other I/O exception occurs during the operation.

setMPI

public void setMPI(BigInteger val)
            throws IOException
Encodes a SASL MPI to the current buffer.
Parameters:
val - the MPI element.
Throws:
IOException - if any other I/O exception occurs during the operation.

setOS

public void setOS(byte[] b)
            throws IOException
Encodes a SASL OS to the current buffer.
Parameters:
b - the OS element.
Throws:
IOException - if any other I/O exception occurs during the operation.

setScalar

public void setScalar(int count,
                      int b)
            throws IOException
Encodes a SASL scalar quantity, count-octet long, to the current buffer.
Parameters:
count - number of octets to encode b with.
b - the scalar quantity.
Throws:
IOException - if any other I/O exception occurs during the operation.

setText

public void setText(String str)
            throws IOException
Encodes a SASL Text to the current buffer.
Parameters:
str - the Text element.
Throws:
IOException - if any other I/O exception occurs during the operation.

wrap

public byte[] wrap()
            throws SaslEncodingException
Returns the encoded form of the current buffer excluding the 4-byte length header.
Throws:
SaslEncodingException - if an encoding size constraint is violated.

OutputBuffer.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.