|
Oracle BPEL Process Manager Workflow Services API Reference 10g Release 3 (10.1.3) B28985-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public BPMRole lookupRole(java.lang.String roleName) throws BPMIdentityException, BPMIdentityNotFoundException
BPMRole
by name in the system,BPMRole</> instance.
Throws:
BPMIdentityNotFoundException
- If the role is not found.
BPMIdentityException
- If an exception condition occurs.public BPMUser lookupUser(java.lang.String userName) throws BPMIdentityException, BPMIdentityNotFoundException
BPMUser
by name in the system.userName
- The name of the user.BPMUser</> instance.
Throws:
BPMIdentityNotFoundException
- If the user is not found.
BPMIdentityException
- If an exception condition occurs.public java.util.List searchUsers(java.lang.String attrName, java.lang.String attrValue) throws BPMIdentityException, BPMUnsupportedAttributeException
BPMUser
objects by an attribute's name-value pairattrName
- The attribute name to be used in the search.attrValue
- The attribute value to be used in the search.BPMUser
objectsBPMUnsupportedAttributeException
- If the attribute is not supported by the implementation of BPMUser.BPMIdentityException
- If an exception condition occurs.public java.util.List searchUsers(SearchFilter searchFilter) throws BPMIdentityException, BPMUnsupportedAttributeException
searchFilter
- An instance of the SearchFilterBPMUnsupportedAttributeException
- If the attribute is not supported by the implementation of BPMUser.BPMIdentityException
- If an exception condition occurs.public BPMGroup lookupGroup(java.lang.String groupName) throws BPMIdentityException, BPMIdentityNotFoundException
BPMGroup
by group namegroupName
- The name of the group.BPMIdentityNotFoundException
- If the group is not found.BPMIdentityException
- If an exception condition occurs.public java.util.List searchGroups(java.lang.String attrName, java.lang.String attrValue) throws BPMIdentityException, BPMUnsupportedAttributeException
BPMGroup
objects by an attribute's name-value pairattrName
- The attribute name to be used in the search.attrValue
- The attribute value to be used in the search.BPMUnsupportedAttributeException
- If the attribute is not supported by the implementation of BPMGroup.BPMIdentityException
- If an exception condition occurspublic java.util.List searchGroups(SearchFilter searchFilter) throws BPMIdentityException, BPMUnsupportedAttributeException
searchFilter
- a search filter objectBPMUnsupportedAttributeException
- if attribute is unsupportedBPMIdentityException
- If exception condition occurspublic java.util.List getUsers() throws BPMIdentityException
BPMIdentityException
- If exception condition occurspublic java.util.List getGroups() throws BPMIdentityException
BPMIdentityException
- If exception condition occurspublic java.util.List getRoles(RoleClassifier classifier) throws BPMIdentityException
classifier
- a role classifierBPMIdentityException
- If exception condition occurspublic java.util.List getAppRoles() throws BPMIdentityException
BPMAppRole
objectsBPMIdentityException
- If exception condition occurspublic java.util.List getParticipants(java.lang.String name, boolean direct) throws BPMIdentityException
name
- a group/role namedirect
- a boolean flag. If true method return direct participans, elase all.BPMIdentityNotFoundException
- if group is not foundBPMIdentityException
- If exception condition occurspublic java.util.Set getGrantees(java.lang.String name, boolean direct) throws BPMIdentityException
name
- a group/role namedirect
- a boolean flag. If true method return direct participans, elase all.BPMIdentityNotFoundException
- if group/role is not foundBPMIdentityException
- If exception condition occurspublic java.util.List getReportees(java.lang.String managerName, int maxReporteeLevel) throws BPMIdentityException
managerName
- a manager namemaxReporteeLevel
- - 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.List
of reportees, BPMUser
.BPMIdentityException
- If exception condition occurspublic BPMUser getManager(java.lang.String userName) throws BPMIdentityException
userName
- The user name whose manager is requried.BPMIdentityException
- If exception condition occurspublic java.util.List getManagementChain(java.lang.String userName, java.lang.String upToUser, java.lang.String upToTitle, int level) throws BPMIdentityException
userName
- a user nameupToUser
- a user name which limits chain resultupToTitle
- a title which limits chain resultlevel
- a level, limits size of chain resultBPMIdentityException
- If exception condition occurspublic java.util.Set getOwnedRolesByUser(java.lang.String userName, boolean direct) throws BPMIdentityException
userName
- The name of userdirect
- a boolean flag. If it true, the method returns direct owned roles, else allBPMIdentityException
- If exception condition occurspublic java.util.Set getOwnedRolesByRole(java.lang.String roleName, boolean direct) throws BPMIdentityException
direct
- a boolean flag. If it true, the method returns direct owned roles, else allBPMIdentityException
- If exception condition occurspublic java.util.Set getRoleOwners(java.lang.String roleName, boolean direct) throws BPMIdentityException
roleName
- The role namedirect
- a boolean flag. If it true, the method returns direct owned roles, else allBPMIdentityException
- If exception condition occurspublic java.util.Set getGrantedRolesToUser(java.lang.String userName, boolean direct) throws BPMIdentityException
userName
- - a user namedirect
- a boolean flag. If it is true method returns only direct granted roles, else all rolesList
of granted BPMRole
s objectsBPMIdentityException
- if errors occursBPMIdentityException
public java.util.Set getGrantedRolesToRole(java.lang.String roleName, boolean direct) throws BPMIdentityException
roleName
- - a role namedirect
- a boolean flag. If it is true method returns only direct granted roles, else all rolesList
of granted BPMRole
s objectsBPMIdentityException
- if errors occursBPMIdentityException
public Configuration getConfiguration() throws BPMIdentityException
BPMIdentityException
public java.lang.String getRealmName() throws BPMIdentityException
BPMIdentityException
public BPMUser whoAmI(javax.servlet.http.HttpServletRequest request) throws BPMIdentityException, BPMIdentityNotFoundException
request
- a HttpServletRequest objectBPMIdentityNotFoundException
- if object is not foundBPMIdentityException
- If exception condition occurspublic BPMProvider getProvider()
BPMIdentityException
- If exception condition occurs Gets provider assocaited with this service instancepublic ComplexSearchFilter getSearchFilterInstance(java.lang.Class classifier, org.w3c.dom.Element filterElement) throws BPMIdentityException
classifier
- an interface. It can be BPMUser, BPMGroup or BPMAppRole interfacesfilterElement
- an XML element describing the filter. It must conform to the Identity Serivce schema.java.lang.Exception
- If exception condition occursBPMIdentityException
public ComplexSearchFilter getSearchFilterInstance(java.lang.Class classifier, java.lang.String attrName, java.lang.String operator, java.lang.String attrPattrnValue) throws BPMIdentityException
classifier
-attrName
-operator
-attrPattrnValue
-BPMIdentityException
|
Oracle BPEL Process Manager Workflow Services API Reference 10g Release 3 (10.1.3) B28985-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2006, Oracle. All rights reserved.