Skip navigation links

oracle.tip.pc.services.identity
Interface BPMAuthorizationService

All Superinterfaces:

Service

All Known Subinterfaces:

BPMIdentityService

public interface BPMAuthorizationService

extends Service

BPMAuthorizationService defines BPEL Process Manager Authorization Service An instance can be obtained from the ServiceFactory. For example: BPMAuthenticationService service = ServiceFactory.getAuthorizationServiceInstance(); BPMAuthenticationService service = ServiceFactory.getAuthorizationServiceInstance("myRealm"); This method will fetch the service instance as configured in the identity service configuration.

Method Summary

java.util.List	getAppRoles() Gets all application roles for all application
Configuration	getConfiguration() Gets Configuration object associated with this service.
java.util.Set	getGrantedRolesToRole(java.lang.String roleName, boolean direct) Gets granted roles for the given role
java.util.Set	getGrantedRolesToUser(java.lang.String userName, boolean direct) Gets granted roles for the given user
java.util.Set	getGrantees(java.lang.String name, boolean direct) Gets all grantees for given group/role name
java.util.List	getGroups() Gets all group name in realm
java.util.List	getManagementChain(java.lang.String userName, java.lang.String upToUser, java.lang.String upToTitle, int level) Gets Management Chain for given user in realm
BPMUser	getManager(java.lang.String userName) Gets manager name for given user name
java.util.Set	getOwnedRolesByRole(java.lang.String roleName, boolean direct) Gets set of roles owned by given group.
java.util.Set	getOwnedRolesByUser(java.lang.String userName, boolean direct) Gets set of roles owned by given user
java.util.List	getParticipants(java.lang.String name, boolean direct) Gets user participants, the grantee for given group/role name
BPMProvider	getProvider()
java.lang.String	getRealmName() Gets realm name assocaited with this service.
java.util.List	getReportees(java.lang.String managerName, int maxReporteeLevel) Gets reportees for the user up to given level in the hierarchical structure
java.util.Set	getRoleOwners(java.lang.String roleName, boolean direct) Gets owners of the given role
java.util.List	getRoles(RoleClassifier classifier) Gets all roles in realm
ComplexSearchFilter	getSearchFilterInstance(java.lang.Class classifier, org.w3c.dom.Element filterElement) Factory method for Search Filter
ComplexSearchFilter	getSearchFilterInstance(java.lang.Class classifier, java.lang.String attrName, java.lang.String operator, java.lang.String attrPattrnValue) Factory method for Search Filter
java.util.List	getUsers() Gets all users name in realm
BPMGroup	lookupGroup(java.lang.String groupName) Looks up BPMGroup by group name
BPMRole	lookupRole(java.lang.String roleName) Looks up BPMRole by name in the system,
BPMUser	lookupUser(java.lang.String userName) Looks up BPMUser by name in the system.
java.util.List	searchGroups(SearchFilter searchFilter) Searches groups by criterias defined in searchFilter
java.util.List	searchGroups(java.lang.String attrName, java.lang.String attrValue) Searches BPMGroup objects by an attribute's name-value pair
java.util.List	searchUsers(SearchFilter searchFilter) Searches users by the criteria defined in the search filter
java.util.List	searchUsers(java.lang.String attrName, java.lang.String attrValue) Searches BPMUser objects by an attribute's name-value pair
BPMUser	whoAmI(javax.servlet.http.HttpServletRequest request) Who am I

Methods inherited from interface oracle.tip.pc.services.common.Service

getStatus

Method Detail

lookupRole

public BPMRole lookupRole(java.lang.String roleName)
                   throws BPMIdentityException,
                          BPMIdentityNotFoundException

Looks up BPMRole by name in the system,

Returns:

A BPMRole</> instance.

Throws:

BPMIdentityNotFoundException - If the role is not found.

BPMIdentityException - If an exception condition occurs.

lookupUser

public BPMUser lookupUser(java.lang.String userName)
                   throws BPMIdentityException,
                          BPMIdentityNotFoundException

Looks up BPMUser by name in the system.

Parameters:

userName - The name of the user.

Returns:

A BPMUser</> instance.

Throws:

BPMIdentityNotFoundException - If the user is not found.

BPMIdentityException - If an exception condition occurs.

searchUsers

public java.util.List searchUsers(java.lang.String attrName,
                                  java.lang.String attrValue)
                           throws BPMIdentityException,
                                  BPMUnsupportedAttributeException

Searches BPMUser objects by an attribute's name-value pair

Parameters:

attrName - The attribute name to be used in the search.

attrValue - The attribute value to be used in the search.

Returns:

A List of BPMUser objects

Throws:

BPMUnsupportedAttributeException - If the attribute is not supported by the implementation of BPMUser.

BPMIdentityException - If an exception condition occurs.

searchUsers

public java.util.List searchUsers(SearchFilter searchFilter)
                           throws BPMIdentityException,
                                  BPMUnsupportedAttributeException

Searches users by the criteria defined in the search filter

Parameters:

searchFilter - An instance of the SearchFilter

Returns:

List of BPMUser objects

Throws:

BPMUnsupportedAttributeException - If the attribute is not supported by the implementation of BPMUser.

BPMIdentityException - If an exception condition occurs.

lookupGroup

public BPMGroup lookupGroup(java.lang.String groupName)
                     throws BPMIdentityException,
                            BPMIdentityNotFoundException

Looks up BPMGroup by group name

Parameters:

groupName - The name of the group.

Throws:

BPMIdentityNotFoundException - If the group is not found.

BPMIdentityException - If an exception condition occurs.

searchGroups

public java.util.List searchGroups(java.lang.String attrName,
                                   java.lang.String attrValue)
                            throws BPMIdentityException,
                                   BPMUnsupportedAttributeException

Searches BPMGroup objects by an attribute's name-value pair

Parameters:

attrName - The attribute name to be used in the search.

attrValue - The attribute value to be used in the search.

Returns:

List of BPMGroup objects

Throws:

BPMUnsupportedAttributeException - If the attribute is not supported by the implementation of BPMGroup.

BPMIdentityException - If an exception condition occurs

searchGroups

public java.util.List searchGroups(SearchFilter searchFilter)
                            throws BPMIdentityException,
                                   BPMUnsupportedAttributeException

Searches groups by criterias defined in searchFilter

Parameters:

searchFilter - a search filter object

Returns:

List of BPMGroup objects

Throws:

BPMUnsupportedAttributeException - if attribute is unsupported

BPMIdentityException - If exception condition occurs

getUsers

public java.util.List getUsers()
                        throws BPMIdentityException

Gets all users name in realm

Returns:

List of user names in realm

Throws:

BPMIdentityException - If exception condition occurs

getGroups

public java.util.List getGroups()
                         throws BPMIdentityException

Gets all group name in realm

Returns:

List of groupname in realm

Throws:

BPMIdentityException - If exception condition occurs

getRoles

public java.util.List getRoles(RoleClassifier classifier)
                        throws BPMIdentityException

Gets all roles in realm

Parameters:

classifier - a role classifier

Throws:

BPMIdentityException - If exception condition occurs

getAppRoles

public java.util.List getAppRoles()
                           throws BPMIdentityException

Gets all application roles for all application

Returns:

List of BPMAppRole objects

Throws:

BPMIdentityException - If exception condition occurs

getParticipants

public java.util.List getParticipants(java.lang.String name,
                                      boolean direct)
                               throws BPMIdentityException

Gets user participants, the grantee for given group/role name

Parameters:

name - a group/role name

direct - a boolean flag. If true method return direct participans, elase all.

Returns:

List of BPMUser objects, the grantees for given group name

Throws:

BPMIdentityNotFoundException - if group is not found

BPMIdentityException - If exception condition occurs

getGrantees

public java.util.Set getGrantees(java.lang.String name,
                                 boolean direct)
                          throws BPMIdentityException

Gets all grantees for given group/role name

Parameters:

name - a group/role name

direct - a boolean flag. If true method return direct participans, elase all.

Returns:

List of all BPMPrincipal objects, the grantees for given group/role name

Throws:

BPMIdentityNotFoundException - if group/role is not found

BPMIdentityException - If exception condition occurs

getReportees

public java.util.List getReportees(java.lang.String managerName,
                                   int maxReporteeLevel)
                            throws BPMIdentityException

Gets reportees for the user up to given level in the hierarchical structure

Parameters:

managerName - a manager name

maxReporteeLevel - - reportees included into result up to maxReporteeLevel from the manager in hierarchical structure are included into result If level equals 1, method returns only one level of reportees, direct reportees, for the user, ; if level equals 2, method return only two levels of reportees for the user; if level equals 3, method returns only treee levels reportees for the user; etc; if 0 or any negative value is specified , it assumes all reportees for given user.

Returns:

List of reportees, BPMUser.

Throws:

BPMIdentityException - If exception condition occurs

getManager

public BPMUser getManager(java.lang.String userName)
                   throws BPMIdentityException

Gets manager name for given user name

Parameters:

userName - The user name whose manager is requried.

Returns:

manager, BPMUser object

Throws:

BPMIdentityException - If exception condition occurs

getManagementChain

public java.util.List getManagementChain(java.lang.String userName,
                                         java.lang.String upToUser,
                                         java.lang.String upToTitle,
                                         int level)
                                  throws BPMIdentityException

Gets Management Chain for given user in realm

Parameters:

userName - a user name

upToUser - a user name which limits chain result

upToTitle - a title which limits chain result

level - a level, limits size of chain result

Returns:

List of Users who are in management chain for given user

Throws:

BPMIdentityException - If exception condition occurs

getOwnedRolesByUser

public java.util.Set getOwnedRolesByUser(java.lang.String userName,
                                         boolean direct)
                                  throws BPMIdentityException

Gets set of roles owned by given user

Parameters:

userName - The name of user

direct - a boolean flag. If it true, the method returns direct owned roles, else all

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs

getOwnedRolesByRole

public java.util.Set getOwnedRolesByRole(java.lang.String roleName,
                                         boolean direct)
                                  throws BPMIdentityException

Gets set of roles owned by given group.

Parameters:

direct - a boolean flag. If it true, the method returns direct owned roles, else all

Returns:

Set of BPMRole objects.

Throws:

BPMIdentityException - If exception condition occurs

getRoleOwners

public java.util.Set getRoleOwners(java.lang.String roleName,
                                   boolean direct)
                            throws BPMIdentityException

Gets owners of the given role

Parameters:

roleName - The role name

direct - a boolean flag. If it true, the method returns direct owned roles, else all

Returns:

Set of BPMUser objects

Throws:

BPMIdentityException - If exception condition occurs

getGrantedRolesToUser

public java.util.Set getGrantedRolesToUser(java.lang.String userName,
                                           boolean direct)
                                    throws BPMIdentityException

Gets granted roles for the given user

Parameters:

userName - - a user name

direct - a boolean flag. If it is true method returns only direct granted roles, else all roles

Returns:

List of granted BPMRoles objects

Throws:

BPMIdentityException - if errors occurs

BPMIdentityException

getGrantedRolesToRole

public java.util.Set getGrantedRolesToRole(java.lang.String roleName,
                                           boolean direct)
                                    throws BPMIdentityException

Gets granted roles for the given role

Parameters:

roleName - - a role name

direct - a boolean flag. If it is true method returns only direct granted roles, else all roles

Returns:

List of granted BPMRoles objects

Throws:

BPMIdentityException - if errors occurs

BPMIdentityException

getConfiguration

public Configuration getConfiguration()
                               throws BPMIdentityException

Gets Configuration object associated with this service.

Throws:

BPMIdentityException

getRealmName

public java.lang.String getRealmName()
                              throws BPMIdentityException

Gets realm name assocaited with this service.

Returns:

realm name

Throws:

BPMIdentityException

whoAmI

public BPMUser whoAmI(javax.servlet.http.HttpServletRequest request)
               throws BPMIdentityException,
                      BPMIdentityNotFoundException

Who am I

Parameters:

request - a HttpServletRequest object

Returns:

BPMUser object

Throws:

BPMIdentityNotFoundException - if object is not found

BPMIdentityException - If exception condition occurs

getProvider

public BPMProvider getProvider()

Returns:

BPMProvider instance

Throws:

BPMIdentityException - If exception condition occurs Gets provider assocaited with this service instance

getSearchFilterInstance

public ComplexSearchFilter getSearchFilterInstance(java.lang.Class classifier,
                                                   org.w3c.dom.Element filterElement)
                                            throws BPMIdentityException

Factory method for Search Filter

Parameters:

classifier - an interface. It can be BPMUser, BPMGroup or BPMAppRole interfaces

filterElement - an XML element describing the filter. It must conform to the Identity Serivce schema.

Returns:

SearchFilter - a search filter instance

Throws:

java.lang.Exception - If exception condition occurs

BPMIdentityException

getSearchFilterInstance

public ComplexSearchFilter getSearchFilterInstance(java.lang.Class classifier,
                                                   java.lang.String attrName,
                                                   java.lang.String operator,
                                                   java.lang.String attrPattrnValue)
                                            throws BPMIdentityException

Factory method for Search Filter

Parameters:

classifier -

attrName -

operator -

attrPattrnValue -

Returns:

SearchFilter - a search filter instance

Throws:

BPMIdentityException

Skip navigation links