com.authlete.jakarta.DeviceAuthorizationPageModel Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2019 Authlete, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the
 * License.
 */
package com.authlete.jakarta;


import java.io.Serializable;
import com.authlete.common.dto.DeviceVerificationResponse;
import com.authlete.common.dto.Scope;


/**
 * Model class to hold data which are referred to in an authorization page in device
 * flow.
 *
 * 
 * Feel free to extend this class as necessary.
 * 
 *
 * @since 2.18
 *
 * @author Hideki Ikeda
 */
public class DeviceAuthorizationPageModel implements Serializable
{
    private static final long serialVersionUID = 1L;


    /**
     * The ID of the client application to which the user code has been issued.
     */
    private long clientId;


    /**
     * The client ID alias of the client application to which the user code has
     * been issued.
     */
    private String clientIdAlias;


    /**
     * The flag which indicates whether the client ID alias was used in the device
     * authorization request for the user code.
     */
    private boolean clientIdAliasUsed;


    /**
     * The name of the client application to which the user code has been issued.
     */
    private String clientName;


    /**
     * Scopes requested by the device authorization request for the user code.
     */
    private Scope[] scopes;


    /**
     * The default constructor with default values.
     */
    public DeviceAuthorizationPageModel()
    {
    }


    /**
     * Create an {@link DeviceAuthorizationPageModel} instance using information
     * contained in an {@link DeviceVerificationResponse} object, which represents
     * a response from Authlete's {@code /api/device/verification} API.
     *
     * @param info
     *         An {@link DeviceVerificationResponse} object, which represents a
     *         response from Authlete's {@code /api/device/verification} API.
     */
    public DeviceAuthorizationPageModel(DeviceVerificationResponse info)
    {
        clientId          = info.getClientId();
        clientIdAlias     = info.getClientIdAlias();
        clientIdAliasUsed = info.isClientIdAliasUsed();
        clientName        = info.getClientName();
        scopes            = info.getScopes();
    }


    /**
     * Get the client ID of the client application to which the user code has
     * been issued.
     *
     * @return
     *         The client ID of the client application.
     */
    public long getClientId()
    {
        return clientId;
    }


    /**
     * Set the client ID of the client application to which the user code has
     * been issued.
     *
     * @param clientId
     *         The client ID of the client application.
     *
     * @return
     *         {@code this} object.
     */
    public DeviceAuthorizationPageModel setClientId(long clientId)
    {
        this.clientId = clientId;

        return this;
    }


    /**
     * Get the client ID alias of the client application to which the user code
     * has been issued.
     *
     * @return
     *         The client ID alias of the client application.
     */
    public String getClientIdAlias()
    {
        return clientIdAlias;
    }


    /**
     * Set the client ID alias of the client application to which the user code
     * has been issued.
     *
     * @param alias
     *         The client ID alias of the client application.
     *
     * @return
     *         {@code this} object.
     */
    public DeviceAuthorizationPageModel setClientIdAlias(String alias)
    {
        this.clientIdAlias = alias;

        return this;
    }


    /**
     * Get the flag which indicates whether the client ID alias was used in
     * the device authorization request for the user code.
     *
     * @return
     *         {@code true} if the client ID alias was used in the request.
     */
    public boolean isClientIdAliasUsed()
    {
        return clientIdAliasUsed;
    }


    /**
     * Set the flag which indicates whether the client ID alias was used in
     * the device authorization request for the user code.
     *
     * @param used
     *         {@code true} to indicate that the client ID alias was used in
     *         the request.
     *
     * @return
     *         {@code this} object.
     */
    public DeviceAuthorizationPageModel setClientIdAliasUsed(boolean used)
    {
        this.clientIdAliasUsed = used;

        return this;
    }


    /**
     * Get the client identifier used in the device authorization request for
     * the user code.
     *
     * 
     * When {@link #isClientIdAliasUsed()} returns {@code true}, this method
     * returns the same value as {@link #getClientIdAlias()} does. Otherwise,
     * this method returns the string representation of the value returned
     * from {@link #getClientId()}.
     * 
     *
     * @return
     *         The client identifier used in the device authorization request
     *         for the user code.
     */
    public String getClientIdentifier()
    {
        if (clientIdAliasUsed)
        {
            return clientIdAlias;
        }
        else
        {
            return String.valueOf(clientId);
        }
    }


    /**
     * Get the name of the client application.
     *
     * @return
     *         The name of the client application.
     */
    public String getClientName()
    {
        return clientName;
    }


    /**
     * Set the name of the client application.
     *
     * @param clientName
     *         The name of the client application.
     *
     * @return
     *         {@code this} object.
     */
    public DeviceAuthorizationPageModel setClientName(String clientName)
    {
        this.clientName = clientName;

        return this;
    }


    /**
     * Get the list of scopes requested by the device authorization request for
     * the user code.
     *
     * @return
     *         The list of requested scopes.
     */
    public Scope[] getScopes()
    {
        return scopes;
    }


    /**
     * Set the list of scopes requested by the device authorization request for
     * the user code.
     *
     * @param scopes
     *         The list of requested scopes.
     *
     * @return
     *         {@code this} object.
     */
    public DeviceAuthorizationPageModel setScopes(Scope[] scopes)
    {
        this.scopes = scopes;

        return this;
    }
}