io.jsonwebtoken.security

Interface Request<T>

Type Parameters:

T - the type of payload in the request.

All Superinterfaces:

Message<T>

All Known Subinterfaces:

AeadRequest, DecryptAeadRequest, DecryptionKeyRequest<K>, KeyRequest<T>, SecureRequest<T,K>, VerifyDigestRequest, VerifySecureDigestRequest<K>

public interface Request<T>
extends Message<T>

A Request aggregates various parameters that may be used by a particular cryptographic algorithm. It and any of its subtypes implemented as a single object submitted to an algorithm effectively reflect the Parameter Object design pattern. This provides for a much cleaner request/result algorithm API instead of polluting the API with an excessive number of overloaded methods that would exist otherwise.

The Request interface specifically allows for JCA Provider and SecureRandom instances to be used during request execution, which allows more flexibility than forcing a single Provider or SecureRandom for all executions. Request subtypes provide additional parameters as necessary depending on the type of cryptographic algorithm invoked.

Since:

0.12.0

See Also:

getProvider(), getSecureRandom()

Method Summary

Methods

Modifier and Type	Method and Description
Provider	getProvider() Returns the JCA provider that should be used for cryptographic operations during the request or null if the JCA subsystem preferred provider should be used.
SecureRandom	getSecureRandom() Returns the SecureRandom to use when performing cryptographic operations during the request, or null if a default SecureRandom should be used.

Methods inherited from interface io.jsonwebtoken.security.Message

getPayload

Method Detail

getProvider

Provider getProvider()

Returns the JCA provider that should be used for cryptographic operations during the request or null if the JCA subsystem preferred provider should be used.

Returns:

the JCA provider that should be used for cryptographic operations during the request or null if the JCA subsystem preferred provider should be used.

getSecureRandom

SecureRandom getSecureRandom()

Returns the SecureRandom to use when performing cryptographic operations during the request, or null if a default SecureRandom should be used.

Returns:

the SecureRandom to use when performing cryptographic operations during the request, or null if a default SecureRandom should be used.