com.arangodb.model.DatabaseUsersOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Core module for ArangoDB Java Driver

There is a newer version: 7.16.0

/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.model;

import java.util.Map;

/**
 * @author Michele Rastelli
 */
public final class DatabaseUsersOptions {

    private String username;
    private Map extra;
    private String passwd;
    private Boolean active;

    public String getUsername() {
        return username;
    }

    /**
     * @param username Login name of the user to be created
     * @return options
     */
    public DatabaseUsersOptions username(final String username) {
        this.username = username;
        return this;
    }

    public Map getExtra() {
        return extra;
    }

    /**
     * @param extra extra user information. The data contained in extra
     *              will be stored for the user but not be interpreted further by ArangoDB.
     * @return options
     */
    public DatabaseUsersOptions extra(final Map extra) {
        this.extra = extra;
        return this;
    }

    public String getPasswd() {
        return passwd;
    }

    /**
     * @param passwd The user password as a string. If not specified, it will default to an empty string.
     * @return options
     */
    public DatabaseUsersOptions passwd(final String passwd) {
        this.passwd = passwd;
        return this;
    }

    public Boolean getActive() {
        return active;
    }

    /**
     * @param active A flag indicating whether the user account should be activated or not.
     *               The default value is true. If set to false, the user won't be able to
     *               log into the database.
     * @return options
     */
    public DatabaseUsersOptions active(final Boolean active) {
        this.active = active;
        return this;
    }

}