Package com.authlete.jaxrs

Class TokenRequestHandler.Params

java.lang.Object

com.authlete.jaxrs.TokenRequestHandler.Params

All Implemented Interfaces:

Serializable

Enclosing class:

TokenRequestHandler

public static class TokenRequestHandler.Params
extends Object
implements Serializable

Parameters passed to the TokenRequestHandler.handle(Params) method.

Since:

2.27

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Params()

Method Summary

Modifier and Type	Method	Description
String	getAuthorization()	Get the value of the Authorization header in the token request.
String	getClientAttestation()	Get the value of the OAuth-Client-Attestation HTTP header.
String	getClientAttestationPop()	Get the value of the OAuth-Client-Attestation-PoP HTTP header.
String[]	getClientCertificatePath()	Get the path of the client's certificate, each in PEM format.
String	getDpop()	Get the DPoP proof JWT (the value of the DPoP HTTP header).
String	getHtm()	Get the HTTP method of the token request.
String	getHtu()	Get the URL of the token endpoint.
javax.ws.rs.core.MultivaluedMap<String,String>	getParameters()	Get the request parameters of the token request.
TokenRequestHandler.Params	setAuthorization(String authorization)	Set the value of the Authorization header in the token request.
TokenRequestHandler.Params	setClientAttestation(String jwt)	Set the value of the OAuth-Client-Attestation HTTP header.
TokenRequestHandler.Params	setClientAttestationPop(String jwt)	Set the value of the OAuth-Client-Attestation-PoP HTTP header.
TokenRequestHandler.Params	setClientCertificatePath(String[] path)	Set the path of the client's certificate, each in PEM format.
TokenRequestHandler.Params	setDpop(String dpop)	Set the DPoP proof JWT (the value of the DPoP HTTP header).
TokenRequestHandler.Params	setHtm(String htm)	Set the HTTP method of the token request.
TokenRequestHandler.Params	setHtu(String htu)	Set the URL of the token endpoint.
TokenRequestHandler.Params	setParameters(javax.ws.rs.core.MultivaluedMap<String,String> parameters)	Set the request parameters of the token request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Params

public Params()

Method Detail

getParameters

public javax.ws.rs.core.MultivaluedMap<String,String> getParameters()

Get the request parameters of the token request.

Returns:

The request parameters of the token request.

setParameters

public TokenRequestHandler.Params setParameters(javax.ws.rs.core.MultivaluedMap<String,String> parameters)

Set the request parameters of the token request.

Parameters:

parameters - The request parameters of the token request.

Returns:

this object.

getAuthorization

public String getAuthorization()

Get the value of the Authorization header in the token request. A pair of client ID and client secret is embedded there when the client authentication method is client_secret_basic.

Returns:

The value of the Authorization header.

setAuthorization

public TokenRequestHandler.Params setAuthorization(String authorization)

Set the value of the Authorization header in the token request. A pair of client ID and client secret is embedded there when the client authentication method is client_secret_basic.

Parameters:

authorization - The value of the Authorization header.

Returns:

this object.

getClientCertificatePath

public String[] getClientCertificatePath()

Get the path of the client's certificate, each in PEM format. The first item in the array is the client's certificate itself.

Returns:

The path of the client's certificate.

See Also:

RFC 8705: OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens

setClientCertificatePath

public TokenRequestHandler.Params setClientCertificatePath(String[] path)

Set the path of the client's certificate, each in PEM format. The first item in the array is the client's certificate itself.

Parameters:

path - The path of the client's certificate.

Returns:

this object.

See Also:

RFC 8705: OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens

getDpop

public String getDpop()

Get the DPoP proof JWT (the value of the DPoP HTTP header).

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Returns:

The DPoP proof JWT.

setDpop

public TokenRequestHandler.Params setDpop(String dpop)

Set the DPoP proof JWT (the value of the DPoP HTTP header).

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Parameters:

dpop - The DPoP proof JWT.

Returns:

this object.

getHtm

public String getHtm()

Get the HTTP method of the token request.

Returns:

The HTTP method of the token request.

setHtm

public TokenRequestHandler.Params setHtm(String htm)

Set the HTTP method of the token request.

The value should be "POST" unless new specifications allowing other HTTP methods at the token endpoint are developed. If this parameter is omitted, "POST" is used as the default value.

The value passed here will be used to validate the DPoP proof JWT. See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Parameters:

htm - The HTTP method of the token request.

Returns:

this object.

getHtu

public String getHtu()

Get the URL of the token endpoint.

Returns:

The URL of the token endpoint.

setHtu

public TokenRequestHandler.Params setHtu(String htu)

Set the URL of the token endpoint.

If this parameter is omitted, the tokenEndpoint property of Service will be used as the default value.

The value passed here will be used to validate the DPoP proof JWT. See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Parameters:

htu - The URL of the token endpoint.

Returns:

this object.

getClientAttestation

public String getClientAttestation()

Get the value of the OAuth-Client-Attestation HTTP header.

Returns:

The value of the OAuth-Client-Attestation HTTP header.

Since:

2.79, Authlete 3.0

See Also:

OAuth 2.0 Attestation-Based Client Authentication

setClientAttestation

public TokenRequestHandler.Params setClientAttestation(String jwt)

Set the value of the OAuth-Client-Attestation HTTP header.

Parameters:

jwt - The value of the OAuth-Client-Attestation HTTP header.

Returns:

this object.

Since:

2.79, Authlete 3.0

See Also:

OAuth 2.0 Attestation-Based Client Authentication

getClientAttestationPop

public String getClientAttestationPop()

Get the value of the OAuth-Client-Attestation-PoP HTTP header.

Returns:

The value of the OAuth-Client-Attestation-PoP HTTP header.

Since:

2.79, Authlete 3.0

See Also:

OAuth 2.0 Attestation-Based Client Authentication

setClientAttestationPop

public TokenRequestHandler.Params setClientAttestationPop(String jwt)

Set the value of the OAuth-Client-Attestation-PoP HTTP header.

Parameters:

jwt - The value of the OAuth-Client-Attestation-PoP HTTP header.

Returns:

this object.

Since:

2.79, Authlete 3.0

See Also:

OAuth 2.0 Attestation-Based Client Authentication