org.apache.directory.ldap.client.template

Class MemoryClearingBuffer

java.lang.Object

org.apache.directory.ldap.client.template.MemoryClearingBuffer

public final class MemoryClearingBuffer
extends Object

A buffer for storing sensitive information like passwords. It provides useful operations for characters such as character encoding/decoding, whitespace trimming, and lowercasing. It can be cleared out when operations are complete.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	computedBytes
private char[]	computedChars
private byte[]	originalBytes
private char[]	originalChars
private char[]	precomputedChars

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MemoryClearingBuffer(byte[] originalBytes, char[] originalChars, boolean trim, boolean lowerCase)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the buffer out, filling its cells with null.
byte[]	getBytes() Returns the byte[] used to create this buffer, or getComputedBytes() if created with a char[].
char[]	getChars() Returns the char[] used to create this buffer, or getComputedChars() if created with a byte[].
(package private) byte[]	getComputedBytes() Returns a UTF8 encoded byte[] representation of the char[] used to create this buffer.
private char[]	getComputedChars() Returns a UTF8 decoded char[] representation of the byte[] used to create this buffer.
static MemoryClearingBuffer	newInstance(byte[] bytes) Creates a new instance of MemoryClearingBuffer from a byte[].
static MemoryClearingBuffer	newInstance(char[] chars) Creates a new instance of MemoryClearingBuffer from a char[].
static MemoryClearingBuffer	newInstance(char[] chars, boolean trim, boolean lowerCase) Creates a new instance of MemoryClearingBuffer from a char[], optionally performing whitespace trimming and conversion to lower case.

Methods inherited from class java.lang.Object

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

Field Detail

computedBytes

private byte[] computedBytes

computedChars

private char[] computedChars

originalBytes

private byte[] originalBytes

originalChars

private char[] originalChars

precomputedChars

private char[] precomputedChars

Constructor Detail

MemoryClearingBuffer

private MemoryClearingBuffer(byte[] originalBytes,
                             char[] originalChars,
                             boolean trim,
                             boolean lowerCase)

Method Detail

newInstance

public static MemoryClearingBuffer newInstance(byte[] bytes)

Creates a new instance of MemoryClearingBuffer from a byte[].

Parameters:

bytes - A byte[]

Returns:

A buffer

newInstance

public static MemoryClearingBuffer newInstance(char[] chars)

Creates a new instance of MemoryClearingBuffer from a char[].

Parameters:

chars - A char[]

Returns:

A buffer

newInstance

public static MemoryClearingBuffer newInstance(char[] chars,
                                               boolean trim,
                                               boolean lowerCase)

Creates a new instance of MemoryClearingBuffer from a char[], optionally performing whitespace trimming and conversion to lower case.

Parameters:

chars - A char[]

trim - If true, whitespace will be trimmed off of both ends of the char[]

lowerCase - If true, the characters will be converted to lower case

Returns:

A buffer

clear

public void clear()

Clears the buffer out, filling its cells with null.

getComputedBytes

byte[] getComputedBytes()

Returns a UTF8 encoded byte[] representation of the char[] used to create this buffer.

Returns:

A byte[]

getComputedChars

private char[] getComputedChars()

Returns a UTF8 decoded char[] representation of the byte[] used to create this buffer.

Returns:

A char[]

getBytes

public byte[] getBytes()

Returns the byte[] used to create this buffer, or getComputedBytes() if created with a char[].

Returns:

A byte[]

getChars

public char[] getChars()

Returns the char[] used to create this buffer, or getComputedChars() if created with a byte[].

Returns:

A byte[]