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.oauth2.sdk.id;
019
020
021import net.jcip.annotations.Immutable;
022
023
024/**
025 * Subject (user) identifier.
026 */
027@Immutable
028public final class Subject extends Identifier {
029
030
031        /**
032         * Creates a new subject identifier with the specified value.
033         *
034         * @param value The subject identifier value. Must not be {@code null}
035         *              or empty string.
036         */
037        public Subject(final String value) {
038
039                super(value);
040        }
041
042
043        /**
044         * Creates a new subject identifier with a randomly generated value of 
045         * the specified byte length, Base64URL-encoded.
046         *
047         * @param byteLength The byte length of the value to generate. Must be
048         *                   greater than one.
049         */
050        public Subject(final int byteLength) {
051        
052                super(byteLength);
053        }
054        
055        
056        /**
057         * Creates a new subject identifier with a randomly generated 256-bit 
058         * (32-byte) value, Base64URL-encoded.
059         */
060        public Subject() {
061
062                super();
063        }
064
065
066        @Override
067        public boolean equals(final Object object) {
068        
069                return object instanceof Subject &&
070                       this.toString().equals(object.toString());
071        }
072}