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;
019
020
021import net.jcip.annotations.Immutable;
022
023import com.nimbusds.oauth2.sdk.id.Identifier;
024
025
026/**
027 * OpenID Connect federation type.
028 */
029@Immutable
030public final class FederationType extends Identifier {
031        
032        
033        /**
034         * Automatic federation. No negotiation between the RP and the OP is
035         * made regarding what features the client should use in future
036         * requests to the OP. The RP's published metadata filtered by the
037         * chosen trust chain's metadata policies defines the metadata that is
038         * to be used.
039         */
040        public static final FederationType AUTOMATIC = new FederationType("automatic");
041        
042        
043        /**
044         * Explicit federation. The RP will access the
045         * {@code federation_registration_endpoint}, which provides the
046         * metadata for the RP to use. The OP may return a metadata policy that
047         * adds restrictions over and above what the trust chain already has
048         * defined.
049         */
050        public static final FederationType EXPLICIT = new FederationType("explicit");
051        
052        
053        /**
054         * Creates a new federation type with the specified identifier value.
055         *
056         * @param value The identifier value. Must not be {@code null}.
057         */
058        public FederationType(final String value) {
059                super(value);
060        }
061        
062        
063        @Override
064        public boolean equals(final Object object) {
065                
066                return object instanceof FederationType &&
067                        this.toString().equals(object.toString());
068        }
069}