com.nimbusds.openid.connect.sdk
Class OIDCClientReadRequest

java.lang.Object
  com.nimbusds.oauth2.sdk.ProtectedResourceRequest
      com.nimbusds.openid.connect.sdk.OIDCClientReadRequest

All Implemented Interfaces:

Message, Request

@Immutable
public class OIDCClientReadRequest
extends ProtectedResourceRequest

OpenID Connect client read request. This class is immutable.

Example HTTP request:

 GET /connect/register?client_id=s6BhdRkqt3 HTTP/1.1
 Accept: application/json
 Host: server.example.com
 Authorization: Bearer this.is.an.access.token.value.ffx83
 

Related specifications:

• OpenID Connect Dynamic Client Registration 1.0, section 4.1.

Author:

Vladimir Dzhuvinov

Constructor Summary

OIDCClientReadRequest(BearerAccessToken accessToken)
Creates a new OpenID Connect client read request.

Method Summary

static OIDCClientReadRequest	parse(HTTPRequest httpRequest) Parses an OpenID Connect client read request from the specified HTTP GET request.
HTTPRequest	toHTTPRequest(URL url) Returns the matching HTTP request.

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

getAccessToken

Methods inherited from class java.lang.Object

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

Constructor Detail

OIDCClientReadRequest

public OIDCClientReadRequest(BearerAccessToken accessToken)

Creates a new OpenID Connect client read request.

Parameters:

accessToken - An OAuth 2.0 Bearer access token for the request. Must not be null.

Method Detail

toHTTPRequest

public HTTPRequest toHTTPRequest(URL url)

Description copied from interface: Request

Returns the matching HTTP request.

Parameters:

url - The URL of the HTTP endpoint for which the request is intended. Must not be null.

Returns:

The HTTP request.

parse

public static OIDCClientReadRequest parse(HTTPRequest httpRequest)
                                   throws ParseException

Parses an OpenID Connect client read request from the specified HTTP GET request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The client read request.

Throws:

ParseException - If the HTTP request couldn't be parsed to a client read request.