com.authlete.common.dto

Class GMRequest

java.lang.Object

com.authlete.common.dto.GMRequest

All Implemented Interfaces:

Serializable

public class GMRequest
extends Object
implements Serializable

Request to Authlete's /api/gm API.

gmAction (REQUIRED)

The grant management action of the grant management request. Either QUERY or REVOKE.

grantId (REQUIRED)

The grant ID of the grant management request.

accessToken (REQUIRED)

The access token included in the grant management request.

clientCertificate (OPTIONAL)

The client certificate used in the TLS connection established between the client application and the grant management endpoint. See "RFC 8705 OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens" for details.

dpop (OPTIONAL)

The value of the DPoP HTTP header. See "OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)" for details.

htm (OPTIONAL)

The HTTP method of the grant management request. Either "GET" or "DELETE". This parameter is used to validate the value of the DPoP HTTP header. See "OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)" for details.

API callers don't have to specify this parameter unless they have a special reason because the default value can be easily determined based on the value of gmAction.

htu (OPTIONAL)

The URL of the grant management endpoint. This parameter is used to validate the value of the DPoP HTTP header. See "OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)" for details.

When omitted, a string built by concatenating (1) the grantManagementEndpoint property of the Service, (2) a slash (/) and (3) the grant ID is used as the default value.

Since:

3.1

See Also:

Grant Management for OAuth 2.0, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GMRequest()

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Get the access token which has come along with the grant management request from the client application.
String	getClientCertificate() Get the client certificate used in the TLS connection established between the client application and the grant management endpoint.
String	getDpop() Get the value of the DPoP header of the grant management request.
GMAction	getGmAction() Get the grant management action of the grant management request.
String	getGrantId() Get the grant ID of the grant management request.
String	getHtm() Get the HTTP method of the grant management request.
String	getHtu() Get the URL of the grant management endpoint.
GMRequest	setAccessToken(String accessToken) Set the access token that has come along with the grant management request from the client application.
GMRequest	setClientCertificate(String certificate) Set the client certificate used in the TLS connection established between the client application and the grant management endpoint.
GMRequest	setDpop(String dpop) Set the value of the DPoP header of the grant management request.
GMRequest	setGmAction(GMAction gmAction) Set the grant management action of the grant management request.
GMRequest	setGrantId(String grantId) Set the grant ID of the grant management request.
GMRequest	setHtm(String htm) Set the HTTP method of the grant management request.
GMRequest	setHtu(String htu) Set the URL of the grant management endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

GMRequest

public GMRequest()

Method Detail

getGmAction

public GMAction getGmAction()

Get the grant management action of the grant management request. Either QUERY or REVOKE.

Returns:

The grant management action of the grant management request.

setGmAction

public GMRequest setGmAction(GMAction gmAction)

Set the grant management action of the grant management request. Either QUERY or REVOKE.

Parameters:

gmAction - The grant management action of the grant management request.

Returns:

this object.

getGrantId

public String getGrantId()

Get the grant ID of the grant management request.

Returns:

The grant ID.

setGrantId

public GMRequest setGrantId(String grantId)

Set the grant ID of the grant management request.

Parameters:

grantId - The grant ID.

Returns:

this object.

getAccessToken

public String getAccessToken()

Get the access token which has come along with the grant management request from the client application.

Returns:

The access token.

setAccessToken

public GMRequest setAccessToken(String accessToken)

Set the access token that has come along with the grant management request from the client application.

Parameters:

accessToken - The access token.

Returns:

this object.

getClientCertificate

public String getClientCertificate()

Get the client certificate used in the TLS connection established between the client application and the grant management endpoint.

This property is checked when the access token is bound to a client certificate. See RFC 8705 for details.

Returns:

The client certificate in PEM format.

See Also:

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

setClientCertificate

public GMRequest setClientCertificate(String certificate)

Set the client certificate used in the TLS connection established between the client application and the grant management endpoint.

This property is checked when the access token is bound to a client certificate. See RFC 8705 for details.

Parameters:

certificate - The client certificate in PEM format.

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 value of the DPoP header of the grant management request.

This property is checked when the access token is bound to a public key.

Returns:

The value of the DPoP header.

See Also:

OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

setDpop

public GMRequest setDpop(String dpop)

Set the value of the DPoP header of the grant management request.

This property is checked when the access token is bound to a public key.

Parameters:

dpop - The value of the DPoP header.

Returns:

this object.

See Also:

OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

getHtm

public String getHtm()

Get the HTTP method of the grant management request.

This property is used to validate the value of the DPoP header.

When this property is omitted, "GET" is used as the default value in the case of gmAction=QUERY. Likewise, "DELETE" is used as the default value in the case of gmAction=REVOKE.

Returns:

The HTTP method of the grant management request.

See Also:

OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

setHtm

public GMRequest setHtm(String htm)

Set the HTTP method of the grant management request.

This property is used to validate the value of the DPoP header.

When this property is omitted, "GET" is used as the default value in the case of gmAction=QUERY. Likewise, "DELETE" is used as the default value in the case of gmAction=REVOKE.

Parameters:

htm - The HTTP method of the grant management request.

Returns:

this object.

See Also:

OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

getHtu

public String getHtu()

Get the URL of the grant management endpoint.

This property is used to validate the value of the DPoP header.

When this property is omitted, a string built by concatenating (1) the grantManagementEndpoint property of the Service, (2) a slash (/) and (3) the grant ID is used as the default value.

Returns:

The URL of the grant management endpoint.

See Also:

OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

setHtu

public GMRequest setHtu(String htu)

Set the URL of the grant management endpoint.

This property is used to validate the value of the DPoP header.

When this property is omitted, a string built by concatenating (1) the grantManagementEndpoint property of the Service, (2) a slash (/) and (3) the grant ID is used as the default value.

Parameters:

htu - The URL of the userinfo endpoint.

Returns:

this object.

See Also:

OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)