com.authlete.common.assurance.constraint.LeafConstraint 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) 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.common.assurance.constraint;


import java.util.Arrays;
import java.util.List;
import java.util.Map;


/**
 * The class that represents the basic set of constraints defined in "5.5.1. Individual Claims Requests".
 *
 *  * {
 *   "essential": boolean,
 *   "value": string,
 *   "values": string array
 * }
 * 
 *
 * @since 2.63
 */
public class LeafConstraint extends BaseConstraint
{
    private boolean essential;
    private String value;
    private String[] values;
    private boolean essentialExists;
    private boolean valueExists;
    private boolean valuesExists;


    /**
     * Get the value of {@code "essential"}
     *
     * @return
     *         The value of {@code "essential"}.
     */
    public boolean isEssential()
    {
        return essential;
    }


    /**
     * Set the value of {@code "essential"}
     *
     * @param essential
     *         The value of {@code "essential"}.
     */
    public void setEssential(boolean essential)
    {
        this.essential = essential;
    }


    /**
     * Get the value of {@code "value"}.
     *
     * @return
     *         The value of {@code "value"}.
     */
    public String getValue()
    {
        return value;
    }


    /**
     * Set the value of {@code "value"}.
     *
     * @param value
     *         The value of {@code "value"}.
     */
    public void setValue(String value)
    {
        this.value = value;
    }


    /**
     * Get the value of {@code "values"}.
     *
     * @return
     *         The value of {@code "values"}.
     */
    public String[] getValues()
    {
        return values;
    }


    /**
     * Set the value of {@code "values"}.
     *
     * @param value
     *         The value of {@code "values"}.
     */
    public void setValues(String[] values)
    {
        this.values = values;
    }


    /**
     * Create a {@code LeafConstraint} instance from an object in the given map.
     *
     * @param map
     *         A map that may contain a constraint.
     *
     * @param key
     *         The key that identifies the object in the map.
     *
     * @return
     *         A {@code LeafConstraint} instance that represents a constraint.
     *         Even if the map does not contain the given key, an instance of
     *         {@code LeafConstraint} is returned.
     *
     * @throws ConstraintException
     *         The structure of the map does not conform to the specification
     *         (OpenID Connect for Identity Assurance 1.0).
     */
    public static LeafConstraint extract(Map map, String key) throws ConstraintException
    {
        LeafConstraint instance = new LeafConstraint();
        instance.setExists(map.containsKey(key));

        if (instance.exists())
        {
            fill(instance, map.get(key), key);
        }

        return instance;
    }


    static void fill(LeafConstraint instance, Object object, String key)
    {
        if (object == null)
        {
            instance.setNull(true);
            return;
        }

        Map map = Helper.ensureMap(object, key);

        fillEssential(instance, map);
        fillValue(instance, map);
        fillValues(instance, map);
    }


    private static void fillEssential(LeafConstraint instance, Map map)
    {
        instance.essentialExists = map.containsKey("essential");

        if (instance.essentialExists)
        {
            instance.essential = extractBoolean(map, "essential");
        }
    }


    private static boolean extractBoolean(Map map, String key)
    {
        Object value = map.get(key);

        return Helper.ensureBoolean(value, key);
    }


    private static void fillValue(LeafConstraint instance, Map map)
    {
        instance.valueExists = map.containsKey("value");

        if (instance.valueExists)
        {
            instance.value = extractString(map, "value");
        }
    }


    static String extractString(Map map, String key)
    {
        Object value = map.get(key);

        if (value == null)
        {
            return null;
        }

        return Helper.ensureString(value, key);
    }


    private static void fillValues(LeafConstraint instance, Map map)
    {
        instance.valuesExists = map.containsKey("values");

        if (instance.valuesExists)
        {
            instance.values = extractStringArray(map, "values");
        }
    }


    private static String[] extractStringArray(Map map, String key)
    {
        Object value = map.get(key);

        if (value == null)
        {
            return null;
        }

        List list = Helper.ensureList(value, key);
        int size = list.size();

        String[] array = new String[size];

        for (int i = 0; i < size; ++i)
        {
            Object element = list.get(i);

            if (element != null && !(element instanceof String))
            {
                throw Helper.exception("'%s[%d]' is not a string.", key, i);
            }

            array[i] = (String)element;
        }

        return array;
    }


    @Override
    public Map toMap()
    {
        Map map = super.toMap();

        if (map == null)
        {
            return null;
        }

        if (essentialExists)
        {
            map.put("essential", Boolean.valueOf(essential));
        }

        if (valueExists)
        {
            map.put("value", value);
        }

        if (valuesExists)
        {
            List list = (values == null) ? null : Arrays.asList(values);
            map.put("values", list);
        }

        return map;
    }
}