com.nimbusds.openid.connect.sdk.UserInfoSuccessResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing client
and server applications.
/*
* 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 javax.mail.internet.ContentType;
import net.jcip.annotations.Immutable;
import com.nimbusds.jwt.JWT;
import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.SerializeException;
import com.nimbusds.oauth2.sdk.SuccessResponse;
import com.nimbusds.oauth2.sdk.http.CommonContentTypes;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.openid.connect.sdk.claims.UserInfo;
/**
* UserInfo success response.
*
* The UserInfo claims may be passed as an unprotected JSON object or as a
* plain, signed or encrypted JSON Web Token (JWT). Use the appropriate
* constructor for that.
*
*
Example UserInfo HTTP response:
*
*
* HTTP/1.1 200 OK
* Content-Type: application/json
*
* {
* "sub" : "248289761001",
* "name" : "Jane Doe"
* "given_name" : "Jane",
* "family_name" : "Doe",
* "email" : "[email protected]",
* "picture" : "http://example.com/janedoe/me.jpg"
* }
*
*
* Related specifications:
*
*
* - OpenID Connect Core 1.0, section 5.3.2.
*
*/
@Immutable
public class UserInfoSuccessResponse
extends UserInfoResponse
implements SuccessResponse {
/**
* The UserInfo claims set, serialisable to a JSON object.
*/
private final UserInfo claimsSet;
/**
* The UserInfo claims set, as plain, signed or encrypted JWT.
*/
private final JWT jwt;
/**
* Creates a new UserInfo success response where the claims are
* specified as an unprotected UserInfo claims set.
*
* @param claimsSet The UserInfo claims set. Must not be {@code null}.
*/
public UserInfoSuccessResponse(final UserInfo claimsSet) {
if (claimsSet == null)
throw new IllegalArgumentException("The claims must not be null");
this.claimsSet = claimsSet;
this.jwt = null;
}
/**
* Creates a new UserInfo success response where the claims are
* specified as a plain, signed or encrypted JSON Web Token (JWT).
*
* @param jwt The UserInfo claims set. Must not be {@code null}.
*/
public UserInfoSuccessResponse(final JWT jwt) {
if (jwt == null)
throw new IllegalArgumentException("The claims JWT must not be null");
this.jwt = jwt;
this.claimsSet = null;
}
@Override
public boolean indicatesSuccess() {
return true;
}
/**
* Gets the content type of this UserInfo response.
*
* @return The content type, according to the claims format.
*/
public ContentType getContentType() {
if (claimsSet != null)
return CommonContentTypes.APPLICATION_JSON;
else
return CommonContentTypes.APPLICATION_JWT;
}
/**
* Gets the UserInfo claims set as an unprotected UserInfo claims set.
*
* @return The UserInfo claims set, {@code null} if it was specified as
* JSON Web Token (JWT) instead.
*/
public UserInfo getUserInfo() {
return claimsSet;
}
/**
* Gets the UserInfo claims set as a plain, signed or encrypted JSON
* Web Token (JWT).
*
* @return The UserInfo claims set as a JSON Web Token (JWT),
* {@code null} if it was specified as an unprotected UserInfo
* claims set instead.
*/
public JWT getUserInfoJWT() {
return jwt;
}
@Override
public HTTPResponse toHTTPResponse() {
HTTPResponse httpResponse = new HTTPResponse(HTTPResponse.SC_OK);
httpResponse.setContentType(getContentType());
String content;
if (claimsSet != null) {
content = claimsSet.toJSONObject().toString();
} else {
try {
content = jwt.serialize();
} catch (IllegalStateException e) {
throw new SerializeException("Couldn't serialize UserInfo claims JWT: " +
e.getMessage(), e);
}
}
httpResponse.setContent(content);
return httpResponse;
}
/**
* Parses a UserInfo response from the specified HTTP response.
*
* Example HTTP response:
*
*
* HTTP/1.1 200 OK
* Content-Type: application/json
*
* {
* "sub" : "248289761001",
* "name" : "Jane Doe"
* "given_name" : "Jane",
* "family_name" : "Doe",
* "email" : "[email protected]",
* "picture" : "http://example.com/janedoe/me.jpg"
* }
*
*
* @param httpResponse The HTTP response. Must not be {@code null}.
*
* @return The UserInfo response.
*
* @throws ParseException If the HTTP response couldn't be parsed to a
* UserInfo response.
*/
public static UserInfoSuccessResponse parse(final HTTPResponse httpResponse)
throws ParseException {
httpResponse.ensureStatusCode(HTTPResponse.SC_OK);
httpResponse.ensureContentType();
ContentType ct = httpResponse.getContentType();
UserInfoSuccessResponse response;
if (ct.match(CommonContentTypes.APPLICATION_JSON)) {
UserInfo claimsSet;
try {
claimsSet = new UserInfo(httpResponse.getContentAsJSONObject());
} catch (Exception e) {
throw new ParseException("Couldn't parse UserInfo claims: " +
e.getMessage(), e);
}
response = new UserInfoSuccessResponse(claimsSet);
}
else if (ct.match(CommonContentTypes.APPLICATION_JWT)) {
JWT jwt;
try {
jwt = httpResponse.getContentAsJWT();
} catch (ParseException e) {
throw new ParseException("Couldn't parse UserInfo claims JWT: " +
e.getMessage(), e);
}
response = new UserInfoSuccessResponse(jwt);
}
else {
throw new ParseException("Unexpected Content-Type, must be " +
CommonContentTypes.APPLICATION_JSON +
" or " +
CommonContentTypes.APPLICATION_JWT);
}
return response;
}
}