|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BPMAuthorizationService
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.security.PermissionCollection |
getAllPermissions()
Gets all Permissions associated with all the applications |
java.security.PermissionCollection |
getAllPermissions(java.lang.String appName)
Gets all the Permissions associated with the given application |
java.util.List |
getAppRoles()
Gets all application roles for all application |
java.util.List<BPMAppRole> |
getAppRoles(java.lang.String appName)
Gets all application roles for given application ID. |
Configuration |
getConfiguration()
Gets Configuration object associated with this service. |
java.util.Set<BPMPosition> |
getGrantedPositionsToUser(java.lang.String user)
Gets all the position the given user is granted in the system. |
java.util.Set<BPMRole> |
getGrantedRolesToAppRole(java.lang.String roleName,
java.lang.String appName,
boolean direct)
Gets granted roles for the given application role |
java.util.Set<BPMRole> |
getGrantedRolesToGroup(java.lang.String groupName,
boolean direct)
Gets granted roles for the given group. |
java.util.Set |
getGrantedRolesToRole(java.lang.String roleName,
boolean direct)
Deprecated. since release 11. Use getGrantedRolesToGroup(String, boolean) instead |
java.util.Set |
getGrantedRolesToUser(java.lang.String userName,
boolean direct)
Gets a set of all granted roles for the given user |
java.util.Set |
getGrantedRolesToUser(java.lang.String userName,
java.lang.String appName,
boolean direct)
Gets a set of all granted roles for the given user for a given application |
java.util.Set |
getGrantees(java.lang.String name,
boolean direct)
Deprecated. since release 11. Use getGranteesToGroup(String, boolean) instead |
java.util.Set<BPMIdentity> |
getGranteesToAppRole(java.lang.String roleName,
java.lang.String appName,
boolean direct)
Gets all grantees for given application role |
java.util.Set<BPMIdentity> |
getGranteesToGroup(java.lang.String roleName,
boolean direct)
Gets all grantees for given group |
java.util.Set<BPMUser> |
getGranteesToPosition(java.lang.String positionId)
Gets users that are granted a given position in the system. |
Attribute |
getGroupAttribute(java.lang.String groupName,
java.lang.String attrName)
Gets BPMGroup 's attribute value given the attribute name |
java.util.List |
getGroups()
Deprecated. since release 11. Use searchGroups(String, String) instead |
java.util.List<java.lang.String> |
getLocaleSpecificGroupNames(java.util.List<java.lang.String> groupNames,
java.util.Locale locale)
gets locale specific groupNames |
java.util.List<java.lang.String> |
getLocaleSpecificUserNames(java.util.List<java.lang.String> userNames,
java.util.Locale locale)
gets locale specific userNames |
java.util.List |
getManagedRolesByRole(java.lang.String roleName,
boolean direct)
Gets managed roles by the given role |
java.util.List |
getManagedRolesByUser(java.lang.String userName,
boolean direct)
Gets managed roles by the given user |
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 groupName,
boolean direct)
Deprecated. since release 11. Use getParticipantsToGroup(String, boolean) for
group participants and #getParticipantsToAppRole(String, boolean) for application role participants |
java.util.List<BPMUser> |
getParticipantsToAppRole(java.lang.String roleName,
java.lang.String appName,
boolean direct)
Gets participants(Users), grantees to application role |
java.util.List<BPMUser> |
getParticipantsToGroup(java.lang.String groupName,
boolean direct)
Gets participants (Users), grantees to group |
java.security.PermissionCollection |
getPermissions(java.lang.String userName)
Gets Permissions associated with the user |
java.security.PermissionCollection |
getPermissions(java.lang.String userName,
java.lang.String appName)
Gets Permissions associated with the user for a given application |
java.security.PermissionCollection |
getPermissionsForAppRole(java.lang.String appRole,
java.lang.String appName)
Gets Permissions associated with the appRole for a given application |
java.util.Map<java.lang.String,java.lang.String> |
getPositionDisplayNames(java.util.List<java.lang.String> positions,
java.lang.String language,
java.lang.String country)
Gets the display name of the positions based on country and language. |
BPMProvider |
getProvider()
Gets provider assocaited with this service instance |
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.List |
getRoleManagers(java.lang.String roleName,
boolean direct)
Gets managers of the given role |
java.util.Set |
getRoleOwners(java.lang.String roleName,
boolean direct)
Gets owners of the given role |
java.util.List |
getRoles(RoleClassifier classifier)
Deprecated. since release 11. Use // TODO (String, String) or #searchAppRole(String, String) instead |
java.util.List<java.lang.String> |
getSearchableUserAttributes()
Gets list of all the searchable BPMUser attributes |
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 |
Attribute |
getUserAttribute(java.lang.String userName,
java.lang.String attrName)
Gets BPMUser 's attribute value given the attribute name |
java.util.List |
getUsers()
Deprecated. since release 11. Use searchUsers(String, String) instead |
boolean |
hasPermission(java.lang.String userName,
java.security.Permission perm,
java.lang.String appName)
Checks whether the user has a specified permission |
boolean |
hasPermissionForAppRole(java.lang.String appRole,
java.security.Permission perm,
java.lang.String appName)
Checks whether the appRole has a specified permission |
BPMAppRole |
lookupAppRole(java.lang.String appRoleName,
java.lang.String appID)
Looks up BPMAppRole by name |
BPMGroup |
lookupGroup(java.lang.String groupName)
Looks up BPMGroup by group name |
BPMRole |
lookupRole(java.lang.String groupName)
Deprecated. since release 11. Use lookupGroup(String) instead. To lookup BPMAppRole
use #lookupAppRole(String) |
BPMUser |
lookupUser(java.lang.String userName)
Looks up BPMUser by name in the system. |
java.util.List<BPMAppRole> |
searchAppRoles(java.lang.String namePattern,
java.lang.String appName)
Searches Application roles for the given app id and namePattern |
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 |
---|
Attribute getUserAttribute(java.lang.String userName, java.lang.String attrName) throws BPMIdentityException, BPMIdentityNotFoundException
BPMUser
's attribute value given the attribute name
userName
- The name of the user.attrName
- The name of the attribute.
Attribute> instance.
- Throws:
BPMIdentityNotFoundException
- If the user is not found.
BPMIdentityException
- If an exception condition occurs.
Attribute getGroupAttribute(java.lang.String groupName, java.lang.String attrName) throws BPMIdentityException, BPMIdentityNotFoundException
BPMGroup
's attribute value given the attribute name
groupName
- The name of the group.attrName
- The name of the attribute.
Attribute> instance.
- Throws:
BPMIdentityNotFoundException
- If the group is not found.
BPMIdentityException
- If an exception condition occurs.
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.
java.util.List searchUsers(java.lang.String attrName, java.lang.String attrValue) throws BPMIdentityException, BPMUnsupportedAttributeException
BPMUser
objects by an attribute's name-value pair
attrName
- The attribute name to be used in the search.attrValue
- The attribute value to be used in the search.
BPMUser
objects
BPMUnsupportedAttributeException
- If the attribute is not supported by the implementation of BPMUser.
BPMIdentityException
- If an exception condition occurs.java.util.List searchUsers(SearchFilter searchFilter) throws BPMIdentityException, BPMUnsupportedAttributeException
searchFilter
- An instance of the SearchFilter
BPMUnsupportedAttributeException
- If the attribute is not supported by the implementation of BPMUser.
BPMIdentityException
- If an exception condition occurs.java.util.List<java.lang.String> getLocaleSpecificUserNames(java.util.List<java.lang.String> userNames, java.util.Locale locale) throws BPMIdentityException, BPMIdentityNotFoundException
List
- of userNamesLocale
-
BPMIdentityNotFoundException
- If the user is not found.
BPMIdentityException
- If an exception condition occurs.java.util.List<java.lang.String> getLocaleSpecificGroupNames(java.util.List<java.lang.String> groupNames, java.util.Locale locale) throws BPMIdentityException, BPMIdentityNotFoundException
List
- of groupNamesLocale
-
BPMIdentityNotFoundException
- If the group is not found.
BPMIdentityException
- If an exception condition occurs.BPMRole lookupRole(java.lang.String groupName) throws BPMIdentityException, BPMIdentityNotFoundException
lookupGroup(String)
instead. To lookup BPMAppRole
use #lookupAppRole(String)
BPMRole
by role name
groupName
- The name of the role.
BPMIdentityNotFoundException
- If the role is not found.
BPMIdentityException
- If an exception condition occurs.BPMAppRole lookupAppRole(java.lang.String appRoleName, java.lang.String appID) throws BPMIdentityException, BPMIdentityNotFoundException
BPMAppRole
by name
appRoleName
- The name of the ApplicationRole
BPMIdentityNotFoundException
- If the application role is not found
BPMIdentityException
- If an exception condition occurs.BPMGroup lookupGroup(java.lang.String groupName) throws BPMIdentityException, BPMIdentityNotFoundException
BPMGroup
by group name
groupName
- The name of the group.
BPMIdentityNotFoundException
- If the group is not found.
BPMIdentityException
- If an exception condition occurs.java.util.List searchGroups(java.lang.String attrName, java.lang.String attrValue) throws BPMIdentityException, BPMUnsupportedAttributeException
BPMGroup
objects by an attribute's name-value pair
attrName
- 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 occursjava.util.List searchGroups(SearchFilter searchFilter) throws BPMIdentityException, BPMUnsupportedAttributeException
searchFilter
- a search filter object
BPMUnsupportedAttributeException
- if attribute is unsupported
BPMIdentityException
- If exception condition occursjava.util.List<BPMAppRole> searchAppRoles(java.lang.String namePattern, java.lang.String appName) throws BPMIdentityException
namePattern
- A regular expression which can contain wildcard ('*')appName
- an application name
BPMIdentityException
- If an exception condition occursjava.util.List getUsers() throws BPMIdentityException
searchUsers(String, String)
instead
BPMIdentityException
- If exception condition occursjava.util.List getGroups() throws BPMIdentityException
searchGroups(String, String)
instead
BPMIdentityException
- If exception condition occursjava.util.List getRoles(RoleClassifier classifier) throws BPMIdentityException
// TODO (String, String)
or #searchAppRole(String, String)
instead
classifier
- a role classifier
BPMIdentityException
- If exception condition occursjava.util.List getAppRoles() throws BPMIdentityException
BPMAppRole objects
- Throws:
BPMIdentityException
- If exception condition occurs
deprecated since release 11. Use {@link #getAppRoles(String) instead
java.util.List<BPMAppRole> getAppRoles(java.lang.String appName) throws BPMIdentityException
appName
- is an application name
BPMAppRole objects
- Throws:
BPMIdentityException
- If an exception condition occurs- Since:
- 11
java.util.Set getGrantedRolesToUser(java.lang.String userName, boolean direct) throws BPMIdentityException
userName
- The user namedirect
- a boolean flag. If it is true method returns only direct granted roles, else all roles are returned.
List
of granted BPMRole
s objects
BPMIdentityException
- If an exception condition occurs
BPMIdentityException
java.util.Set getGrantedRolesToUser(java.lang.String userName, java.lang.String appName, boolean direct) throws BPMIdentityException
userName
- The user namedirect
- a boolean flag. If it is true method returns only direct granted roles, else all roles are returned.appName
- is an application name
List
of granted BPMRole
s objects
BPMIdentityException
- If an exception condition occurs
BPMIdentityException
java.util.Set<BPMRole> getGrantedRolesToAppRole(java.lang.String roleName, java.lang.String appName, boolean direct) throws BPMIdentityException
roleName
- The name of application roleappName
- an application namedirect
- a boolean flag. Method returns direct grantees if direct flag is true, else all roles are returned.
BPMRole
objects
BPMIdentityException
- If exception condition occursjava.util.Set<BPMRole> getGrantedRolesToGroup(java.lang.String groupName, boolean direct) throws BPMIdentityException
groupName
- The group namedirect
- a boolean flag. Method returns direct granted roles if direct flag is true, else all
BPMRole
objects
BPMIdentityException
- If exception condition occursjava.util.Set<BPMIdentity> getGranteesToAppRole(java.lang.String roleName, java.lang.String appName, boolean direct) throws BPMIdentityException
appRole
- The name of application roleappName
- an application namedirect
- a boolean flag. The method returns direct grantees if direct flag is true, else all
BPMIdentity
objects
BPMIdentityException
- If exception condition occursjava.util.Set<BPMIdentity> getGranteesToGroup(java.lang.String roleName, boolean direct) throws BPMIdentityException
roleName
- The application role namedirect
- a boolean flag. The method returns direct grantees if it's true, else all grantees
BPMIdentity
objects
BPMIdentityException
- If exception condition occursjava.util.Set getGrantedRolesToRole(java.lang.String roleName, boolean direct) throws BPMIdentityException
getGrantedRolesToGroup(String, boolean)
instead
groupName
- The role namedirect
- a boolean flag. If it is true method returns only direct granted roles, else all roles
List
of granted BPMRole
s objects
BPMIdentityException
- if errors occurs
BPMIdentityException
java.util.List<BPMUser> getParticipantsToGroup(java.lang.String groupName, boolean direct) throws BPMIdentityException
groupName
- The group namedirect
- a boolean flag. If it is true method returns only direct granted roles, else all roles
BPMIdentityException
java.util.List<BPMUser> getParticipantsToAppRole(java.lang.String roleName, java.lang.String appName, boolean direct) throws BPMIdentityException
roleName
- an application role nameappName
- an namedirect
- a boolean flag. The method returns direct user grantees if it's true, else all user grantees
BPMIdentityException
- if errors occurs
BPMIdentityException
java.util.List getParticipants(java.lang.String groupName, boolean direct) throws BPMIdentityException
getParticipantsToGroup(String, boolean)
for
group participants and #getParticipantsToAppRole(String, boolean)
for application role participants
groupName
- a group namedirect
- a boolean flag. If true method return direct participants, else all.
BPMIdentityNotFoundException
- if group is not found
BPMIdentityException
- If exception condition occursjava.util.Set getGrantees(java.lang.String name, boolean direct) throws BPMIdentityException
getGranteesToGroup(String, boolean)
instead
groupName
- a group namedirect
- a boolean flag. If true method return direct participans, elase all.
BPMIdentityNotFoundException
- if group/role is not found
BPMIdentityException
- If exception condition occursjava.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 occursBPMUser getManager(java.lang.String userName) throws BPMIdentityException
userName
- The user name whose manager is requried.
BPMIdentityException
- If exception condition occursjava.util.List getManagementChain(java.lang.String userName, java.lang.String upToUser, java.lang.String upToTitle, int level) throws BPMIdentityException
userName
- a user name. The user for whom the Management chain has requested.upToUser
- a user name which limits chain result.
If this name is the same as that of the current user, then an empty list is returned.
Otherwise the list till this particular user is returned.upToTitle
- a title which limits chain result
If this title is the same as that of the current user, then an empty list is returned.
Otherwise the list till this particular title is returned.level
- a level, limits size of chain result
This sets a limit on the number of entries in the list. If 0, then an empty list is returned.
If negative, then the complete hierarchy is returned.
BPMIdentityException
- If exception condition occursjava.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 all
BPMIdentityException
- If exception condition occursjava.util.Set getOwnedRolesByRole(java.lang.String roleName, boolean direct) throws BPMIdentityException
groupName
- The group name. Since 11.1.1 the method assumes that only group names are passed.direct
- a boolean flag. If it true, the method returns direct owned roles, else all
BPMIdentityException
- If exception condition occursjava.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 all
BPMIdentityException
- If exception condition occursjava.util.List getRoleManagers(java.lang.String roleName, boolean direct) throws BPMIdentityException
roleName
- The role namedirect
- a boolean flag. If it true, the method returns direct managers, else all
BPMIdentityException
- If exception condition occursjava.util.List getManagedRolesByUser(java.lang.String userName, boolean direct) throws BPMIdentityException
userName
- The user namedirect
- a boolean flag. If it true, the method returns direct managed roles, else all
BPMIdentityException
- If exception condition occursjava.util.List getManagedRolesByRole(java.lang.String roleName, boolean direct) throws BPMIdentityException
roleName
- The role namedirect
- a boolean flag. If it true, the method returns direct managed roles, else all
BPMIdentityException
- If exception condition occursConfiguration getConfiguration() throws BPMIdentityException
BPMIdentityException
java.lang.String getRealmName() throws BPMIdentityException
BPMIdentityException
BPMUser whoAmI(javax.servlet.http.HttpServletRequest request) throws BPMIdentityException, BPMIdentityNotFoundException
request
- a HttpServletRequest object
BPMIdentityNotFoundException
- if object is not found
BPMIdentityException
- If exception condition occursboolean hasPermission(java.lang.String userName, java.security.Permission perm, java.lang.String appName) throws BPMIdentityException
userName
- The name of the user for whom the permission is to be checked.perm
- a Permission objectappName
- an application name
BPMIdentityException
- If exception condition occursjava.security.PermissionCollection getPermissions(java.lang.String userName) throws BPMIdentityException
userName
- The name of the user for whom the permissions are to be fetched
BPMIdentityException
- If exception condition occursjava.security.PermissionCollection getPermissions(java.lang.String userName, java.lang.String appName) throws BPMIdentityException
userName
- The name of the user for whom the permissions are to be fetchedappName
- an application name
BPMIdentityException
- If exception condition occursboolean hasPermissionForAppRole(java.lang.String appRole, java.security.Permission perm, java.lang.String appName) throws BPMIdentityException
userName
- The name of the appRole for which the permission is to be checked.perm
- a Permission objectappName
- an application name
BPMIdentityException
- If exception condition occursjava.security.PermissionCollection getPermissionsForAppRole(java.lang.String appRole, java.lang.String appName) throws BPMIdentityException
userName
- The name of the appRole for which the permissions are to be fetchedappName
- an application name
BPMIdentityException
- If exception condition occursjava.security.PermissionCollection getAllPermissions() throws BPMIdentityException
BPMIdentityException
- If exception condition occursjava.security.PermissionCollection getAllPermissions(java.lang.String appName) throws BPMIdentityException
appName
- an application name
BPMIdentityException
- If exception condition occursBPMProvider getProvider()
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 occurs
BPMIdentityException
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
java.util.Set<BPMUser> getGranteesToPosition(java.lang.String positionId) throws BPMIdentityException
positionId
-
BPMIdentityException
java.util.Set<BPMPosition> getGrantedPositionsToUser(java.lang.String user) throws BPMIdentityException
user
-
BPMIdentityException
java.util.Map<java.lang.String,java.lang.String> getPositionDisplayNames(java.util.List<java.lang.String> positions, java.lang.String language, java.lang.String country) throws BPMIdentityException
positions
- language
- country
-
BPMIdentityException
java.util.List<java.lang.String> getSearchableUserAttributes() throws BPMIdentityException
BPMUser
attributes
Attribute
names.
The list of attribute names returned includes name,displayName,description,firstName,middleName,lastName,workNumber,homePhone,mobile,pager,fax,email,and title.
BPMIdentityException
- If an exception condition occurs.
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |