Package org.springframework.vault.support

Class TransformPlaintext

java.lang.Object

org.springframework.vault.support.TransformPlaintext

public class TransformPlaintext
extends Object

Value object representing plain text with an optional VaultTransformContext. Plaintext is represented binary safe as byte[].

Since:

2.3

Author:

Lauren Voswinkel

Method Summary

Modifier and Type	Method	Description
String	asString()
String	asString(Charset charset)
static TransformPlaintext	empty()	Factory method to create an empty TransformPlaintext.
boolean	equals(Object o)
VaultTransformContext	getContext()
byte[]	getPlaintext()
int	hashCode()
static TransformPlaintext	of(byte[] plaintext)	Factory method to create TransformPlaintext from a byte sequence.
static TransformPlaintext	of(String plaintext)	Factory method to create TransformPlaintext using from String.
static TransformPlaintext	of(String plaintext, Charset charset)	Factory method to create TransformPlaintext using from a String using the given Charset.
TransformPlaintext	with(VaultTransformContext context)	Create a new TransformPlaintext object from this plaintext associated with the given VaultTransformContext.

Methods inherited from class java.lang.Object

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

Method Details

empty

public static TransformPlaintext empty()

Factory method to create an empty TransformPlaintext.

Returns:

the empty TransformPlaintext object.

of

public static TransformPlaintext of(byte[] plaintext)

Factory method to create TransformPlaintext from a byte sequence.

Parameters:

plaintext - the plain text to encrypt, must not be null.

Returns:

the TransformPlaintext for plaintext.

of

public static TransformPlaintext of(String plaintext)

Factory method to create TransformPlaintext using from String. String is encoded to byte using the default Charset.

Parameters:

plaintext - the plain text to encrypt, must not be null.

Returns:

the TransformPlaintext for plaintext.

of

public static TransformPlaintext of(String plaintext,
 Charset charset)

Factory method to create TransformPlaintext using from a String using the given Charset. Charset.

Parameters:

plaintext - the plaintext to encrypt, must not be null.

Returns:

the Plaintext for plaintext.

getPlaintext

public byte[] getPlaintext()

getContext

public VaultTransformContext getContext()

with

public TransformPlaintext with(VaultTransformContext context)

Create a new TransformPlaintext object from this plaintext associated with the given VaultTransformContext.

Parameters:

context - transform context.

Returns:

the new TransformPlaintext object.

asString

public String asString()

Returns:

the plain text as String decoded using the default Charset.

asString

public String asString(Charset charset)

Parameters:

charset - the charset to use for decoding.

Returns:

the plain text as String decoded using the default Charset.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object