Package com.authlete.jaxrs

Class PushedAuthReqHandler.Params

java.lang.Object

com.authlete.jaxrs.PushedAuthReqHandler.Params

All Implemented Interfaces:

Serializable

Enclosing class:

PushedAuthReqHandler

public static class PushedAuthReqHandler.Params
extends Object
implements Serializable

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

Since:

2.69

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 PAR 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 PAR request.
String	getHtu()	Get the URL of the PAR endpoint.
javax.ws.rs.core.MultivaluedMap<String,String>	getParameters()	Get the request parameters of the PAR request.
PushedAuthReqHandler.Params	setAuthorization(String authorization)	Set the value of the Authorization header in the PAR request.
PushedAuthReqHandler.Params	setClientAttestation(String jwt)	Set the value of the OAuth-Client-Attestation HTTP header.
PushedAuthReqHandler.Params	setClientAttestationPop(String jwt)	Set the value of the OAuth-Client-Attestation-PoP HTTP header.
PushedAuthReqHandler.Params	setClientCertificatePath(String[] path)	Set the path of the client's certificate, each in PEM format.
PushedAuthReqHandler.Params	setDpop(String dpop)	Set the DPoP proof JWT (the value of the DPoP HTTP header).
PushedAuthReqHandler.Params	setHtm(String htm)	Set the HTTP method of the PAR request.
PushedAuthReqHandler.Params	setHtu(String htu)	Set the URL of the PAR endpoint.
PushedAuthReqHandler.Params	setParameters(javax.ws.rs.core.MultivaluedMap<String,String> parameters)	Set the request parameters of the PAR 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 PAR request.

Returns:

The request parameters of the PAR request.

setParameters

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

Set the request parameters of the PAR request.

Parameters:

parameters - The request parameters of the PAR request.

Returns:

this object.

getAuthorization

public String getAuthorization()

Get the value of the Authorization header in the PAR 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 PushedAuthReqHandler.Params setAuthorization(String authorization)

Set the value of the Authorization header in the PAR 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 PushedAuthReqHandler.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).

Returns:

The DPoP proof JWT.

See Also:

RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)

setDpop

public PushedAuthReqHandler.Params setDpop(String dpop)

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

Parameters:

dpop - The DPoP proof JWT.

Returns:

this object.

See Also:

RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)

getHtm

public String getHtm()

Get the HTTP method of the PAR request.

Returns:

The HTTP method of the PAR request.

See Also:

RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)

setHtm

public PushedAuthReqHandler.Params setHtm(String htm)

Set the HTTP method of the PAR request.

The value should be "POST" unless new specifications allowing other HTTP methods at the PAR 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.

Parameters:

htm - The HTTP method of the PAR request.

Returns:

this object.

See Also:

RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)

getHtu

public String getHtu()

Get the URL of the PAR endpoint.

Returns:

The URL of the PAR endpoint.

See Also:

RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)

setHtu

public PushedAuthReqHandler.Params setHtu(String htu)

Set the URL of the PAR endpoint.

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

The value passed here will be used to validate the DPoP proof JWT.

Parameters:

htu - The URL of the PAR endpoint.

Returns:

this object.

See Also:

RFC 9449: OAuth 2.0 Demonstrating Proof of Possession (DPoP)

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 PushedAuthReqHandler.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 PushedAuthReqHandler.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