001package com.nimbusds.oauth2.sdk.client; 002 003 004import java.net.MalformedURLException; 005import java.net.URI; 006import java.net.URISyntaxException; 007import java.net.URL; 008 009import net.jcip.annotations.Immutable; 010 011import com.nimbusds.oauth2.sdk.ParseException; 012import com.nimbusds.oauth2.sdk.ProtectedResourceRequest; 013import com.nimbusds.oauth2.sdk.SerializeException; 014import com.nimbusds.oauth2.sdk.http.HTTPRequest; 015import com.nimbusds.oauth2.sdk.token.BearerAccessToken; 016 017 018/** 019 * Client read request. 020 * 021 * <p>Example HTTP request: 022 * 023 * <pre> 024 * GET /register/s6BhdRkqt3 HTTP/1.1 025 * Accept: application/json 026 * Host: server.example.com 027 * Authorization: Bearer reg-23410913-abewfq.123483 028 * </pre> 029 * 030 * <p>Related specifications: 031 * 032 * <ul> 033 * <li>OAuth 2.0 Dynamic Client Registration Management Protocol (RFC 034 * 7592), section 2.1. 035 * <li>OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591), section 036 * 2. 037 * </ul> 038 */ 039@Immutable 040public class ClientReadRequest extends ProtectedResourceRequest { 041 042 043 /** 044 * Creates a new client read request. 045 * 046 * @param uri The URI of the client configuration endpoint. May 047 * be {@code null} if the {@link #toHTTPRequest()} 048 * method will not be used. 049 * @param accessToken An OAuth 2.0 Bearer access token for the request. 050 * Must not be {@code null}. 051 */ 052 public ClientReadRequest(final URI uri, final BearerAccessToken accessToken) { 053 054 super(uri, accessToken); 055 056 if (accessToken == null) 057 throw new IllegalArgumentException("The access token must not be null"); 058 } 059 060 061 @Override 062 public HTTPRequest toHTTPRequest() { 063 064 if (getEndpointURI() == null) 065 throw new SerializeException("The endpoint URI is not specified"); 066 067 URL endpointURL; 068 069 try { 070 endpointURL = getEndpointURI().toURL(); 071 072 } catch (MalformedURLException e) { 073 074 throw new SerializeException(e.getMessage(), e); 075 } 076 077 HTTPRequest httpRequest = new HTTPRequest(HTTPRequest.Method.GET, endpointURL); 078 httpRequest.setAuthorization(getAccessToken().toAuthorizationHeader()); 079 return httpRequest; 080 } 081 082 083 /** 084 * Parses a client read request from the specified HTTP GET request. 085 * 086 * @param httpRequest The HTTP request. Must not be {@code null}. 087 * 088 * @return The client read request. 089 * 090 * @throws ParseException If the HTTP request couldn't be parsed to a 091 * client read request. 092 */ 093 public static ClientReadRequest parse(final HTTPRequest httpRequest) 094 throws ParseException { 095 096 httpRequest.ensureMethod(HTTPRequest.Method.GET); 097 098 BearerAccessToken accessToken = BearerAccessToken.parse(httpRequest.getAuthorization()); 099 100 URI endpointURI; 101 102 try { 103 endpointURI = httpRequest.getURL().toURI(); 104 105 } catch (URISyntaxException e) { 106 107 throw new ParseException(e.getMessage(), e); 108 } 109 110 return new ClientReadRequest(endpointURI, accessToken); 111 } 112}