org.springframework.vault.support

Class VaultTransformEncodeResult

java.lang.Object

org.springframework.vault.support.AbstractResult<TransformCiphertext>

org.springframework.vault.support.VaultTransformEncodeResult

public class VaultTransformEncodeResult
extends AbstractResult<TransformCiphertext>

Holds the response from encryption operation and provides methods to access the result.

Since:

2.3

Author:

Lauren Voswinkel

Constructor Summary

Constructors

Constructor and Description
VaultTransformEncodeResult(TransformCiphertext cipherText) Create VaultTransformEncodeResult for a successfully encrypted TransformCiphertext .
VaultTransformEncodeResult(VaultException exception) Create VaultTransformEncodeResult for an error during encryption.

Method Summary

Modifier and Type	Method and Description
protected TransformCiphertext	get0()
String	getAsString() Return the result as String or throw a VaultException if the operation completed with an error.

Methods inherited from class org.springframework.vault.support.AbstractResult

get, getCause, isSuccessful

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultTransformEncodeResult

public VaultTransformEncodeResult(TransformCiphertext cipherText)

Create VaultTransformEncodeResult for a successfully encrypted TransformCiphertext .

Parameters:

cipherText - must not be null.

VaultTransformEncodeResult

public VaultTransformEncodeResult(VaultException exception)

Create VaultTransformEncodeResult for an error during encryption.

Parameters:

exception - must not be null.

Method Detail

get0

@Nullable
protected TransformCiphertext get0()

Specified by:

get0 in class AbstractResult<TransformCiphertext>

Returns:

the actual result if this result completed successfully.

getAsString

@Nullable
public String getAsString()

Return the result as String or throw a VaultException if the operation completed with an error. Use AbstractResult.isSuccessful() to verify the success status of this result without throwing an exception.

Returns:

the result value.

Throws:

VaultException - if the operation completed with an error.