001/*
002 * oauth2-oidc-sdk
003 *
004 * Copyright 2012-2016, Connect2id Ltd and contributors.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.openid.connect.sdk.federation.config;
019
020
021import net.jcip.annotations.Immutable;
022
023import com.nimbusds.oauth2.sdk.AbstractConfigurationRequest;
024import com.nimbusds.openid.connect.sdk.federation.entities.EntityID;
025
026
027/**
028 * Federation entity configuration request.
029 *
030 * <p>Example HTTP request:
031 *
032 * <pre>
033 * GET /.well-known/openid-federation HTTP/1.1
034 * Host: example.com
035 * </pre>
036 *
037 * <p>Related specifications:
038 *
039 * <ul>
040 *     <li>OpenID Connect Federation 1.0, section 5.1.
041 * </ul>
042 */
043@Immutable
044public class FederationEntityConfigurationRequest extends AbstractConfigurationRequest {
045        
046        
047        /**
048         * The well-known path for federation entity metadata.
049         */
050        public static final String OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH = "/.well-known/openid-federation";
051        
052        
053        /**
054         * Creates a new federation entity configuration request.
055         *
056         * @param entityID The entity ID. Must represent a valid URL. Must not
057         *                 be {@code null}.
058         */
059        public FederationEntityConfigurationRequest(final EntityID entityID) {
060                super(entityID.toURI(), OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH);
061        }
062}