Skip navigation links

oracle.security.idm
Interface RoleProfile

All Superinterfaces:

Identity, Role

public interface RoleProfile

extends Role

This interface represents detailed profile of a role.

Since:

10.1.3

Field Summary

static java.lang.String	DESCRIPTION
static java.lang.String	DISPLAY_NAME
static java.lang.String	GUID
static java.lang.String	MANAGER
static java.lang.String	NAME
static java.lang.String	OWNER

Fields inherited from interface oracle.security.idm.Role

SCOPE_ANY, SCOPE_APPLICATION, SCOPE_ENTERPRISE

Method Summary

void	addManager(java.security.Principal principal) Add the specified principal as one of the managers of the role.
void	addOwner(java.security.Principal principal) Add the specified principal as one of the owners of the role.
void	addOwner(User usr) Deprecated. use addOwner(Principal principal)
java.lang.String	getDescription()
SearchResponse	getGrantees(SearchFilter filter, boolean direct) Get all the grantees that are directly or indirectly granted this role.
SearchResponse	getManagers(SearchFilter filter) Deprecated. This method returns all the managers (only direct). Use this instead getManagers(SearchFilter filter, boolean direct)
SearchResponse	getManagers(SearchFilter filter, boolean direct) Get all the managers of this role.
SearchResponse	getOwners(SearchFilter filter) Deprecated. This method returns all the owners (both direct and indirect). Use this instead getOwners(SearchFilter filter, boolean direct)
SearchResponse	getOwners(SearchFilter filter, boolean direct) Get all the owners of this role.
Property	getProperty(java.lang.String propName)
boolean	isApplicationRole()
boolean	isEnterpriseRole()
boolean	isSeeded()
void	removeManager(java.security.Principal principal) Remove the specified principal from the managers of the role.
void	removeOwner(java.security.Principal principal) Remove the specified principal from the owners of the role.
void	removeOwner(User usr) Deprecated. use removeOwner(Principal principal)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setName(java.lang.String name)

Methods inherited from interface oracle.security.idm.Role

getRoleProfile

Methods inherited from interface oracle.security.idm.Identity

getDisplayName, getGUID, getName, getPrincipal, getUniqueName

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

DISPLAY_NAME

static final java.lang.String DISPLAY_NAME

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

GUID

static final java.lang.String GUID

See Also:

Constant Field Values

MANAGER

static final java.lang.String MANAGER

See Also:

Constant Field Values

OWNER

static final java.lang.String OWNER

See Also:

Constant Field Values

Method Detail

setName

void setName(java.lang.String name)
             throws IMException

Throws:

IMException

setDisplayName

void setDisplayName(java.lang.String displayName)
                    throws IMException

Throws:

IMException

setDescription

void setDescription(java.lang.String description)
                    throws IMException

Throws:

IMException

getDescription

java.lang.String getDescription()
                                throws IMException

Throws:

IMException

getOwners

SearchResponse getOwners(SearchFilter filter)
                         throws IMException

Deprecated. This method returns all the owners (both direct and indirect). Use this instead getOwners(SearchFilter filter, boolean direct)

Get all the owners of this role.

Parameters:

filter - optional search filter for filtering the results. By default the filter is set to null i.e. all the results will be returned.

Returns:

SearchResponse instance containing all the owners. Each result will be instance of User or Role class.

Throws:

ObjectNotFoundException - Thrown if the search doesn't return any results.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

getOwners

SearchResponse getOwners(SearchFilter filter,
                         boolean direct)
                         throws IMException

Get all the owners of this role.

Parameters:

filter - optional search filter for filtering the results. By default the filter is set to null i.e. all the results will be returned.

direct - If true all the direct owners will be returned. If false both the direct and indirect owners will be returned.

Returns:

SearchResponse instance containing all the owners. Each result will be instance of User or Role class.

Throws:

ObjectNotFoundException - Thrown if the search doesn't return any results.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

addOwner

void addOwner(java.security.Principal principal)
              throws IMException

Add the specified principal as one of the owners of the role.

Throws:

OperationNotSupportedException - Thrown by the service provider if it doesn't support the operation.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

removeOwner

void removeOwner(java.security.Principal principal)
                 throws IMException

Remove the specified principal from the owners of the role.

Throws:

OperationNotSupportedException - Thrown by the service provider if it doesn't support the operation.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

getManagers

SearchResponse getManagers(SearchFilter filter)
                           throws IMException

Deprecated. This method returns all the managers (only direct). Use this instead getManagers(SearchFilter filter, boolean direct)

Get all the managers of this role.

Parameters:

filter - optional search filter for filtering the results. By default the filter is set to null i.e. all the results will be returned.

Returns:

SearchResponse instance containing all the managers. Each result will be instance of User or Role class.

Throws:

ObjectNotFoundException - Thrown if the search doesn't return any results.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

getManagers

SearchResponse getManagers(SearchFilter filter,
                           boolean direct)
                           throws IMException

Get all the managers of this role.

Parameters:

filter - optional search filter for filtering the results. By default the filter is set to null i.e. all the results will be returned.

direct - If true all the direct managers will be returned. If false both the direct and indirect managers will be returned.

Returns:

SearchResponse instance containing all the managers. Each result will be instance of User or Role class.

Throws:

ObjectNotFoundException - Thrown if the search doesn't return any results.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

addManager

void addManager(java.security.Principal principal)
                throws IMException

Add the specified principal as one of the managers of the role.

Throws:

OperationNotSupportedException - Thrown by the service provider if it doesn't support the operation.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

removeManager

void removeManager(java.security.Principal principal)
                   throws IMException

Remove the specified principal from the managers of the role.

Throws:

OperationNotSupportedException - Thrown by the service provider if it doesn't support the operation.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

getGrantees

SearchResponse getGrantees(SearchFilter filter,
                           boolean direct)
                           throws IMException

Get all the grantees that are directly or indirectly granted this role.

Parameters:

filter - optional search filter for filtering the results. By default the filter is set to null i.e. all the results will be returned.

direct - If true all the grantees that are direct granted will be returned. If false both the direct and indirect grantees will be returned.

Returns:

SearchResponse instance containing all the grantees. Each result will be instance of User or Role class.

Throws:

ObjectNotFoundException - Thrown if the search doesn't return any results.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IMException - Thrown by the service provider in case of any other problem.

isSeeded

boolean isSeeded()

isApplicationRole

boolean isApplicationRole()

isEnterpriseRole

boolean isEnterpriseRole()

getProperty

Property getProperty(java.lang.String propName)
                     throws IMException

Throws:

IMException

addOwner

void addOwner(User usr)
              throws IMException

Deprecated. use addOwner(Principal principal)

Throws:

IMException

removeOwner

void removeOwner(User usr)
                 throws IMException

Deprecated. use removeOwner(Principal principal)

Throws:

IMException

Skip navigation links