Package org.springframework.vault.support

Class VaultDecryptionResult

java.lang.Object

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

org.springframework.vault.support.VaultDecryptionResult

public class VaultDecryptionResult
extends AbstractResult<Plaintext>

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

Since:

1.1

Author:

Praveendra Singh, Mark Paluch

Constructor Summary

Constructors

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

Method Summary

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

VaultDecryptionResult

public VaultDecryptionResult(Plaintext plaintext)

Create VaultDecryptionResult for a successfully decrypted Plaintext .

Parameters:

plaintext - must not be null.

VaultDecryptionResult

public VaultDecryptionResult(VaultException exception)

Create VaultDecryptionResult for an error during decryption.

Parameters:

exception - must not be null.

Method Details

get0

@Nullable
protected Plaintext get0()

Specified by:

get0 in class AbstractResult<Plaintext>

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.