com.sun.identity.entitlement

Interface IPrivilegeManager<T extends IPrivilege>

All Known Implementing Classes:

PolicyPrivilegeManager, PrivilegeManager

public interface IPrivilegeManager<T extends IPrivilege>

Defines Create Read Update Delete operations for implementation of IPrivilege.

Method Summary

Modifier and Type	Method and Description
void	add(T privilege) Add a privilege.
boolean	canFindByName(String name) Checks if a privilege with the specified name can be found.
T	findByName(String name) Finds a privilege by its unique name.
void	modify(T privilege) Modify a privilege.
void	remove(String name) Remove a privilege.
Set<String>	searchNames(Set<SearchFilter> filter) Returns a set of privilege names for a given search criteria.
Set<String>	searchNames(Set<SearchFilter> filter, int searchSizeLimit, int searchTimeLimit) Returns a set of privilege names for a given search criteria.

Method Detail

canFindByName

boolean canFindByName(String name)
               throws EntitlementException

Checks if a privilege with the specified name can be found.

Parameters:

name - name of the privilege.

Throws:

EntitlementException - if search failed.

findByName

T findByName(String name)
      throws EntitlementException

Finds a privilege by its unique name.

Parameters:

name - name of the privilege to be returned

Throws:

EntitlementException - if privilege is not found.

add

void add(T privilege)
  throws EntitlementException

Add a privilege.

Parameters:

privilege - privilege to add.

Throws:

EntitlementException - if privilege cannot be added.

remove

void remove(String name)
     throws EntitlementException

Remove a privilege.

Parameters:

name - name of the privilege to be removed.

Throws:

EntitlementException - if privilege cannot be removed.

modify

void modify(T privilege)
     throws EntitlementException

Modify a privilege.

Parameters:

privilege - the privilege to be modified

Throws:

EntitlementException - if privilege cannot be modified.

searchNames

Set<String> searchNames(Set<SearchFilter> filter,
                        int searchSizeLimit,
                        int searchTimeLimit)
                 throws EntitlementException

Returns a set of privilege names for a given search criteria.

Parameters:

filter - Set of search filter.

searchSizeLimit - Search size limit.

searchTimeLimit - Search time limit in seconds.

Returns:

a set of privilege names for a given search criteria.

Throws:

EntitlementException - if search failed.

searchNames

Set<String> searchNames(Set<SearchFilter> filter)
                 throws EntitlementException

Returns a set of privilege names for a given search criteria.

Parameters:

filter - Set of search filter.

Returns:

a set of privilege names for a given search criteria.

Throws:

EntitlementException - if search failed.