org.graylog2.plugin.database.users.User Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.0.1
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.plugin.database.users;

import com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.shiro.authz.Permission;
import org.graylog2.plugin.database.Persisted;
import org.graylog2.rest.models.users.requests.Startpage;
import org.joda.time.DateTimeZone;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

public interface User extends Persisted {
    boolean isReadOnly();

    @Nullable
    String getAuthServiceId();

    @Nullable
    String getAuthServiceUid();

    Optional getFirstName();

    Optional getLastName();

    String getFullName();

    String getName();

    void setName(String username);

    /**
     * Returns the email address of the user.
     *
     * Depending on how the user has been created, it is possible that the returned string contains multiple email
     * addresses separated by a "," character. (i.e. LDAP users)
     *
     * @return the email address
     */
    String getEmail();

    List getPermissions();

    Set getObjectPermissions();

    Map getPreferences();

    Startpage getStartpage();

    long getSessionTimeoutMs();

    void setSessionTimeoutMs(long timeoutValue);

    void setPermissions(List permissions);

    void setPreferences(Map preferences);

    void setAuthServiceId(@Nullable String authServiceId);

    void setAuthServiceUid(@Nullable String authServiceUid);

    void setEmail(String email);

    /**
     * Set the first, last, and full user's name. The full user's full name is composed by concatenating the first and
     * last names together with a space between. For example "First Last".
     * @param firstName Required. The user's first name.
     * @param lastName Required. The user's last name.
     */
    void setFirstLastFullNames(String firstName, String lastName);

    /**
     * Set the user's full name. Starting in Graylog 4.1, use of this method is deprecated.
     * Prefer use of the {@link #setFirstLastFullNames(String, String)} method instead when possible. This way,
     * both individual first and last names will be available when needed.
     */
    @Deprecated
    void setFullName(String fullname);

    String getHashedPassword();

    void setPassword(String password);

    boolean isUserPassword(String password);

    DateTimeZone getTimeZone();

    void setTimeZone(DateTimeZone timeZone);

    void setTimeZone(String timeZone);

    boolean isExternalUser();

    void setExternal(boolean external);

    void setStartpage(String type, String id);

    void setStartpage(Startpage startpage);

    boolean isLocalAdmin();

    @Nonnull
    Set getRoleIds();

    void setRoleIds(Set roles);

    void setAccountStatus(AccountStatus status);

    AccountStatus getAccountStatus();

    boolean isServiceAccount();

    void setServiceAccount(boolean isServiceAccount);

    enum AccountStatus {
        @JsonProperty("enabled")
        ENABLED,
        @JsonProperty("disabled")
        DISABLED,
        @JsonProperty("deleted")
        DELETED
    }
}