package com.nimbusds.oauth2.sdk.client;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import net.jcip.annotations.Immutable;
import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.ProtectedResourceRequest;
import com.nimbusds.oauth2.sdk.SerializeException;
import com.nimbusds.oauth2.sdk.http.HTTPRequest;
import com.nimbusds.oauth2.sdk.token.BearerAccessToken;
/**
* Client read request.
*
* <p>Example HTTP request:
*
* <pre>
* GET /register/s6BhdRkqt3 HTTP/1.1
* Accept: application/json
* Host: server.example.com
* Authorization: Bearer reg-23410913-abewfq.123483
* </pre>
*
* <p>Related specifications:
*
* <ul>
* <li>OAuth 2.0 Dynamic Client Registration Management Protocol
* (draft-ietf-oauth-dyn-reg-management-04), section 2.2.
* <li>OAuth 2.0 Dynamic Client Registration Protocol
* (draft-ietf-oauth-dyn-reg-20), section 2.
* </ul>
*/
@Immutable
public class ClientReadRequest extends ProtectedResourceRequest {
/**
* Creates a new client read request.
*
* @param uri The URI of the client configuration endpoint. May
* be {@code null} if the {@link #toHTTPRequest()}
* method will not be used.
* @param accessToken An OAuth 2.0 Bearer access token for the request.
* Must not be {@code null}.
*/
public ClientReadRequest(final URI uri, final BearerAccessToken accessToken) {
super(uri, accessToken);
if (accessToken == null)
throw new IllegalArgumentException("The access token must not be null");
}
@Override
public HTTPRequest toHTTPRequest()
throws SerializeException {
if (getEndpointURI() == null)
throw new SerializeException("The endpoint URI is not specified");
URL endpointURL;
try {
endpointURL = getEndpointURI().toURL();
} catch (MalformedURLException e) {
throw new SerializeException(e.getMessage(), e);
}
HTTPRequest httpRequest = new HTTPRequest(HTTPRequest.Method.GET, endpointURL);
httpRequest.setAuthorization(getAccessToken().toAuthorizationHeader());
return httpRequest;
}
/**
* Parses a client read request from the specified HTTP GET request.
*
* @param httpRequest The HTTP request. Must not be {@code null}.
*
* @return The client read request.
*
* @throws ParseException If the HTTP request couldn't be parsed to a
* client read request.
*/
public static ClientReadRequest parse(final HTTPRequest httpRequest)
throws ParseException {
httpRequest.ensureMethod(HTTPRequest.Method.GET);
BearerAccessToken accessToken = BearerAccessToken.parse(httpRequest.getAuthorization());
URI endpointURI;
try {
endpointURI = httpRequest.getURL().toURI();
} catch (URISyntaxException e) {
throw new ParseException(e.getMessage(), e);
}
return new ClientReadRequest(endpointURI, accessToken);
}
}