Package org.springframework.vault.support

Class VaultSignRequest

java.lang.Object

org.springframework.vault.support.VaultSignRequest

public class VaultSignRequest
extends Object

Request for a signature creation request.

Since:

2.0

Author:

Luander Ribeiro, Mark Paluch, My-Lan Aragon, Nanne Baars

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VaultSignRequest.VaultSignRequestBuilder	Builder to build a VaultSignRequest.

Method Summary

Modifier and Type	Method	Description
static VaultSignRequest.VaultSignRequestBuilder	builder()
static VaultSignRequest	create(Plaintext input)	Create a new VaultSignRequest given Plaintext.
String	getAlgorithm()	Deprecated. since 2.4, use getSignatureAlgorithm() instead.
String	getHashAlgorithm()
Plaintext	getPlaintext()
String	getSignatureAlgorithm()
boolean	isPrehashed()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static VaultSignRequest.VaultSignRequestBuilder builder()

Returns:

a new instance of VaultSignRequest.VaultSignRequestBuilder.

create

public static VaultSignRequest create(Plaintext input)

Create a new VaultSignRequest given Plaintext. Uses the default algorithm.

Returns:

a new VaultSignRequest for the given input.

getPlaintext

public Plaintext getPlaintext()

Returns:

plain text input used as basis to generate the signature.

getHashAlgorithm

@Nullable
public String getHashAlgorithm()

Returns:

hashAlgorithm used for creating the signature or null to use the default hash algorithm.

Since:

2.4

getSignatureAlgorithm

@Nullable
public String getSignatureAlgorithm()

Returns:

signatureAlgorithm used for creating the signature when using an RSA key or null to use the default signature algorithm.

Since:

2.4

getAlgorithm

@Deprecated(since="2.4")
@Nullable
public String getAlgorithm()

Deprecated.

since 2.4, use getSignatureAlgorithm() instead.

Returns:

algorithm used for creating the signature or null to use the default algorithm.

isPrehashed

public boolean isPrehashed()

Returns:

true if the input is already hashed.

Since:

3.1