Package org.forgerock.http.oauth2

Class EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder

java.lang.Object

org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder<EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder>

org.forgerock.http.oauth2.EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder

Enclosing class:

EncryptedPrivateKeyJwtClientAuthenticationFilter

public static class EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder
extends PrivateKeyJwtClientAuthenticationFilter.Builder<EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder>

Builder class for creating the Encrypted PrivateKey Jwt ClientAuthentication Filter.

Field Summary

Fields inherited from class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder

secretsProvider

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EncryptedPrivateKeyJwtClientAuthenticationFilter	build()	Builds the EncryptedPrivateKeyAuthFilter instance.
protected void	buildSecretReferences()	Deprecated, for removal: This API element is subject to removal in a future version. for removal with withEncryptionPurpose(Purpose).
String	toString()
EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder	withEncryptionAlgorithm(JweAlgorithm encryptionAlgorithm)	Sets algorithm used to encrypt the private key jwt.
EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder	withEncryptionMethod(EncryptionMethod encryptionMethod)	Sets encryption method used to encrypt the private key jwt.
EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder	withEncryptionPurpose(Purpose<DataEncryptionKey> encryptionPurpose)	Deprecated, for removal: This API element is subject to removal in a future version. Please use withEncryptionSecretReference(SecretReference) instead.
EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder	withEncryptionSecretReference(SecretReference<DataEncryptionKey> secretReference)	Sets SecretReference to use as the encryption key.

Methods inherited from class org.forgerock.http.oauth2.PrivateKeyJwtClientAuthenticationFilter.Builder

self, withClaims, withClientId, withClock, withPrivateKeyJwtExpiryTime, withSecretsProvider, withSigningAlgorithm, withSigningPurpose, withSigningSecretReference, withTokenEndpoint

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withEncryptionPurpose

@Deprecated(since="26.2.0",
            forRemoval=true)
public EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder withEncryptionPurpose(Purpose<DataEncryptionKey> encryptionPurpose)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use withEncryptionSecretReference(SecretReference) instead. Will be removed in winter 2021 season.

Sets purpose to look up the encryption key. Note that you should provide either the SecretReference (preferred) or both the encryption Purpose and SecretsProvider, so that the encryption key can be determined.

Parameters:

encryptionPurpose - The purpose to look up the encryption key to encrypt the private key jwt.

Returns:

The builder.

withEncryptionSecretReference

public EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder withEncryptionSecretReference(SecretReference<DataEncryptionKey> secretReference)

Sets SecretReference to use as the encryption key. Note that this is the preferred way of providing the encryption secret reference, though you may alternatively provide both the encryption Purpose and SecretsProvider.

Parameters:

secretReference - The secret reference used to encrypt the JWT.

Returns:

The builder.

withEncryptionAlgorithm

public EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder withEncryptionAlgorithm(JweAlgorithm encryptionAlgorithm)

Sets algorithm used to encrypt the private key jwt.

Parameters:

encryptionAlgorithm - The algorithm used to encrypt the private key jwt.

Returns:

The builder.

withEncryptionMethod

public EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder withEncryptionMethod(EncryptionMethod encryptionMethod)

Sets encryption method used to encrypt the private key jwt.

Parameters:

encryptionMethod - The encryption method used to encrypt the private key jwt.

Returns:

The builder.

build

public EncryptedPrivateKeyJwtClientAuthenticationFilter build()

Builds the EncryptedPrivateKeyAuthFilter instance.

Overrides:

build in class PrivateKeyJwtClientAuthenticationFilter.Builder<EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder>

Returns:

The EncryptedPrivateKeyAuthFilter.

buildSecretReferences

@Deprecated(since="26.2.0",
            forRemoval=true)
protected void buildSecretReferences()

Deprecated, for removal: This API element is subject to removal in a future version.

for removal with withEncryptionPurpose(Purpose). Will be removed in winter 2021 season.

Set the signing and encryption secret references in the builder based on supplied configuration, whether by direct provision of the SecretReference or via the SecretsProvider and Purpose, for signing and encryption respectively. This method provides compatibility between these two ways of providing the signing and encryption secret references.

Overrides:

buildSecretReferences in class PrivateKeyJwtClientAuthenticationFilter.Builder<EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder>

toString

public String toString()

Overrides:

toString in class PrivateKeyJwtClientAuthenticationFilter.Builder<EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder>