org.glassfish.deployment.common.SecurityRoleMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deployment-common Show documentation
The newest version!
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.deployment.common;

import java.security.Principal;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import javax.security.auth.Subject;
import org.glassfish.security.common.Role;

/**
 * This interface defines the protocol used by the DOL to access the role
 * mapping information of a J2EE application. This class is implemented by
 * other modules and their instanciation is done through the
 * SecurityRoleMapperFactory class.
 *
 * @author Jerome Dochez
 */
public interface SecurityRoleMapper {

    /**
     * Set the role mapper application name
     *
     * @param name the app name
     */
    void setName(String name);

    /**
     * @return the role mapper application name
     */
    String getName();

    /**
     * @return an iterator on all the assigned roles
     */
    Iterator getRoles();

    /**
     * @return an enumeration of Principals assigned to the given role
     * @param r The Role to which the principals are assigned to.
     */
    Enumeration getUsersAssignedTo(Role r);

    /**
     * @return an enumeration of Groups assigned to the given role
     * @param r The Role to which the groups are assigned to.
     */
    Enumeration getGroupsAssignedTo(Role r);

    /**
     * Assigns a Principal to the specified role.
     *
     * @param p The principal that needs to be assigned to the role.
     * @param r The Role the principal is being assigned to.
     * @param rdd The descriptor of the module calling assignRole.
     */
    void assignRole(Principal p, Role r, RootDeploymentDescriptor rdd);

    /**
     * Remove the given role-principal mapping
     *
     * @param role Role object
     * @param principal the principal
     */
    void unassignPrincipalFromRole(Role role, Principal principal);

    /**
     * Remove all the role mapping information for this role
     *
     * @param role the role object
     */
    void unassignRole(Role role);

    /**
     * @return a map of roles to the corresponding subjects
     */
    Map getRoleToSubjectMapping();

    /**
     *
     * @return
     */
    Map> getGroupToRolesMapping();


    /**
     *
     * @return
     */
    Map> getCallerToRolesMapping();

    /**
     *
     * @return
     */
    boolean isDefaultPrincipalToRoleMapping();

    /**
     * Extracts the groups from the GlassFish specific and potential other unknown principals.
     *
     * @param subject container for finding groups, may be null
     * @return a list of (non-mapped) groups
     */
    Set getGroups(Subject subject);

    /**
     *
     * @param subject
     * @return
     */
    Principal getCallerPrincipal(Subject subject);
}