com.nimbusds.openid.connect.sdk.federation.config.FederationEntityConfigurationRequest 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.1

/*
 * 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.federation.config;


import net.jcip.annotations.Immutable;

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


/**
 * Federation entity configuration request.
 *
 * Example HTTP request:
 *
 * 
 * GET /.well-known/openid-federation HTTP/1.1
 * Host: example.com
 * 
 *
 * Related specifications:
 *
 * 

 *     OpenID Connect Federation 1.0, section 6.1.
 * 
 */
@Immutable
public class FederationEntityConfigurationRequest extends AbstractConfigurationRequest {
	
	
	/**
	 * The well-known path for federation entity metadata.
	 */
	public static final String OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH = "/.well-known/openid-federation";
	
	
	/**
	 * Creates a new federation entity configuration request using the
	 * {@link WellKnownPathComposeStrategy#POSTFIX postfix well-known path
	 * composition strategy}.
	 *
	 * @param entityID The entity ID. Must represent a valid URL. Must not
	 *                 be {@code null}.
	 */
	public FederationEntityConfigurationRequest(final EntityID entityID) {
		this(entityID, WellKnownPathComposeStrategy.POSTFIX);
	}
	
	
	/**
	 * Creates a new federation entity configuration request.
	 *
	 * @param entityID The entity ID. Must represent a valid URL. Must not
	 *                 be {@code null}.
	 * @param strategy The well-known path composition strategy. Must not
	 *                 be {@code null}.
	 */
	public FederationEntityConfigurationRequest(final EntityID entityID, final WellKnownPathComposeStrategy strategy) {
		super(entityID.toURI(), OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH, strategy);
	}
}