com.yoti.api.client.Profile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yoti-sdk-api Show documentation
Java SDK for simple integration with the Yoti platform
The newest version!
package com.yoti.api.client;

import static java.util.Collections.unmodifiableMap;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

/**
 * Yoti profile for a connect token and application. You can get a hold of one of these by using a {@link YotiClient}.
 */
public abstract class Profile {

    private final Map>> protectedAttributes;

    /**
     * Create a new profile based on a list of attributes
     *
     * @param attributeList list containing the attributes for this profile
     */
    Profile(List> attributeList) {
        if (attributeList == null) {
            throw new IllegalArgumentException("Attributes must not be null.");
        }
        this.protectedAttributes = unmodifiableMap(createAttributeMap(attributeList));
    }

    /**
     * Return typed {@link Attribute} object for a key.
     *
     * @param    the type parameter indicating the type of the returned value
     * @param name  attribute name
     * @param clazz attribute type
     * @return typed attribute, null if it is not present in the profile
     */
    public  Attribute getAttribute(String name, Class clazz) {
        Attribute attribute = getAttribute(name);
        return castSafely(clazz, attribute);
    }

    /**
     * Returns the {@link Attribute} object for the key
     *
     * @param name the name of the attribute
     * @return the attribute object, null if it is not present in the profile
     */
    public Attribute getAttribute(String name) {
        ensureName(name);
        List> attributes = protectedAttributes.get(name);
        if (attributes != null && attributes.size() > 0) {
            return attributes.get(0);
        }
        return null;
    }

    /**
     * Return a list of all the {@link Attribute}s with a name starting with name
     *
     * @param    the type parameter indicating the type of the returned value
     * @param name  attribute name
     * @param clazz attribute type
     * @return typed attribute value, null if there was no match
     */
    public  List> findAttributesStartingWith(String name, Class clazz) {
        ensureName(name);
        List> matches = new ArrayList<>();
        for (Map.Entry>> entry : protectedAttributes.entrySet()) {
            if (entry.getKey().startsWith(name)) {
                for (Attribute attribute : entry.getValue()) {
                    Attribute value = castSafely(clazz, attribute);
                    matches.add(value);
                }
            }
        }
        return matches;
    }

    /**
     * Return the first {@link Attribute} with a name starting with name
     *
     * @param    the type parameter indicating the type of the returned value
     * @param name  attribute name
     * @param clazz attribute type
     * @return typed attribute value, null if there was no match
     */
    public  Attribute findAttributeStartingWith(String name, Class clazz) {
        ensureName(name);
        Attribute attribute = findAttributeStartingWith(name);
        return castSafely(clazz, attribute);
    }

    private Attribute findAttributeStartingWith(String name) {
        ensureName(name);
        for (Map.Entry>> entry : protectedAttributes.entrySet()) {
            if (entry.getKey().startsWith(name)) {
                return entry.getValue().get(0);
            }
        }
        return null;
    }

    /**
     * Return all {@link Attribute}s for the profile.
     *
     * @return an unsorted collection of {@link Attribute}s
     */
    public Collection> getAttributes() {
        List> attributes = new ArrayList<>();
        for (Map.Entry>> entry : protectedAttributes.entrySet()) {
            attributes.addAll(entry.getValue());
        }
        return attributes;
    }

    /**
     * Return typed {@link Attribute} by ID.
     *
     * @param id the ID to match
     * @return attribute value, null if there was no match
     */
    public Attribute