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.assurance.evidences;
019
020
021import net.jcip.annotations.Immutable;
022
023import com.nimbusds.oauth2.sdk.id.Identifier;
024
025
026/**
027 * Identity evidence type.
028 *
029 * <ul>
030 *     <li>OpenID Connect for Identity Assurance 1.0, section 5.1.1.
031 * </ul>
032 */
033@Immutable
034public final class IdentityEvidenceType extends Identifier {
035        
036        
037        private static final long serialVersionUID = -8665674793321133128L;
038        
039        
040        /**
041         * Verification based on a physical or electronic document provided by
042         * the end-user.
043         */
044        public static final IdentityEvidenceType DOCUMENT = new IdentityEvidenceType("document");
045        
046        
047        /**
048         * Verification based on a government issued identity document.
049         *
050         * @deprecated Use {@link #DOCUMENT} instead.
051         */
052        @Deprecated
053        public static final IdentityEvidenceType ID_DOCUMENT = new IdentityEvidenceType("id_document");
054        
055        
056        /**
057         * Verification based on data or information obtained electronically
058         * from an approved or recognised source.
059         */
060        public static final IdentityEvidenceType ELECTRONIC_RECORD = new IdentityEvidenceType("electronic_record");
061        
062        
063        /**
064         * Verification based on an attestation or reference given by an
065         * approved or recognised person declaring they believe to the best of
066         * their knowledge that the claim(s) are genuine and true.
067         */
068        public static final IdentityEvidenceType VOUCH = new IdentityEvidenceType("vouch");
069        
070        
071        /**
072         * Verification based on a utility bill.
073         */
074        public static final IdentityEvidenceType UTILITY_BILL = new IdentityEvidenceType("utility_bill");
075        
076        
077        /**
078         * Verification based on an electronic signature.
079         */
080        public static final IdentityEvidenceType ELECTRONIC_SIGNATURE = new IdentityEvidenceType("electronic_signature");
081        
082        
083        /**
084         * Verification based on a eIDAS Qualified Electronic Signature.
085         *
086         * @deprecated Use {@link #ELECTRONIC_SIGNATURE} instead.
087         */
088        @Deprecated
089        public static final IdentityEvidenceType QES = new IdentityEvidenceType("qes");
090        
091        
092        /**
093         * Creates a new identity evidence type.
094         *
095         * @param value The identity evidence type value. Must not be
096         *              {@code null}.
097         */
098        public IdentityEvidenceType(final String value) {
099                super(value);
100        }
101        
102        
103        @Override
104        public boolean equals(final Object object) {
105                
106                return object instanceof IdentityEvidenceType &&
107                        this.toString().equals(object.toString());
108        }
109}