de.cuioss.portal.authentication.AuthenticatedUserInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of portal-authentication-api Show documentation

Api for the different way of authentication within the portal

There is a newer version: 1.1.1

Show newest version

/*
 * Copyright 2023 the original author or authors.
 * 
 * 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
 * 

 * https://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 de.cuioss.portal.authentication;

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

/**
 * Interface of bean, which represents an encapsulating the current user-specific
 * information in session context. It should call data from authentication
 * facade on creation and then hold and provide this information for any other
 * beans.
 *
 * @author Stephan Babkin
 */
@SuppressWarnings("squid:S1214") // We allow constants in interfaces if they belong together
// (coherence).
public interface AuthenticatedUserInfo extends Serializable {

    /**
     * Returns true in case of user is authenticated already and
     * false otherwise.
     *
     * @return true in case of user is authenticated already and
     * false otherwise.
     */
    boolean isAuthenticated();

    /**
     * @return a list of role names assigned to the user.
     */
    List getRoles();

    /**
     * Checks if is user in a role.
     *
     * @param roleName the role name
     * @return true, if is user in a role
     */
    default boolean isUserInRole(String roleName) {
        return getRoles().contains(roleName);
    }

    /**
     * @return a list of group names the user is assigned to.
     */
    List getGroups();

    /**
     * @return the display name of the currently authenticated user
     */
    String getDisplayName();

    /**
     * @return the (technical) identifier for the currently authenticated user to be
     * used with {@link #getSystem()}.
     */
    String getIdentifier();

    /**
     * @return the (technical) qualified identifier for the currently authenticated
     * user to be used without {@link #getSystem()}.
     */
    String getQualifiedIdentifier();

    /**
     * @return the (technical) assigning authority for the {@link #getIdentifier()}
     * of the currently authenticated user
     */
    String getSystem();

    /**
     * @return the context map containing additional runtime information belonging
     * to the {@link AuthenticatedUserInfo}
     */
    Map getContextMap();

}