All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nimbusds.openid.connect.sdk.UserInfoRequest Maven / Gradle / Ivy

/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2016, Connect2id Ltd and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.openid.connect.sdk;


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.CommonContentTypes;
import com.nimbusds.oauth2.sdk.http.HTTPRequest;
import com.nimbusds.oauth2.sdk.token.BearerAccessToken;


/**
 * UserInfo request. Used to retrieve the consented claims about the end-user.
 *
 * 

Example HTTP GET request: * *

 * GET /userinfo HTTP/1.1
 * Host: server.example.com
 * Authorization: Bearer SlAV32hkKG
 * 
* *

Related specifications: * *

    *
  • OpenID Connect Core 1.0, section 5.3.1. *
  • OAuth 2.0 Bearer Token Usage (RFC6750), section 2. *
*/ @Immutable public class UserInfoRequest extends ProtectedResourceRequest { /** * The HTTP method. */ private final HTTPRequest.Method httpMethod; /** * Creates a new UserInfo HTTP GET request. * * @param uri The URI of the UserInfo 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 UserInfoRequest(final URI uri, final BearerAccessToken accessToken) { this(uri, HTTPRequest.Method.GET, accessToken); } /** * Creates a new UserInfo request. * * @param uri The URI of the UserInfo endpoint. May be * {@code null} if the {@link #toHTTPRequest} method * will not be used. * @param httpMethod The HTTP method. Must be HTTP GET or POST and not * {@code null}. * @param accessToken An OAuth 2.0 Bearer access token for the request. * Must not be {@code null}. */ public UserInfoRequest(final URI uri, final HTTPRequest.Method httpMethod, final BearerAccessToken accessToken) { super(uri, accessToken); if (httpMethod == null) throw new IllegalArgumentException("The HTTP method must not be null"); this.httpMethod = httpMethod; if (accessToken == null) throw new IllegalArgumentException("The access token must not be null"); } /** * Gets the HTTP method for this UserInfo request. * * @return The HTTP method. */ public HTTPRequest.Method getMethod() { return httpMethod; } @Override public HTTPRequest toHTTPRequest() { 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(httpMethod, endpointURL); switch (httpMethod) { case GET: httpRequest.setAuthorization(getAccessToken().toAuthorizationHeader()); break; case POST: httpRequest.setContentType(CommonContentTypes.APPLICATION_URLENCODED); httpRequest.setQuery("access_token=" + getAccessToken().getValue()); break; default: throw new SerializeException("Unexpected HTTP method: " + httpMethod); } return httpRequest; } /** * Parses the specified HTTP request for a UserInfo request. * * @param httpRequest The HTTP request. Must not be {@code null}. * * @return The UserInfo request. * * @throws ParseException If the HTTP request couldn't be parsed to a * UserInfo request. */ public static UserInfoRequest parse(final HTTPRequest httpRequest) throws ParseException { HTTPRequest.Method httpMethod = httpRequest.getMethod(); BearerAccessToken accessToken = BearerAccessToken.parse(httpRequest); URI endpointURI; try { endpointURI = httpRequest.getURL().toURI(); } catch (URISyntaxException e) { throw new ParseException(e.getMessage(), e); } return new UserInfoRequest(endpointURI, httpMethod, accessToken); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy