/*************************************************************************
 *                                                                       *
 *  CESeCore: CE Security Core                                           *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.cesecore.roles.member;

import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.ejb.Remote;

import org.cesecore.authentication.AuthenticationFailedException;
import org.cesecore.authentication.tokens.AuthenticationToken;

/**
 * @version $Id: RoleMemberDataProxySessionRemote.java 25590 2017-03-23 12:14:30Z samuellb $
 *
 */
@Remote
public interface RoleMemberDataProxySessionRemote {

    /**
     * Saves a RoleMemberData object to the database, either overwriting an existing one with the same primary key or editing an existing instance.
     * 
     * @param accessUserAspectData the AccessUserAspectData to persist.
     */
    int createOrEdit(final RoleMember roleMember);
    
    /**
     * Saves a RoleMemberData object to the database, either overwriting an existing one with the same primary key or editing an existing instance.
     * 
     * @param accessUserAspectData the AccessUserAspectData to persist.
     */
    int createOrEdit(final RoleMemberData roleMember);
    
    
    /**
     * Removes an RoleMemberData from the database.
     * 
     * @param primaryKey
     *            The ID of the RoleMemberData to remove.         
     * @return true if removal was successful, false if no such role member was found
     */
    boolean remove(final int primaryKey);
    
    /**
     * Finds an RoleMember by its primary key.
     * 
     * @param primaryKey
     *            Primary key of the sought instance.
     * @return the sought RoleMember, otherwise null. .
     */
    RoleMember findRoleMember(final int primaryKey);

    /**
     * Finds all role members belonging to a specific role.
     * 
     * 
     * @param roleId the ID of a role
     * @return a list of members to the given role
     */
    List<RoleMember> findRoleMemberByRoleId(int roleId);

    /** @return true if the EJBCA 6.8.0 union of access rules from multiple matched roles is in use */
    boolean isNewAuthorizationPatternMarkerPresent();
    
    /** @see {@link org.cesecore.roles.member.RoleMemberDataSessionLocal#getRoleIdsMatchingAuthenticationTokenOrFail(AuthenticationToken)} */
    Set<Integer> getRoleIdsMatchingAuthenticationTokenOrFail(AuthenticationToken authenticationToken) throws AuthenticationFailedException;
    
    /** @see {@link org.cesecore.roles.member.RoleMemberDataSessionBean#getRoleIdsAndTokenMatchKeysMatchingAuthenticationToken(AuthenticationToken)} */
    Map<Integer,Integer> getRoleIdsAndTokenMatchKeysMatchingAuthenticationToken(AuthenticationToken authenticationToken) throws AuthenticationFailedException;
}