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