com.vmware.vapi.data

Class SecretValue

java.lang.Object

com.vmware.vapi.data.SecretValue

All Implemented Interfaces:

DataValue, Serializable

public final class SecretValue
extends Object
implements DataValue

Value of type secret, which is intended to represent sensitive information, like passwords.

The content of the value is stored in a char[] which allows for cleaning the value from memory when it is no longer needed, this can be done via clear().

In addition the actual content will not be returned by the toString() as a precaution for avoiding accidental displaying or logging it.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	STRING_REPRESENTATION Constant returned by the toString() method of SecretValue.

Constructor Summary

Constructors

Constructor and Description
SecretValue(char[] value) Create a value with the specified char array content.

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor visitor)
void	clear() Clear the content inside SecretValue
SecretValue	copy()
boolean	equals(Object o)
DataType	getType()
char[]	getValue() Returns the underlying char array content.
int	hashCode()
String	toString() Always returns "<secret>" - Safety precaution for the case when someone uses the toString directly on SecretValue object or on a StructValue that contains a secret and for instance logs the result.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STRING_REPRESENTATION

public static final String STRING_REPRESENTATION

Constant returned by the toString() method of SecretValue.

See Also:

Constant Field Values

Constructor Detail

SecretValue

public SecretValue(char[] value)

Create a value with the specified char array content.

Parameters:

value - char[]

Throws:

CoreException - if the passed char array is null

Method Detail

getType

public DataType getType()

Specified by:

getType in interface DataValue

getValue

public char[] getValue()

Returns the underlying char array content. Will never be null.

Returns:

content

clear

public void clear()

Clear the content inside SecretValue

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Always returns "<secret>" - Safety precaution for the case when someone uses the toString directly on SecretValue object or on a StructValue that contains a secret and for instance logs the result.

Overrides:

toString in class Object

accept

public void accept(ValueVisitor visitor)

Specified by:

accept in interface DataValue

copy

public SecretValue copy()

Specified by:

copy in interface DataValue

Returns:

a deep copy of this data value instance. this operation is NOT thread-safe and might throw ConcurrentModificationException if the DataValue is modified at the time of coping.