com.nimbusds.openid.connect.sdk.federation.trust.constraints.EntityIDConstraint 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

OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.

There is a newer version: 11.19.1

/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2020, 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.federation.trust.constraints;


import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.openid.connect.sdk.federation.entities.EntityID;


/**
 * Entity ID constraint.
 *
 * Related specifications:
 *
 * 

 *     OpenID Connect Federation 1.0, section 5.2.2.
 *     
RFC 5280, section 4.2.1.10.
 * 
 */
public abstract class EntityIDConstraint {
	
	
	/**
	 * Matches an entity ID with this constraint.
	 *
	 * @param entityID The entity ID to match. Must not be {@code null}.
	 *
	 * @return {@code true} if this constraint matches the specified entity
	 *         ID, else {@code false}.
	 */
	public abstract boolean matches(final EntityID entityID);
	
	
	@Override
	public abstract String toString();
	
	
	@Override
	public abstract boolean equals(final Object other);
	
	
	/**
	 * Parses an entity ID constraint.
	 *
	 * @param value The string value.
	 *
	 * @return The parsed {@link ExactMatchEntityIDConstraint} or
	 *         {@link SubtreeEntityIDConstraint}.
	 *
	 * @throws ParseException If parsing failed.
	 */
	public static EntityIDConstraint parse(final String value)
		throws ParseException {
		
		try {
			return new SubtreeEntityIDConstraint(value);
		} catch (IllegalArgumentException e) {
			try {
				return new ExactMatchEntityIDConstraint(new EntityID(value));
			} catch (IllegalArgumentException e2) {
				throw new ParseException(e2.getMessage(), e2);
			}
		}
	}
}