Package com.nimbusds.oauth2.sdk

Class AbstractOptionallyAuthenticatedRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.AbstractOptionallyAuthenticatedRequest

All Implemented Interfaces:

Message, Request

Direct Known Subclasses:

AbstractOptionallyIdentifiedRequest, PushedAuthorizationRequest, RequestObjectPOSTRequest, TokenIntrospectionRequest

public abstract class AbstractOptionallyAuthenticatedRequest
extends AbstractRequest

Abstract request with optional client authentication. Supports more than one client authentication method, for deployments that allow migration of the authentication methods for a client, for example, from client_secret_basic to private_key_jwt.

Client authentication methods:

• client_secret_basic
• client_secret_post
• client_secret_jwt
• private_key_jwt
• self_signed_tls_client_auth
• tls_client_auth

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOptionallyAuthenticatedRequest(URI endpoint, ClientAuthentication clientAuth)	Creates a new abstract request with optional client authentication.
	AbstractOptionallyAuthenticatedRequest(URI endpoint, List<ClientAuthentication> clientAuthCandidates)	Creates a new abstract request with optional client authentication candidates.

Method Summary

Modifier and Type	Method	Description
ClientAuthentication	getClientAuthentication()	Returns the client authentication.
List<ClientAuthentication>	getClientAuthenticationCandidates()	Returns the client authentication candidates.

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest

getEndpointURI

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nimbusds.oauth2.sdk.Request

toHTTPRequest

Constructor Details

AbstractOptionallyAuthenticatedRequest

protected AbstractOptionallyAuthenticatedRequest(URI endpoint,
 ClientAuthentication clientAuth)

Creates a new abstract request with optional client authentication.

Parameters:

endpoint - The URI of the endpoint. May be null if the Request.toHTTPRequest() method is not going to be used.

clientAuth - The client authentication, null if none.

AbstractOptionallyAuthenticatedRequest

public AbstractOptionallyAuthenticatedRequest(URI endpoint,
 List<ClientAuthentication> clientAuthCandidates)

Creates a new abstract request with optional client authentication candidates.

Parameters:

endpoint - The URI of the endpoint. May be null if the Request.toHTTPRequest() method is not going to be used.

clientAuthCandidates - The client authentication candidates, null if none.

Method Details

getClientAuthentication

public ClientAuthentication getClientAuthentication()

Returns the client authentication.

Returns:

The client authentication, null if none.

getClientAuthenticationCandidates

public List<ClientAuthentication> getClientAuthenticationCandidates()

Returns the client authentication candidates. This method is intended for deployments that allow migration of the authentication methods for a client, for example from client_secret_basic to private_key_jwt.

Returns:

The client authentication candidates, empty list if none.