com.nimbusds.oauth2.sdk.reg
Class ClientReadRequest

java.lang.Object
  com.nimbusds.oauth2.sdk.ProtectedResourceRequest
      com.nimbusds.oauth2.sdk.reg.ClientReadRequest

All Implemented Interfaces:

Message, Request

@Immutable
public class ClientReadRequest
extends ProtectedResourceRequest

Client read request. This class is immutable.

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 Protocol (draft-ietf-oauth-dyn-reg-12), section 4.2.

Author:

Vladimir Dzhuvinov

Constructor Summary

ClientReadRequest(BearerAccessToken accessToken)
Creates a new client read request.

Method Summary

static ClientReadRequest	parse(HTTPRequest httpRequest) Parses a 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

ClientReadRequest

public ClientReadRequest(BearerAccessToken accessToken)

Creates a new 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 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.