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 (draft-ietf-oauth-device-flow-15)
033 * </ul>
034 */
035@Immutable
036public final class DeviceCode extends Identifier {
037
038        
039        /**
040         * Creates a new device code with the specified value.
041         *
042         * @param value The code value. Must not be {@code null} or empty
043         *              string.
044         */
045        public DeviceCode(final String value) {
046
047                super(value);
048        }
049
050
051        /**
052         * Creates a new device code with a randomly generated value of the
053         * specified byte length, Base64URL-encoded.
054         *
055         * @param byteLength The byte length of the value to generate. Must be
056         *                   greater than one.
057         */
058        public DeviceCode(final int byteLength) {
059
060                super(byteLength);
061        }
062
063
064        /**
065         * Creates a new device code with a randomly generated 256-bit (32-byte)
066         * value, Base64URL-encoded.
067         */
068        public DeviceCode() {
069
070                super();
071        }
072
073
074        @Override
075        public boolean equals(final Object object) {
076
077                return object instanceof DeviceCode && this.toString().equals(object.toString());
078        }
079}