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.entities;
019
020
021import net.jcip.annotations.Immutable;
022
023import com.nimbusds.oauth2.sdk.id.Identifier;
024
025
026/**
027 * Federation metadata type.
028 *
029 * <p>Related specifications:
030 *
031 * <ul>
032 *     <li>OpenID Connect Federation 1.0, section 3.
033 * </ul>
034 */
035@Immutable
036public final class FederationMetadataType extends Identifier {
037        
038        
039        /**
040         * OpenID relying party ({@code openid_relying_party}).
041         */
042        public static final FederationMetadataType OPENID_RELYING_PARTY = new FederationMetadataType("openid_relying_party");
043        
044        
045        /**
046         * OpenID provider ({@code openid_provider}).
047         */
048        public static final FederationMetadataType OPENID_PROVIDER = new FederationMetadataType("openid_provider");
049        
050        
051        /**
052         * OAuth authorisation server ({@code oauth_authorization_server}).
053         */
054        public static final FederationMetadataType OAUTH_AUTHORIZATION_SERVER = new FederationMetadataType("oauth_authorization_server");
055        
056        
057        /**
058         * OAuth client ({@code oauth_client}).
059         */
060        public static final FederationMetadataType OAUTH_CLIENT = new FederationMetadataType("oauth_client");
061        
062        
063        /**
064         * OAuth protected resource ({@code oauth_resource}).
065         */
066        public static final FederationMetadataType OAUTH_RESOURCE = new FederationMetadataType("oauth_resource");
067        
068        
069        /**
070         * Federation entity ({@code federation_entity}).
071         */
072        public static final FederationMetadataType FEDERATION_ENTITY = new FederationMetadataType("federation_entity");
073        
074        
075        /**
076         * Creates a new federation metadata type.
077         *
078         * @param value The metadata type value. Must not be {@code null}.
079         */
080        public FederationMetadataType(final String value) {
081                super(value);
082        }
083        
084        
085        @Override
086        public boolean equals(final Object object) {
087                
088                return object instanceof FederationMetadataType &&
089                        this.toString().equals(object.toString());
090        }
091}