io.gravitee.am.identityprovider.api.User Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-am-identityprovider-api Show documentation
There is a newer version: 4.6.0-alpha.2
Show newest version
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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.
 */
package io.gravitee.am.identityprovider.api;

import java.io.Serializable;
import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author Titouan COMPIEGNE (titouan.compiegne at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface User extends Serializable {

    /**
     * Returns the technical id used of the user
     *
     * @return the technical id
     */
    String getId();

    /**
     * Returns the username used to authenticate the user. Cannot return null.
     *
     * @return the username (never null)
     */
    String getUsername();

    /**
     * Returns the email of the user.
     *
     * @return the email
     */
    String getEmail();

    /**
     * Returns the firstname of the user.
     *
     * @return the firstname
     */
    String getFirstName();

    /**
     * Returns the lastname of the user.
     *
     * @return the lastname
     */
    String getLastName();

    /**
     * Returns the credentials of the user. (Useful for user management)
     *
     * @return the credentials
     */
    String getCredentials();

    /**
     * Indicates whether the user's account has expired. An expired account cannot be authenticated.
     *
     * @return true if the user's account is valid (ie non-expired), false if no longer valid
     *         (ie expired)
     */
    boolean isAccountExpired();

    /**
     * Indicates whether the user is enabled or disabled. A disabled user cannot be authenticated.
     *
     * @return true if the user is enabled, false otherwise
     */
    boolean isEnabled();

    /**
     * Returns the user roles
     *
     * @return the user roles
     */
    List getRoles();

    /**
     * Returns the user additional information
     *
     * @return the user additional information
     */
    Map getAdditionalInformation();

    /**
     * Returns the user creation date
     *
     * @return the user creation date
     */
    Date getCreatedAt();

    /**
     * Returns the last time when user has been updated
     *
     * @return the last time when user has been updated
     */
    Date getUpdatedAt();
}