org.springframework.vault.support

Class Plaintext

java.lang.Object

org.springframework.vault.support.Plaintext

public class Plaintext
extends Object

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

Since:

1.1

Author:

Praveendra Singh, Mark Paluch

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static Plaintext empty()

Factory method to create an empty Plaintext.

Returns:

the empty Plaintext object.

Since:

1.1.2

of

public static Plaintext of(byte[] plaintext)

Factory method to create Plaintext from a byte sequence.

Parameters:

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

Returns:

the Plaintext for plaintext.

of

public static Plaintext of(String plaintext)

Factory method to create Plaintext using from a String. String is encoded to byte using the default Charset. Use of(String, java.nio.charset.Charset) to control the Charset to use.

Parameters:

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

Returns:

the Plaintext for plaintext.

of

public static Plaintext of(String plaintext,
                           Charset charset)

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

Parameters:

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

Returns:

the Plaintext for plaintext.

Since:

2.3

getPlaintext

public byte[] getPlaintext()

getContext

public VaultTransitContext getContext()

with

public Plaintext with(VaultTransitContext context)

Create a new Plaintext object from this plain text associated with the given VaultTransitContext.

Parameters:

context - transit context.

Returns:

the new Plaintext 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.

Since:

2.3

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object