com.nimbusds.openid.connect.sdk.claims.ExternalClaims 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 net.minidev.json.JSONObject;


/**
 * The base abstract class for aggregated and distributed OpenID claims.
 */
abstract class ExternalClaims {
	
	
	/**
	 * Identifier for the claims source.
	 */
	private final String sourceID;
	
	
	/**
	 * The claim names.
	 */
	private final Set names;
	
	
	/**
	 * Creates a new external 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.
	 */
	protected ExternalClaims(final String sourceID, final Set names) {
		
		if (sourceID == null || sourceID.trim().isEmpty()) {
			throw new IllegalArgumentException("The claims source identifier must not be null or empty");
		}
		
		this.sourceID = sourceID;
		
		if (names == null || names.isEmpty()) {
			throw new IllegalArgumentException("The claim names must not be null or empty");
		}
		
		this.names = names;
	}
	
	
	/**
	 * Returns the identifier for this claims source.
	 *
	 * @return The source identifier.
	 */
	public String getSourceID() {
		
		return sourceID;
	}
	
	
	/**
	 * Returns the claim names.
	 *
	 * @return The claim names.
	 */
	public Set getNames() {
		
		return names;
	}
	
	
	/**
	 * Merges this external claims instance into the specified JSON object.
	 *
	 * @param jsonObject The JSON object. Must not be {@code null}.
	 */
	abstract void mergeInto(final JSONObject jsonObject);
}