com.yoti.api.client.shareurl.policy.WantedAttribute 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.shareurl.policy;

import static com.yoti.validation.Validation.notNullOrEmpty;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import com.yoti.api.client.shareurl.constraint.Constraint;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Type and content of a user detail
 */
public class WantedAttribute {

    @JsonProperty(Property.NAME)
    private final String name;

    @JsonProperty(Property.DERIVATION)
    private final String derivation;

    @JsonProperty(Property.OPTIONAL)
    private final boolean optional;

    @JsonProperty(Property.ACCEPT_SELF_ASSERTED)
    private final Boolean acceptSelfAsserted;

    @JsonProperty(Property.CONSTRAINTS)
    private final List constraints;

    @JsonProperty(Property.ALTERNATIVE_NAMES)
    private final Set alternativeNames;

    private WantedAttribute(Builder builder) {
        name = builder.name;
        derivation = builder.derivation;
        optional = builder.optional;
        acceptSelfAsserted = builder.acceptSelfAsserted;
        constraints = Collections.unmodifiableList(builder.constraints);
        alternativeNames = Collections.unmodifiableSet(builder.alternativeNames);
    }

    public static Builder builder() {
        return new Builder();
    }

    /**
     * Name identifying the {@link WantedAttribute}
     *
     * @return name of the attribute
     */
    public String getName() {
        return name;
    }

    /**
     * Additional derived criteria
     *
     * @return derivations
     */
    public String getDerivation() {
        return derivation;
    }

    /**
     * Defines the {@link WantedAttribute} as not mandatory
     *
     * @return optional
     */
    public boolean isOptional() {
        return optional;
    }

    /**
     * Allows self asserted attributes
     *
     * @return accept self asserted
     */
    public Boolean getAcceptSelfAsserted() {
        return acceptSelfAsserted;
    }

    /**
     * List of {@link Constraint} for a {@link WantedAttribute}
     *
     * @return the list of constrains
     */
    public List getConstraints() {
        return constraints;
    }

    /**
     *      * Alternatives for the attribute name that is being requested.
     *
     * The provided alternative attribute will be used exactly in the same way:
     *     - if a derivation is requested it will be applied on the alternative
     *     - if constraints are defined the alternative attribute will have to comply
     * 
     *
     * @return the Set of alternative names
     */
    public Set getAlternativeNames() {
        return alternativeNames;
    }

    public static class Builder {

        private String name;
        private String derivation;
        private boolean optional;
        private Boolean acceptSelfAsserted;
        private List constraints;
        private Set alternativeNames;

        private Builder() {
            constraints = new ArrayList<>();
            alternativeNames = new HashSet<>();
        }
        
        public Builder withName(String name) {
            this.name = name;
            return this;
        }
        
        public Builder withDerivation(String derivation) {
            this.derivation = derivation;
            return this;
        }
        
        public Builder withOptional(boolean optional) {
            this.optional = optional;
            return this;
        }

        public Builder withAcceptSelfAsserted(boolean acceptSelfAsserted) {
            this.acceptSelfAsserted = acceptSelfAsserted;
            return this;
        }

        public Builder withConstraints(List constraints) {
            this.constraints.addAll(constraints);
            return this;
        }

        public Builder withConstraint(Constraint constraint) {
            constraints.add(constraint);
            return this;
        }

        public Builder withAlternativeNames(Set alternativeNames) {
            this.alternativeNames.addAll(alternativeNames);
            return this;
        }

        public Builder withAlternativeName(String alternativeName) {
            alternativeNames.add(alternativeName);
            return this;
        }

        public WantedAttribute build() {
            notNullOrEmpty(name, Property.NAME);

            return new WantedAttribute(this);
        }

    }

    private static final class Property {

        private static final String NAME = "name";
        private static final String DERIVATION = "derivation";
        private static final String OPTIONAL = "optional";
        private static final String ACCEPT_SELF_ASSERTED = "accept_self_asserted";
        private static final String CONSTRAINTS = "constraints";
        private static final String ALTERNATIVE_NAMES = "alternative_names";

        private Property() { }

    }

}