com.authlete.common.dto.Scope Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of authlete-java-common Show documentation
Authlete Java library used commonly by service implementations and the Authlete server.
The newest version!
/*
 * Copyright (C) 2014-2018 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.common.dto;


import java.io.Serializable;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;


/**
 * Information about a scope of a service.
 *
 * @see  RFC 6749 (OAuth 2.0), 3.3. Access Token Scope
 *
 * @author Takahiko Kawasaki
 */
public class Scope implements Serializable
{
    private static final long serialVersionUID = 3L;


    /*
     * Do not change variable names. They must match the variable names
     * in JSONs which are exchanged between clients and Authlete server.
     */


    /**
     * Scope name.
     */
    private String name;


    /**
     * Flag that indicates whether this scope is included in
     * the default scope list.
     */
    private boolean defaultEntry;


    /**
     * Description of this scope.
     */
    private String description;


    /**
     * Descriptions for various languages.
     */
    private TaggedValue[] descriptions;


    /**
     * Attributes of this scope.
     */
    private Pair[] attributes;


    /**
     * Get the scope name.
     *
     * @return
     *         The scope name.
     *
     * @see  RFC 6749 (OAuth 2.0), 3.3. Access Token Scope
     */
    public String getName()
    {
        return name;
    }


    /**
     * Set the scope name.
     *
     * @param name
     *         The scope name.
     *
     * @return
     *         {@code this} object.
     *
     * @see  RFC 6749 (OAuth 2.0), 3.3. Access Token Scope
     */
    public Scope setName(String name)
    {
        this.name = name;

        return this;
    }


    /**
     * Get the flag that indicates whether this scope is included in
     * the default scope list.
     *
     * @return
     *         {@code true} if this scope is included in the default
     *         scope list. Otherwise, {@code false}.
     */
    public boolean isDefaultEntry()
    {
        return defaultEntry;
    }


    /**
     * Set the flag that indicates whether this scope is included in
     * the default scope list.
     *
     * @param defaultEntry
     *         {@code true} to include this scope in the default scope list.
     *         Otherwise, {@code false}.
     *
     * @return
     *         {@code this} object.
     */
    public Scope setDefaultEntry(boolean defaultEntry)
    {
        this.defaultEntry = defaultEntry;

        return this;
    }


    /**
     * Get the description.
     *
     * @return
     *         The description.
     */
    public String getDescription()
    {
        return description;
    }


    /**
     * Set the description.
     *
     * @param description
     *         The description.
     *
     * @return
     *         {@code this} object.
     */
    public Scope setDescription(String description)
    {
        this.description = description;

        return this;
    }


    /**
     * Get descriptions for various languages.
     *
     * @return
     *         Descriptions.
     *
     * @since 1.5
     */
    public TaggedValue[] getDescriptions()
    {
        return descriptions;
    }


    /**
     * Set descriptions for various languages.
     *
     * @param descriptions
     *         Descriptions.
     *
     * @return
     *         {@code this} object.
     *
     * @since 1.5
     */
    public Scope setDescriptions(TaggedValue[] descriptions)
    {
        this.descriptions = descriptions;

        return this;
    }


    /**
     * Get attributes.
     *
     * @return
     *         Attributes.
     *
     * @since 2.12
     */
    public Pair[] getAttributes()
    {
        return attributes;
    }


    /**
     * Set attributes.
     *
     * @param attributes
     *         Attributes.
     *
     * @return
     *     {@code this} object.
     *
     * @since 2.12
     */
    public Scope setAttributes(Pair[] attributes)
    {
        this.attributes = attributes;

        return this;
    }


    /**
     * Set attributes.
     *
     * @param attributes
     *         Attributes.
     *
     * @return
     *     {@code this} object.
     *
     * @since 2.12
     */
    public Scope setAttributes(Iterable attributes)
    {
        if (attributes == null)
        {
            this.attributes = null;

            return this;
        }

        List list = new ArrayList();

        for (Pair attribute : attributes)
        {
            if (attribute == null || attribute.getKey() == null)
            {
                continue;
            }

            list.add(attribute);
        }

        int size = list.size();

        if (size == 0)
        {
            this.attributes = null;

            return this;
        }

        Pair[] array = new Pair[size];
        this.attributes = list.toArray(array);

        return this;
    }


    /**
     * Extract scope names.
     *
     * @param scopes
     *         Scopes.
     *
     * @return
     *         Scope names. If {@code scopes} is {@code null},
     *         {@code null} is returned.
     */
    public static String[] extractNames(Scope[] scopes)
    {
        if (scopes == null)
        {
            return null;
        }

        // Create an array for scope names.
        String[] names = new String[scopes.length];

        // For each scope.
        for (int i = 0; i < scopes.length; ++i)
        {
            // Scope at the index.
            Scope scope = scopes[i];

            // Extract the scope name.
            names[i] = (scope == null) ? null : scope.getName();
        }

        // Extracted scope names.
        return names;
    }


    /**
     * Comparator based on scope names.
     *
     * @since 1.7
     */
    public static class NameComparator implements Comparator, Serializable
    {
        private static final long serialVersionUID = 1L;

        @Override
        public int compare(Scope a, Scope b)
        {
            if (a == null)
            {
                if (b == null)
                {
                    return 0;
                }
                else
                {
                    return -1;
                }
            }
            else
            {
                if (b == null)
                {
                    return 1;
                }
                else
                {
                    return compareNames(a.getName(), b.getName());
                }
            }
        }


        private int compareNames(String a, String b)
        {
            if (a == null)
            {
                if (b == null)
                {
                    return 0;
                }
                else
                {
                    return -1;
                }
            }
            else
            {
                if (b == null)
                {
                    return 1;
                }
                else
                {
                    return a.compareTo(b);
                }
            }
        }
    }
}