com.nimbusds.oauth2.sdk.client

Class ClientReadRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.ProtectedResourceRequest

com.nimbusds.oauth2.sdk.client.ClientReadRequest

All Implemented Interfaces:

Message, Request

@Immutable
public class ClientReadRequest
extends ProtectedResourceRequest

Client read request.

Example HTTP request:

 GET /register/s6BhdRkqt3 HTTP/1.1
 Accept: application/json
 Host: server.example.com
 Authorization: Bearer reg-23410913-abewfq.123483
 

Related specifications:

• OAuth 2.0 Dynamic Client Registration Management Protocol (draft-ietf-oauth-dyn-reg-management-04), section 2.2.
• OAuth 2.0 Dynamic Client Registration Protocol (draft-ietf-oauth-dyn-reg-20), section 2.

Constructor Summary

Constructors

Constructor and Description
ClientReadRequest(java.net.URI uri, BearerAccessToken accessToken) Creates a new client read request.

Method Summary

Methods

Modifier and Type	Method and Description
static ClientReadRequest	parse(HTTPRequest httpRequest) Parses a client read request from the specified HTTP GET request.
HTTPRequest	toHTTPRequest() Returns the matching HTTP request.

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

getAccessToken

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

Constructor Detail

ClientReadRequest

public ClientReadRequest(java.net.URI uri,
                 BearerAccessToken accessToken)

Creates a new client read request.

Parameters:

uri - The URI of the client configuration endpoint. May be null if the toHTTPRequest() method will not be used.

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

Method Detail

toHTTPRequest

public HTTPRequest toHTTPRequest()
                          throws SerializeException

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

Throws:

SerializeException - If the request message couldn't be serialised to an HTTP request.

parse

public static ClientReadRequest parse(HTTPRequest httpRequest)
                               throws ParseException

Parses a 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.