org.wildfly.test.security.common.elytron.UserWithAttributeValues Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-testsuite-shared
There is a newer version: 35.0.0.Beta1
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2017, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.wildfly.test.security.common.elytron;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

/**
 * Object which holds user configuration (password, values).
 *
 * @author Josef Cacek
 */
public class UserWithAttributeValues {

    private final String name;
    private final String password;
    private final Set values;

    private UserWithAttributeValues(Builder builder) {
        this.name = Objects.requireNonNull(builder.name, "Username must be not-null");
        this.password = builder.password != null ? builder.password : builder.name;
        this.values = new HashSet<>(builder.values);
    }

    /**
     * Returns username.
     */
    public String getName() {
        return name;
    }

    /**
     * Returns password as plain text.
     */
    public String getPassword() {
        return password;
    }

    /**
     * Set of roles to be assigned to the user.
     */
    public Set getValues() {
        return values;
    }

    /**
     * Creates builder to build {@link UserWithAttributeValues}.
     *
     * @return created builder
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Builder to build {@link UserWithAttributeValues}.
     */
    public static final class Builder {
        private String name;
        private String password;
        private final Set values = new HashSet<>();

        private Builder() {
        }

        public Builder withName(String name) {
            this.name = name;
            return this;
        }

        public Builder withPassword(String password) {
            this.password = password;
            return this;
        }

        /**
         * Add given attribute values to the builder. It doesn't replace existing values, but it adds given valuess to them.
         */
        public Builder withValues(Set values) {
            if (values != null) {
                this.values.addAll(values);
            }
            return this;
        }

        /**
         * Add given values to the builder. It doesn't replace existing values, but it adds given value to them.
         */
        public Builder withValues(String... values) {
            if (values != null) {
                this.values.addAll(Arrays.asList(values));
            }
            return this;
        }

        /**
         * Clears set of already added roles.
         */
        public Builder clearValues() {
            this.values.clear();
            return this;
        }

        /**
         * Builds UserWithRoles instance.
         *
         * @return
         */
        public UserWithAttributeValues build() {
            return new UserWithAttributeValues(this);
        }
    }

}