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:

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

Constructor and Description
AbstractOptionallyIdentifiedRequest(java.net.URI uri, ClientAuthentication clientAuth) Creates a new abstract request with optional client authentication.
AbstractOptionallyIdentifiedRequest(java.net.URI uri, ClientID clientID) Creates a new abstract request with optional client identification.

Method Summary

Modifier and Type	Method and 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

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 Detail

AbstractOptionallyIdentifiedRequest

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

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()