Package org.springframework.vault.support

Class VaultTransformDecodeResult

java.lang.Object

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

org.springframework.vault.support.VaultTransformDecodeResult

public class VaultTransformDecodeResult
extends AbstractResult<TransformPlaintext>

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

Since:

2.3

Author:

Lauren Voswinkel

Constructor Summary

Constructors

Constructor	Description
VaultTransformDecodeResult(TransformPlaintext plaintext)	Create VaultTransformDecodeResult for a successfully decrypted TransformPlaintext .
VaultTransformDecodeResult(VaultException exception)	Create VaultTransformDecodeResult for an error during decryption.

Method Summary

Modifier and Type	Method	Description
protected TransformPlaintext	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 Details

VaultTransformDecodeResult

public VaultTransformDecodeResult(TransformPlaintext plaintext)

Create VaultTransformDecodeResult for a successfully decrypted TransformPlaintext .

Parameters:

plaintext - must not be null.

VaultTransformDecodeResult

public VaultTransformDecodeResult(VaultException exception)

Create VaultTransformDecodeResult for an error during decryption.

Parameters:

exception - must not be null.

Method Details

get0

@Nullable
protected TransformPlaintext get0()

Specified by:

get0 in class AbstractResult<TransformPlaintext>

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.