Package com.nimbusds.oauth2.sdk

Class AbstractOptionallyIdentifiedRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.AbstractOptionallyAuthenticatedRequest

com.nimbusds.oauth2.sdk.AbstractOptionallyIdentifiedRequest

All Implemented Interfaces:

Message, Request

Direct Known Subclasses:

DeviceAuthorizationRequest, TokenRequest, TokenRevocationRequest

public abstract class AbstractOptionallyIdentifiedRequest
extends AbstractOptionallyAuthenticatedRequest

Abstract request with optional client authentication or client identification.

Client authentication methods:

• client_secret_basic
• client_secret_post
• client_secret_jwt
• private_key_jwt

Client identification methods:

• Top level client_id parameter.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ClientID	getClientID()	Gets the client identifier (for a request from a public client or a request without explicit client authentication).

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

getClientAuthentication, getClientAuthenticationCandidates

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

AbstractOptionallyIdentifiedRequest

protected AbstractOptionallyIdentifiedRequest(URI uri,
 ClientAuthentication clientAuth)

Creates a new abstract request with optional client authentication.

Parameters:

uri - The URI of the endpoint (HTTP or HTTPS) for which the request is intended, null if not specified (if, for example, the Request.toHTTPRequest() method will not be used).

clientAuth - The client authentication, null if none.

AbstractOptionallyIdentifiedRequest

public AbstractOptionallyIdentifiedRequest(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.

AbstractOptionallyIdentifiedRequest

protected AbstractOptionallyIdentifiedRequest(URI uri,
 ClientID clientID)

Creates a new abstract request with optional client identification.

Parameters:

uri - The URI of the endpoint (HTTP or HTTPS) for which the request is intended, null if not specified (if, for example, the Request.toHTTPRequest() method will not be used).

clientID - The client identifier, null if not specified.

Method Details

getClientID

public ClientID getClientID()

Gets the client identifier (for a request from a public client or a request without explicit client authentication).

Returns:

The client identifier, null if not specified.

See Also:

• AbstractOptionallyAuthenticatedRequest.getClientAuthentication()