org.apache.sshd.common.util.buffer

Class Buffer

java.lang.Object

org.apache.sshd.common.util.buffer.Buffer

All Implemented Interfaces:

Readable

Direct Known Subclasses:

ByteArrayBuffer

public abstract class Buffer
extends Object
implements Readable

Provides an abstract message buffer for encoding SSH messages

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	workBuf

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Buffer()

Method Summary

Modifier and Type	Method and Description
abstract byte[]	array()
abstract int	capacity()
abstract void	clear()
abstract void	compact()
void	ensureAvailable(int a)
protected void	ensureCapacity(int capacity)
abstract void	ensureCapacity(int capacity, Int2IntFunction growthFactor)
protected KeyPair	extractEC(String expectedCurveName, ECParameterSpec spec)
Collection<String>	getAvailableStrings()
Collection<String>	getAvailableStrings(Charset charset)
boolean	getBoolean()
byte	getByte()
byte[]	getBytes()
byte[]	getCompactData()
int	getInt()
KeyPair	getKeyPair()
long	getLong()
BigInteger	getMPInt()
byte[]	getMPIntAsBytes()
PublicKey	getPublicKey()
void	getRawBytes(byte[] buf)
protected PublicKey	getRawECKey(String expectedCurve, ECParameterSpec spec)
PublicKey	getRawPublicKey()
short	getShort()
String	getString()
abstract String	getString(Charset charset)
Collection<String>	getStringList(boolean usePrependedLength)
Collection<String>	getStringList(boolean usePrependedLength, Charset charset)
List<String>	getStringList(int count)
List<String>	getStringList(int count, Charset charset)
int	getUByte()
long	getUInt()
String	printHex()
void	putBoolean(boolean b)
void	putBuffer(Readable buffer)
abstract int	putBuffer(Readable buffer, boolean expand)
void	putByte(byte b)
void	putBytes(byte[] b)
void	putBytes(byte[] b, int off, int len)
void	putInt(long i) Writes 32 bits
void	putKeyPair(KeyPair kp)
void	putLong(long i) Writes 64 bits
void	putMPInt(BigInteger bi)
void	putMPInt(byte[] foo)
void	putPublicKey(PublicKey key)
void	putRawBytes(byte[] d)
abstract void	putRawBytes(byte[] d, int off, int len)
void	putRawPublicKey(PublicKey key)
void	putShort(int i) Writes 16 bits
void	putString(String string)
void	putString(String string, Charset charset)
void	putStringList(Collection<?> objects, boolean prependLength) Encodes the Transformer.TOSTRING value of each member.
void	putStringList(Collection<?> objects, Charset charset, boolean prependLength) Encodes the Transformer.TOSTRING value of each member
abstract int	rpos()
abstract void	rpos(int rpos)
protected abstract int	size()
String	toString()
abstract int	wpos()
abstract void	wpos(int wpos)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.util.Readable

available, getRawBytes

Field Detail

workBuf

protected final byte[] workBuf

Constructor Detail

Buffer

protected Buffer()

Method Detail

rpos

public abstract int rpos()

rpos

public abstract void rpos(int rpos)

wpos

public abstract int wpos()

wpos

public abstract void wpos(int wpos)

capacity

public abstract int capacity()

array

public abstract byte[] array()

compact

public abstract void compact()

getCompactData

public byte[] getCompactData()

clear

public abstract void clear()

printHex

public String printHex()

getUByte

public int getUByte()

getByte

public byte getByte()

getShort

public short getShort()

getInt

public int getInt()

getUInt

public long getUInt()

getLong

public long getLong()

getBoolean

public boolean getBoolean()

getString

public String getString()

getStringList

public Collection<String> getStringList(boolean usePrependedLength)

Parameters:

usePrependedLength - If true then there is a 32-bit value indicating the number of strings to read. Otherwise, the method will use a "greedy" reading of strings while more data available

Returns:

A Collection of the read strings

See Also:

getStringList(boolean, Charset)

getStringList

public Collection<String> getStringList(boolean usePrependedLength,
                                        Charset charset)

Parameters:

usePrependedLength - If true then there is a 32-bit value indicating the number of strings to read. Otherwise, the method will use a "greedy" reading of strings while more data available

charset - The Charset to use for the string

Returns:

A Collection of the read strings

See Also:

getStringList(int, Charset), getAvailableStrings()

getAvailableStrings

public Collection<String> getAvailableStrings()

Returns:

The remaining data as a list of strings

See Also:

getAvailableStrings(Charset)

getAvailableStrings

public Collection<String> getAvailableStrings(Charset charset)

Parameters:

charset - The Charset to use for the strings

Returns:

The remaining data as a list of strings

See Also:

Readable.available(), getString(Charset)

getStringList

public List<String> getStringList(int count)

Parameters:

count - The exact number of strings to read - can be zero

Returns:

A List with the specified number of strings

See Also:

getStringList(int, Charset)

getStringList

public List<String> getStringList(int count,
                                  Charset charset)

Parameters:

count - The exact number of strings to read - can be zero

charset - The Charset of the strings

Returns:

A List with the specified number of strings

See Also:

getString(Charset)

getString

public abstract String getString(Charset charset)

getMPInt

public BigInteger getMPInt()

getMPIntAsBytes

public byte[] getMPIntAsBytes()

getBytes

public byte[] getBytes()

getRawBytes

public void getRawBytes(byte[] buf)

getPublicKey

public PublicKey getPublicKey()
                       throws SshException

Throws:

SshException

getRawPublicKey

public PublicKey getRawPublicKey()
                          throws SshException

Throws:

SshException

getRawECKey

protected PublicKey getRawECKey(String expectedCurve,
                                ECParameterSpec spec)
                         throws GeneralSecurityException

Throws:

GeneralSecurityException

getKeyPair

public KeyPair getKeyPair()
                   throws SshException

Throws:

SshException

extractEC

protected KeyPair extractEC(String expectedCurveName,
                            ECParameterSpec spec)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

ensureAvailable

public void ensureAvailable(int a)
                     throws BufferException

Throws:

BufferException

putByte

public void putByte(byte b)

putBuffer

public void putBuffer(Readable buffer)

putBuffer

public abstract int putBuffer(Readable buffer,
                              boolean expand)

putShort

public void putShort(int i)

Writes 16 bits

Parameters:

i - The 16-bit value

putInt

public void putInt(long i)

Writes 32 bits

Parameters:

i - The 32-bit value

putLong

public void putLong(long i)

Writes 64 bits

Parameters:

i - The 64-bit value

putBoolean

public void putBoolean(boolean b)

putBytes

public void putBytes(byte[] b)

putBytes

public void putBytes(byte[] b,
                     int off,
                     int len)

putStringList

public void putStringList(Collection<?> objects,
                          boolean prependLength)

Encodes the Transformer.TOSTRING value of each member.

Parameters:

objects - The objects to be encoded in the buffer - OK if null/empty

prependLength - If true then the list is preceded by a 32-bit count of the number of members in the list

See Also:

putStringList(Collection, Charset, boolean)

putStringList

public void putStringList(Collection<?> objects,
                          Charset charset,
                          boolean prependLength)

Encodes the Transformer.TOSTRING value of each member

Parameters:

objects - The objects to be encoded in the buffer - OK if null/empty

charset - The Charset to use for encoding

prependLength - If true then the list is preceded by a 32-bit count of the number of members in the list

See Also:

putString(String, Charset)

putString

public void putString(String string)

putString

public void putString(String string,
                      Charset charset)

putMPInt

public void putMPInt(BigInteger bi)

putMPInt

public void putMPInt(byte[] foo)

putRawBytes

public void putRawBytes(byte[] d)

putRawBytes

public abstract void putRawBytes(byte[] d,
                                 int off,
                                 int len)

putPublicKey

public void putPublicKey(PublicKey key)

putRawPublicKey

public void putRawPublicKey(PublicKey key)

putKeyPair

public void putKeyPair(KeyPair kp)

ensureCapacity

protected void ensureCapacity(int capacity)

ensureCapacity

public abstract void ensureCapacity(int capacity,
                                    Int2IntFunction growthFactor)

Parameters:

capacity - The requires capacity

growthFactor - An Int2IntFunction that is invoked if the current capacity is insufficient. The argument is the minimum required new data length, the function result should be the effective new data length to be allocated - if less than minimum then an exception is thrown

size

protected abstract int size()

toString

public String toString()

Overrides:

toString in class Object