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.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(HttpServletRequest request) Who am I

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

getStatus

Method Detail

getUserAttribute

Attribute getUserAttribute(java.lang.String userName,
                           java.lang.String attrName)
                           throws BPMIdentityException,
                                  BPMIdentityNotFoundException

Gets BPMUser's attribute value given the attribute name

Parameters:

userName - The name of the user.

attrName - The name of the attribute.

Returns:

A Attribute</> instance.

Throws:

BPMIdentityNotFoundException - If the user is not found.

BPMIdentityException - If an exception condition occurs.

getGroupAttribute

Attribute getGroupAttribute(java.lang.String groupName,
                            java.lang.String attrName)
                            throws BPMIdentityException,
                                   BPMIdentityNotFoundException

Gets BPMGroup's attribute value given the attribute name

Parameters:

groupName - The name of the group.

attrName - The name of the attribute.

Returns:

A Attribute</> instance.

Throws:

BPMIdentityNotFoundException - If the group is not found.

BPMIdentityException - If an exception condition occurs.

lookupUser

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

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

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.

getLocaleSpecificUserNames

java.util.List<java.lang.String> getLocaleSpecificUserNames(java.util.List<java.lang.String> userNames,
                                                            java.util.Locale locale)
                                                            throws BPMIdentityException,
                                                                   BPMIdentityNotFoundException

gets locale specific userNames

Parameters:

List - of userNames

Locale -

Returns:

List of locale specific Names for the users For each entry in the input list (userNames) the corresponding localeName is returned in the same position in the ouput list

Throws:

BPMIdentityNotFoundException - If the user is not found.

BPMIdentityException - If an exception condition occurs.

getLocaleSpecificGroupNames

java.util.List<java.lang.String> getLocaleSpecificGroupNames(java.util.List<java.lang.String> groupNames,
                                                             java.util.Locale locale)
                                                             throws BPMIdentityException,
                                                                    BPMIdentityNotFoundException

gets locale specific groupNames

Parameters:

List - of groupNames

Locale -

Returns:

List of locale specific Names for the groups For each entry in the input list (groupNames) the corresponding localeName is returned in the same position in the ouput list

Throws:

BPMIdentityNotFoundException - If the group is not found.

BPMIdentityException - If an exception condition occurs.

lookupRole

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

Deprecated. since release 11. Use lookupGroup(String) instead. To lookup BPMAppRole use #lookupAppRole(String)

Looks up BPMRole by role name

Parameters:

groupName - The name of the role.

Throws:

BPMIdentityNotFoundException - If the role is not found.

BPMIdentityException - If an exception condition occurs.

lookupAppRole

BPMAppRole lookupAppRole(java.lang.String appRoleName,
                         java.lang.String appID)
                         throws BPMIdentityException,
                                BPMIdentityNotFoundException

Looks up BPMAppRole by name

Parameters:

appRoleName - The name of the ApplicationRole

Throws:

BPMIdentityNotFoundException - If the application role is not found

BPMIdentityException - If an exception condition occurs.

lookupGroup

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

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

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

searchAppRoles

java.util.List<BPMAppRole> searchAppRoles(java.lang.String namePattern,
                                          java.lang.String appName)
                                          throws BPMIdentityException

Searches Application roles for the given app id and namePattern

Parameters:

namePattern - A regular expression which can contain wildcard ('*')

appName - an application name

Returns:

List of BPMAppRole

Throws:

BPMIdentityException - If an exception condition occurs

getUsers

java.util.List getUsers()
                        throws BPMIdentityException

Deprecated. since release 11. Use searchUsers(String, String) instead

Gets all users name in realm

Returns:

List of user names in realm

Throws:

BPMIdentityException - If exception condition occurs

getGroups

java.util.List getGroups()
                         throws BPMIdentityException

Deprecated. since release 11. Use searchGroups(String, String) instead

Gets all group name in realm

Returns:

List of groupname in realm

Throws:

BPMIdentityException - If exception condition occurs

getRoles

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

Deprecated. since release 11. Use // TODO (String, String) or #searchAppRole(String, String) instead

Gets all roles in realm

Parameters:

classifier - a role classifier

Throws:

BPMIdentityException - If exception condition occurs

getAppRoles

java.util.List getAppRoles()
                           throws BPMIdentityException

Gets all application roles for all application

Returns:

List of BPMAppRole objects

Throws:

BPMIdentityException - If exception condition occurs deprecated since release 11. Use {@link #getAppRoles(String) instead

getAppRoles

java.util.List<BPMAppRole> getAppRoles(java.lang.String appName)
                                       throws BPMIdentityException

Gets all application roles for given application ID.

Parameters:

appName - is an application name

Returns:

List of BPMAppRole objects

Throws:

BPMIdentityException - If an exception condition occurs

Since:

11

getGrantedRolesToUser

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

Gets a set of all granted roles for the given user

Parameters:

userName - The user name

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

Returns:

List of granted BPMRoles objects

Throws:

BPMIdentityException - If an exception condition occurs

BPMIdentityException

Since:

10.1.3

getGrantedRolesToUser

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

Gets a set of all granted roles for the given user for a given application

Parameters:

userName - The user name

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

appName - is an application name

Returns:

List of granted BPMRoles objects

Throws:

BPMIdentityException - If an exception condition occurs

BPMIdentityException

Since:

10.1.3

getGrantedRolesToAppRole

java.util.Set<BPMRole> getGrantedRolesToAppRole(java.lang.String roleName,
                                                java.lang.String appName,
                                                boolean direct)
                                                throws BPMIdentityException

Gets granted roles for the given application role

Parameters:

roleName - The name of application role

appName - an application name

direct - a boolean flag. Method returns direct grantees if direct flag is true, else all roles are returned.

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs

Since:

11

getGrantedRolesToGroup

java.util.Set<BPMRole> getGrantedRolesToGroup(java.lang.String groupName,
                                              boolean direct)
                                              throws BPMIdentityException

Gets granted roles for the given group.

Parameters:

groupName - The group name

direct - a boolean flag. Method returns direct granted roles if direct flag is true, else all

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs

Since:

11

getGranteesToAppRole

java.util.Set<BPMIdentity> getGranteesToAppRole(java.lang.String roleName,
                                                java.lang.String appName,
                                                boolean direct)
                                                throws BPMIdentityException

Gets all grantees for given application role

Parameters:

appRole - The name of application role

appName - an application name

direct - a boolean flag. The method returns direct grantees if direct flag is true, else all

Returns:

Set of BPMIdentity objects

Throws:

BPMIdentityException - If exception condition occurs

Since:

11

getGranteesToGroup

java.util.Set<BPMIdentity> getGranteesToGroup(java.lang.String roleName,
                                              boolean direct)
                                              throws BPMIdentityException

Gets all grantees for given group

Parameters:

roleName - The application role name

direct - a boolean flag. The method returns direct grantees if it's true, else all grantees

Returns:

Set of BPMIdentity objects

Throws:

BPMIdentityException - If exception condition occurs

Since:

11

getGrantedRolesToRole

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

Deprecated. since release 11. Use getGrantedRolesToGroup(String, boolean) instead

Gets granted roles for the given role

Parameters:

groupName - The 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

Since:

10.1.3

getParticipantsToGroup

java.util.List<BPMUser> getParticipantsToGroup(java.lang.String groupName,
                                               boolean direct)
                                               throws BPMIdentityException

Gets participants (Users), grantees to group

Parameters:

groupName - The group name

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

Returns:

List of BPMUser objects

Throws:

BPMIdentityException

getParticipantsToAppRole

java.util.List<BPMUser> getParticipantsToAppRole(java.lang.String roleName,
                                                 java.lang.String appName,
                                                 boolean direct)
                                                 throws BPMIdentityException

Gets participants(Users), grantees to application role

Parameters:

roleName - an application role name

appName - an name

direct - a boolean flag. The method returns direct user grantees if it's true, else all user grantees

Returns:

List of BPMUser objects

Throws:

BPMIdentityException - if errors occurs

BPMIdentityException

Since:

11

getParticipants

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

Deprecated. since release 11. Use getParticipantsToGroup(String, boolean) for group participants and #getParticipantsToAppRole(String, boolean) for application role participants

Gets user participants, the grantee for given group name

Parameters:

groupName - a group name

direct - a boolean flag. If true method return direct participants, else 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

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

Deprecated. since release 11. Use getGranteesToGroup(String, boolean) instead

Gets all grantees for given group/role name

Parameters:

groupName - a group 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

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

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

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. 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.

Returns:

List of Users who are in management chain for given user

Throws:

BPMIdentityException - If exception condition occurs

getOwnedRolesByUser

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

Since:

10.1.3

getOwnedRolesByRole

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

Gets set of roles owned by given group. Since 11.1.1 role ownership is supported only for group.

Parameters:

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

Returns:

Set of BPMRole objects. Since 11.1.1 result is a set of BPMGroup objects

Throws:

BPMIdentityException - If exception condition occurs

Since:

10.1.3

getRoleOwners

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

getRoleManagers

java.util.List getRoleManagers(java.lang.String roleName,
                               boolean direct)
                               throws BPMIdentityException

Gets managers of the given role

Parameters:

roleName - The role name

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

Returns:

Set of BPMIdentity objects

Throws:

BPMIdentityException - If exception condition occurs

getManagedRolesByUser

java.util.List getManagedRolesByUser(java.lang.String userName,
                                     boolean direct)
                                     throws BPMIdentityException

Gets managed roles by the given user

Parameters:

userName - The user name

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

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs

getManagedRolesByRole

java.util.List getManagedRolesByRole(java.lang.String roleName,
                                     boolean direct)
                                     throws BPMIdentityException

Gets managed roles by the given role

Parameters:

roleName - The role name

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

Returns:

Set of BPMRole objects

Throws:

BPMIdentityException - If exception condition occurs

getConfiguration

Configuration getConfiguration()
                               throws BPMIdentityException

Gets Configuration object associated with this service.

Throws:

BPMIdentityException

Since:

10.1.3

getRealmName

java.lang.String getRealmName()
                              throws BPMIdentityException

Gets realm name assocaited with this service.

Returns:

realm name

Throws:

BPMIdentityException

whoAmI

BPMUser whoAmI(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

hasPermission

boolean hasPermission(java.lang.String userName,
                      java.security.Permission perm,
                      java.lang.String appName)
                      throws BPMIdentityException

Checks whether the user has a specified permission

Parameters:

userName - The name of the user for whom the permission is to be checked.

perm - a Permission object

appName - an application name

Returns:

true if user has specified permission, else false

Throws:

BPMIdentityException - If exception condition occurs

Since:

11

getPermissions

java.security.PermissionCollection getPermissions(java.lang.String userName)
                                                  throws BPMIdentityException

Gets Permissions associated with the user

Parameters:

userName - The name of the user for whom the permissions are to be fetched

Returns:

PermissionCollection

Throws:

BPMIdentityException - If exception condition occurs

getPermissions

java.security.PermissionCollection getPermissions(java.lang.String userName,
                                                  java.lang.String appName)
                                                  throws BPMIdentityException

Gets Permissions associated with the user for a given application

Parameters:

userName - The name of the user for whom the permissions are to be fetched

appName - an application name

Returns:

PermissionCollection

Throws:

BPMIdentityException - If exception condition occurs

hasPermissionForAppRole

boolean hasPermissionForAppRole(java.lang.String appRole,
                                java.security.Permission perm,
                                java.lang.String appName)
                                throws BPMIdentityException

Checks whether the appRole has a specified permission

Parameters:

userName - The name of the appRole for which the permission is to be checked.

perm - a Permission object

appName - an application name

Returns:

true if appRole has specified permission, else false

Throws:

BPMIdentityException - If exception condition occurs

Since:

11

getPermissionsForAppRole

java.security.PermissionCollection getPermissionsForAppRole(java.lang.String appRole,
                                                            java.lang.String appName)
                                                            throws BPMIdentityException

Gets Permissions associated with the appRole for a given application

Parameters:

userName - The name of the appRole for which the permissions are to be fetched

appName - an application name

Returns:

PermissionCollection

Throws:

BPMIdentityException - If exception condition occurs

getAllPermissions

java.security.PermissionCollection getAllPermissions()
                                                     throws BPMIdentityException

Gets all Permissions associated with all the applications

Returns:

PermissionCollection

Throws:

BPMIdentityException - If exception condition occurs

getAllPermissions

java.security.PermissionCollection getAllPermissions(java.lang.String appName)
                                                     throws BPMIdentityException

Gets all the Permissions associated with the given application

Parameters:

appName - an application name

Returns:

PermissionCollection

Throws:

BPMIdentityException - If exception condition occurs

getProvider

BPMProvider getProvider()

Gets provider assocaited with this service instance

Returns:

BPMProvider instance

getSearchFilterInstance

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

Since:

10.1.3

getSearchFilterInstance

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

Since:

10.1.3

getGranteesToPosition

java.util.Set<BPMUser> getGranteesToPosition(java.lang.String positionId)
                                             throws BPMIdentityException

Gets users that are granted a given position in the system.

Parameters:

positionId -

Returns:

set of BPMUsers that are granted the position.

Throws:

BPMIdentityException

getGrantedPositionsToUser

java.util.Set<BPMPosition> getGrantedPositionsToUser(java.lang.String user)
                                                     throws BPMIdentityException

Gets all the position the given user is granted in the system. A valid BPMUser object with userid and guid is required as input parameter.

Parameters:

user -

Returns:

Set of positions granted to a given user.

Throws:

BPMIdentityException

getPositionDisplayNames

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

Gets the display name of the positions based on country and language. If country and language is not specified default locale of the JVM is used. If the language is not specified country code is used to build the locale.

Parameters:

positions -

language -

country -

Returns:

map of position id and position display name specific to the input language and country.

Throws:

BPMIdentityException

getSearchableUserAttributes

java.util.List<java.lang.String> getSearchableUserAttributes()
                                                             throws BPMIdentityException

Gets list of all the searchable BPMUser attributes

Returns:

A list of Attribute names. The list of attribute names returned includes name,displayName,description,firstName,middleName,lastName,workNumber,homePhone,mobile,pager,fax,email,and title.

Throws:

BPMIdentityException - If an exception condition occurs.

Skip navigation links