org.keycloak.models.RoleMapperModel Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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 org.keycloak.models;

import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * @author Bill Burke
 * @version $Revision: 1 $
 */
public interface RoleMapperModel {
    /**
     * Returns set of realm roles that are directly set to this object.
     * @return see description
     * @deprecated Use {@link #getRealmRoleMappingsStream() getRealmRoleMappingsStream} instead.
     */
    @Deprecated
    Set getRealmRoleMappings();

    /**
     * Returns stream of realm roles that are directly set to this object.
     * @return Stream of {@link RoleModel}. Never returns {@code null}.
     */
    default Stream getRealmRoleMappingsStream() {
        Set value = this.getRealmRoleMappings();
        return value != null ? value.stream() : Stream.empty();
    }

    /**
     * Returns set of client roles that are directly set to this object for the given client.
     * @param app Client to get the roles for
     * @return see description
     * @deprecated Use {@link #getClientRoleMappingsStream(ClientModel) getClientRoleMappingsStream} instead.
     */
    @Deprecated
    Set getClientRoleMappings(ClientModel app);

    /**
     * Returns stream of client roles that are directly set to this object for the given client.
     * @param app {@link ClientModel} Client to get the roles for.
     * @return Stream of {@link RoleModel}. Never returns {@code null}.
     */
    default Stream getClientRoleMappingsStream(ClientModel app) {
        Set value = this.getClientRoleMappings(app);
        return value != null ? value.stream() : Stream.empty();
    }

    /**
     * Returns {@code true}, if this object is directly assigned the given role.
     * 
     * @param role the role
     * @return see description
     * @see #hasRole(RoleModel) if you want to check whether this object is directly or indirectly assigned to a role
     */
    default boolean hasDirectRole(RoleModel role) {
        return getRoleMappingsStream().anyMatch(r -> Objects.equals(r, role));
    }

    /**
     * Returns {@code true} if this object is directly or indirectly assigned the given role, {@code false} otherwise.
     * 
     * For example, {@code true} is returned for hasRole(R) if:
     * 

     *  R is directly assigned to this object
     *  R is not assigned to this object but this object belongs to a group G which is assigned the role R
     *  R is not assigned to this object but this object belongs to a group G, and G belongs to group H which is assigned the role R
     * 
     * @param role
     * @return see description
     * @see #hasDirectRole(RoleModel) if you want to check if this object is directly assigned to a role
     */
    boolean hasRole(RoleModel role);

    /**
     * Grants the given role to this object.
     * @param role
     */
    void grantRole(RoleModel role);

    /**
     * Returns set of all role (both realm all client) that are directly set to this object.
     * @return
     * @deprecated Use {@link #getRoleMappingsStream() getRoleMappingsStream} instead.
     */
    @Deprecated
    Set getRoleMappings();

    /**
     * Returns stream of all role (both realm all client) that are directly set to this object.
     * @return Stream of {@link RoleModel}. Never returns {@code null}.
     */
    default Stream getRoleMappingsStream() {
        Set value = this.getRoleMappings();
        return value != null ? value.stream() : Stream.empty();
    }

    /**
     * Removes the given role mapping from this object.
     * @param role Role to remove
     */
    void deleteRoleMapping(RoleModel role);

    /**
     * The {@link Streams} interface makes all collection-based methods in {@link RoleMapperModel} default by providing
     * implementations that delegate to the {@link Stream}-based variants instead of the other way around.
     * 
     * It allows for implementations to focus on the {@link Stream}-based approach for processing sets of data and benefit
     * from the potential memory and performance optimizations of that approach.
     */
    interface Streams extends RoleMapperModel {
        @Override
        default Set getRealmRoleMappings() {
            return this.getRealmRoleMappingsStream().collect(Collectors.toSet());
        }

        @Override
        Stream getRealmRoleMappingsStream();

        @Override
        default Set getClientRoleMappings(ClientModel app) {
            return this.getClientRoleMappingsStream(app).collect(Collectors.toSet());
        }

        @Override
        Stream getClientRoleMappingsStream(ClientModel app);

        @Override
        default Set getRoleMappings() {
            return this.getRoleMappingsStream().collect(Collectors.toSet());
        }

        @Override
        Stream getRoleMappingsStream();
    }
}