Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.buffer.Buffer

Modifier and Type	Field and Description
protected final byte[]	workBuf

Access	Constructor and Description
protected	Buffer()

Method Summary

Modifier and Type	Method and Description
public abstract byte[]	Returns: The raw underlying data bytes array()
public abstract int	Returns: Number of bytes that can still be written without re-sizing the internal buffer capacity()
public Buffer	Returns: Reference to this buffer clear() Reset read/write positions to zero - Note: zeroes any previously existing data
public abstract Buffer	Returns: Reference to this buffer clear(boolean Whether to zero any previously existing data wipeData) Reset read/write positions to zero
public abstract void	compact() "Shift" the internal data so that reading starts from position zero.
protected abstract void	copyRawBytes(int offset, byte[] buf, int pos, int len)
public void	dumpHex(SimplifiedLog logger, String prefix, PropertyResolver resolver)
public void	dumpHex(SimplifiedLog logger, Level level, String prefix, PropertyResolver resolver)
public int	Returns: Same as input if validation successful ensureAvailable(int Requested data in bytes reqLen) Makes sure the buffer contains enough data to accommodate the requested length
public Buffer	ensureCapacity(int capacity)
public abstract Buffer	Returns: This buffer instance ensureCapacity(int The required capacity capacity, IntUnaryOperator An `IntUnaryOperator` 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 growthFactor)
protected KeyPair	extractEC(String expectedCurveName, ECParameterSpec spec)
public Collection<String>	Returns: The remaining data as a list of strings getAvailableStrings()
public Collection<String>	Returns: The remaining data as a list of strings getAvailableStrings(Charset The `Charset` to use for the strings charset)
public boolean	getBoolean()
public byte	getByte()
public byte[]	getBytes()
public abstract byte[]	Returns: The bytes consumed so far getBytesConsumed()
public abstract byte[]	Returns: The bytes consumed since the given position getBytesConsumed(int from)
public List<OpenSshCertificate.CertificateOption>	getCertificateOptions()
public List<OpenSshCertificate.CertificateOption>	Returns: the parsed result, never `null`, but possibly empty getCertificateOptions(Charset `Charset` to use for converting bytes to characters charset) According to PROTOCOL.certkeys: Critical Options is a set of bytes that is [overall length][name(string)][[length of buffer][[length of string][data(string)]]]...
public byte[]	getCompactData()
public int	getInt()
public KeyPair	getKeyPair()
public long	getLong()
public BigInteger	getMPInt()
public byte[]	getMPIntAsBytes()
public List<String>	Returns: The parsed result getNameList() According to RFC 4251: A name-list is represented as a uint32 containing its length (number of bytes that follow) followed by a comma-separated list of zero or more names.
public List<String>	getNameList(Charset charset)
public List<String>	getNameList(char separator)
public List<String>	Returns: A `List` of the parsed values getNameList(Charset The `Charset` to use to read the string charset, char The separator separator) Parses a string that contains values separated by a delimiter
public PublicKey	getPublicKey()
public PublicKey	Returns: The extracted `PublicKey` - may be `null` if the parser so decided getPublicKey(BufferPublicKeyParser<? extends PublicKey> A `BufferPublicKeyParser` to extract the key from the buffer - never `null` parser)
public void	getRawBytes(byte[] buf)
public PublicKey	getRawPublicKey()
public PublicKey	Returns: The extracted `PublicKey` - may be `null` if the parser so decided getRawPublicKey(BufferPublicKeyParser<? extends PublicKey> A `BufferPublicKeyParser` to extract the key from the buffer - never `null` parser)
public short	getShort()
public String	Returns: Reads a UTF-8 encoded string getString()
public abstract String	Returns: The read string getString(Charset The `Charset` to use for the string bytes charset) Reads a string using a given charset.
public Collection<String>	Returns: A `Collection` of the read strings getStringList(boolean 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. usePrependedLength)
public Collection<String>	Returns: A `Collection` of the read strings getStringList(boolean 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. usePrependedLength, Charset The `Charset` to use for the strings charset)
public List<String>	Returns: A `List` with the specified number of strings getStringList(int The exact number of strings to read - can be zero count)
public List<String>	Returns: A `List` with the specified number of strings getStringList(int The exact number of strings to read - can be zero count, Charset The `Charset` of the strings charset)
public int	getUByte()
public long	getUInt()
public int	getUShort()
private static boolean	isSensitiveData(int cmd)
public boolean	isValidMessageStructure(Class<?>... fieldTypes)
public boolean	isValidMessageStructure(Collection<Class<?>> fieldTypes)
public void	putAndWipeBytes(byte[] The buffer to add - OK if `null` b) Adds the bytes to the buffer and wipes the data from the input buffer after having added it - useful for sensitive information such as password
public void	putAndWipeBytes(byte[] b, int off, int len)
public void	putAndWipeChars(char[] The characters to put in the buffer - may be `null`/empty chars) Zeroes the input array after having put the characters in the buffer - useful for sensitive information such as passwords
public void	putAndWipeChars(char[] chars, int offset, int len)
public void	putAndWipeChars(char[] chars, Charset charset)
public void	putAndWipeChars(char[] chars, int offset, int len, Charset charset)
public void	putBoolean(boolean b)
public void	putBuffer(Readable buffer)
public abstract int	putBuffer(Readable buffer, boolean expand)
public abstract void	putBuffer(ByteBuffer buffer)
public void	putBufferedData(Object The (never `null`) buffer object to put buffer) Checks if the `buffer` argument is an array of bytes, a `Readable` instance or a `ByteBuffer` and invokes the appropriate `putXXX` method.
public void	putByte(byte b)
public void	putBytes(byte[] b)
public void	putBytes(byte[] b, int off, int len)
public void	putCertificateOptions(List<OpenSshCertificate.CertificateOption> options)
public void	putCertificateOptions(List<OpenSshCertificate.CertificateOption> to write into the buffer, may be `null` or empty but must not contain `null` elements options, Charset The `Charset` to use for string options charset) According to PROTOCOL.certkeys: Certificate Options is a set of bytes that is [overall length][name(string)][[length of buffer][[length of string][data(string)]]]...
public void	putChars(char[] chars)
public void	putChars(char[] chars, int offset, int len)
public void	putChars(char[] chars, Charset charset)
public void	putChars(char[] chars, int offset, int len, Charset charset)
public void	putInt(long i)
public void	putKeyPair(KeyPair kp)
public void	putLong(long The 64-bit value i) Writes 64 bits
public void	putMPInt(BigInteger bigint)
public void	putMPInt(byte[] mpInt)
public void	putNameList(Collection<String> The name list to put names) According to RFC 4251: `A name-list is represented as a uint32 containing its length (number of bytes that follow) followed by a comma-separated list of zero or more names.`
public void	putNameList(Collection<String> names, Charset charset)
public void	putNameList(Collection<String> names, char separator)
public void	putNameList(Collection<String> The names to set names, Charset The `Charset` to use to encode the string charset, char The separator separator) Adds a string that contains values separated by a delimiter
public void	putOptionalBufferedData(Object The buffered data object to inspect buffer) Checks if the `buffer` argument is an array of bytes, a `Readable` instance or a `ByteBuffer` and invokes the appropriate `putXXX` method.
public void	putPublicKey(PublicKey key)
public void	putRawBytes(byte[] d)
public abstract void	putRawBytes(byte[] d, int off, int len)
public void	putRawPublicKey(PublicKey key)
public void	putRawPublicKeyBytes(PublicKey key)
public void	putShort(int The 16-bit value i) Writes 16 bits
public void	putString(String string)
public void	putString(String string, Charset charset)
public void	putStringList(Collection<?> The objects to be encoded in the buffer - OK if `null`/empty objects, boolean If `true` then the list is preceded by a 32-bit count of the number of members in the list prependLength) Encodes the `toString` value of each member.
public void	putStringList(Collection<?> The objects to be encoded in the buffer - OK if `null`/empty objects, Charset The `Charset` to use for encoding charset, boolean If `true` then the list is preceded by a 32-bit count of the number of members in the list prependLength) Encodes the `toString` value of each member
public void	putUInt(long The 32-bit value i) Writes 32 bits
public byte	Returns: The byte at the specified position without changing the current `read position` Note no validation is made whether the position lies within array boundaries rawByte(int A position in the raw underlying data bytes pos)
public long	Returns: The unsigned 32 bit integer at the specified position without changing the current `read position` Note no validation is made whether the position and the required extra 4 bytes lie within array boundaries rawUInt(int A position in the raw underlying data bytes pos)
public abstract int	Returns: Current reading position rpos()
public abstract void	rpos(int Set current reading position rpos)
protected abstract int	Returns: Current size of underlying backing data bytes array size()
public String	toHex()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public abstract int	Returns: Current writing position wpos()
public abstract void	wpos(int Set current writing position - Note: if necessary, the underlying data buffer will be increased so as to allow writing from the new position wpos)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

public abstract Class Buffer

Field Summary

Constructor Summary

Method Summary