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.device;
019
020
021import net.jcip.annotations.Immutable;
022
023import com.nimbusds.oauth2.sdk.id.Identifier;
024
025
026/**
027 * Device code.
028 *
029 * <p>Related specifications:
030 *
031 * <ul>
032 *     <li>OAuth 2.0 Device Authorization Grant (RFC 8628)
033 * </ul>
034 */
035@Immutable
036public final class DeviceCode extends Identifier {
037        
038        
039        private static final long serialVersionUID = 5165818656410539254L;
040        
041        
042        /**
043         * Creates a new device code with the specified value.
044         *
045         * @param value The code value. Must not be {@code null} or empty
046         *              string.
047         */
048        public DeviceCode(final String value) {
049
050                super(value);
051        }
052
053
054        /**
055         * Creates a new device code with a randomly generated value of the
056         * specified byte length, Base64URL-encoded.
057         *
058         * @param byteLength The byte length of the value to generate. Must be
059         *                   greater than one.
060         */
061        public DeviceCode(final int byteLength) {
062
063                super(byteLength);
064        }
065
066
067        /**
068         * Creates a new device code with a randomly generated 256-bit (32-byte)
069         * value, Base64URL-encoded.
070         */
071        public DeviceCode() {
072
073                super();
074        }
075
076
077        @Override
078        public boolean equals(final Object object) {
079
080                return object instanceof DeviceCode && this.toString().equals(object.toString());
081        }
082}