com.authlete.common.dto

Class PushedAuthReqRequest

java.lang.Object

com.authlete.common.dto.PushedAuthReqRequest

All Implemented Interfaces:

Serializable

public class PushedAuthReqRequest
extends Object
implements Serializable

Request to Authlete's /api/pushed_auth_req API.

The authorization server can implement a pushed authorization request endpoint which is defined in "OAuth 2.0 Pushed Authorization Requests" by using the Authlete API.

Request parameters to the API are as follows.

parameters (REQUIRED)

Request parameters that the pushed authorization request endpoint of the authorization server implementation received from the client application. Its format is application/x-www-form-urlencoded.

clientId (OPTIONAL)

The client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.

If the pushed authorization request endpoint of the authorization server implementation supports Basic Authentication as a means of client authentication, and the request from the client application contained its client ID in the Authorization header, the value should be extracted and set to this parameter.

clientSecret (OPTIONAL)

The client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.

If the pushed authorization request endpoint of the authorization server implementation supports Basic Authentication as a means of client authentication, and the request from the client application contained its client secret in the Authorization header, the value should be extracted and set to this parameter.

clientCertificate (OPTIONAL)

The client certificate used in the TLS connection between the client application and the pushed authorization request endpoint of the authorization server.

clientCertificatePath (OPTIONAL)

The client certificate path presented by the client during client authentication. Each element is a string in PEM format.

Since:

2.51

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PushedAuthReqRequest()

Method Summary

Modifier and Type	Method and Description
String	getClientCertificate() Get the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.
String[]	getClientCertificatePath() Get the client certificate path presented by the client during client authentication.
String	getClientId() Get the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.
String	getClientSecret() Get the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.
String	getParameters() Get the request parameters that the pushed authorization request endpoint received from the client application.
PushedAuthReqRequest	setClientCertificate(String certificate) Set the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.
PushedAuthReqRequest	setClientCertificatePath(String[] path) Set the client certificate path presented by the client during client authentication.
PushedAuthReqRequest	setClientId(String clientId) Set the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.
PushedAuthReqRequest	setClientSecret(String clientSecret) Set the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.
PushedAuthReqRequest	setParameters(String parameters) Set the request parameters that the pushed authorization request endpoint received from the client application.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushedAuthReqRequest

public PushedAuthReqRequest()

Method Detail

getParameters

public String getParameters()

Get the request parameters that the pushed authorization request endpoint received from the client application.

Returns:

Request parameters in application/x-www-form-urlencoded format.

setParameters

public PushedAuthReqRequest setParameters(String parameters)

Set the request parameters that the pushed authorization request endpoint received from the client application.

Parameters:

parameters - Request parameters in application/x-www-form-urlencoded format.

Returns:

this object.

getClientId

public String getClientId()

Get the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.

Returns:

The client ID.

setClientId

public PushedAuthReqRequest setClientId(String clientId)

Set the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.

Parameters:

clientId - The client ID.

Returns:

this object.

getClientSecret

public String getClientSecret()

Get the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.

Returns:

The client secret.

setClientSecret

public PushedAuthReqRequest setClientSecret(String clientSecret)

Set the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.

Parameters:

clientSecret - The client secret.

Returns:

this object.

getClientCertificate

public String getClientCertificate()

Get the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.

Returns:

The client certificate.

setClientCertificate

public PushedAuthReqRequest setClientCertificate(String certificate)

Set the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.

Parameters:

certificate - The client certificate.

Returns:

this object.

getClientCertificatePath

public String[] getClientCertificatePath()

Get the client certificate path presented by the client during client authentication.

Returns:

The client certificate path. Each element is a string in PEM format.

setClientCertificatePath

public PushedAuthReqRequest setClientCertificatePath(String[] path)

Set the client certificate path presented by the client during client authentication.

Parameters:

path - The client certificate path.

Returns:

this object.