com.nimbusds.openid.connect.sdk.claims.AggregatedClaims Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.
There is a newer version: 11.19
/*
 * 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.claims;


import java.util.Set;
import java.util.UUID;

import com.nimbusds.jwt.JWT;
import net.minidev.json.JSONObject;


/**
 * Aggregated OpenID claims set.
 *
 * Example aggregated claims (included in a UserInfo response):
 *
 * 
 * {
 *   "_claim_names"   : { "address"      : "src1",
 *                        "phone_number" : "src1" },
 *   "_claim_sources" : { "src1" : { "JWT" : "jwt_header.jwt_part2.jwt_part3" } }
 * }
 * 
 *
 * Related specifications:
 *
 * 

 *     OpenID Connect Core 1.0, sections 5.1 and 5.6.2.
 * 
 */
public class AggregatedClaims extends ExternalClaims {
	
	
	/**
	 * The claims JWT.
	 */
	private final JWT claimsJWT;
	
	
	/**
	 * Creates a new aggregated OpenID claims instance, the claims source
	 * identifier is set to a GUUID string.
	 *
	 * @param names     The claim names. Must not be {@code null} or empty.
	 * @param claimsJWT The claims JWT. Must not be {@code null}.
	 */
	public AggregatedClaims(final Set names, final JWT claimsJWT) {
		
		this(UUID.randomUUID().toString(), names, claimsJWT);
	}
	
	
	/**
	 * Creates a new aggregated OpenID claims instance.
	 *
	 * @param sourceID  Identifier for the claims source. Must not be
	 *                  {@code null} or empty string.
	 * @param names     The claim names. Must not be {@code null} or empty.
	 * @param claimsJWT The claims JWT. Must not be {@code null}.
	 */
	public AggregatedClaims(final String sourceID, final Set names, final JWT claimsJWT) {
		
		super(sourceID, names);
		
		if (claimsJWT == null) {
			throw new IllegalArgumentException("The claims JWT must not be null");
		}
		this.claimsJWT = claimsJWT;
	}
	
	
	/**
	 * Returns the claims JWT.
	 *
	 * @return The claims JWT.
	 */
	public JWT getClaimsJWT() {
		
		return claimsJWT;
	}
	
	
	@Override
	void mergeInto(final JSONObject jsonObject) {
		
		JSONObject claimNamesObject = new JSONObject();
		
		for (String name: getNames()) {
			claimNamesObject.put(name, getSourceID());
		}
		
		if (jsonObject.containsKey("_claim_names")) {
			((JSONObject) jsonObject.get("_claim_names")).putAll(claimNamesObject);
		} else {
			jsonObject.put("_claim_names", claimNamesObject);
		}
		
		
		JSONObject sourceSpec = new JSONObject();
		sourceSpec.put("JWT", getClaimsJWT().serialize());
		JSONObject claimSourcesObject = new JSONObject();
		claimSourcesObject.put(getSourceID(), sourceSpec);
		
		if (jsonObject.containsKey("_claim_sources")) {
			((JSONObject) jsonObject.get("_claim_sources")).putAll(claimSourcesObject);
		} else {
			jsonObject.put("_claim_sources", claimSourcesObject);
		}
	}
}