public interface BPMIdentity extends BPMPrincipal
BPMIdentity
interface defines a BPEL Process Manager Identity.
This interface can be implemented to represented a user or role entity in the backend.Modifier and Type | Method and Description |
---|---|
java.util.Set |
getActions()
Deprecated.
since 11. Use
BPMUser.hasPermission(Permission, String) for user object |
java.util.List |
getAppRoles(boolean direct)
Gets list of application roles,
BPMAppRole s, which this BPMIndentity has been granted. |
java.util.List |
getAppRoles(boolean direct,
java.lang.String appName)
Gets list of application roles,
BPMAppRole s, which this BPMIndentity has been granted. |
java.lang.String |
getEmail()
Gets e-mail address for this
BPMIdentity . |
java.util.Set |
getGrantedRoles(boolean direct)
Gets set of all
BPMRole objects which the BPMIndentity has been granted |
java.util.Set |
getGrantedRoles(boolean direct,
java.lang.String appName)
Gets set of all
BPMRole objects which the BPMIndentity has been granted |
java.util.List |
getGroups(boolean direct)
Gets list of all
BPMGroup objects which this BPMIndentity has been granted. |
BPMIdentityType |
getIdentityType()
Gets identity type.
|
java.util.List<BPMRole> |
getManagedRoles(boolean direct)
Gets a List of BPMRoles managed by this identity.
|
java.util.Set |
getOwnedRoles(boolean direct)
Gets all roles owned by this identity.
|
java.util.List |
getRoles(RoleClassifier roleType,
boolean direct)
Deprecated.
since release 11. Use
getGrantedRoles(boolean) instead |
boolean |
isInAppRole(java.lang.String appRoleName,
java.lang.String appId)
Defines whether the BPMIdentity belongs to given Application Role.
|
boolean |
isInGroup(java.lang.String groupName)
Defines whether the BPMIdentity belongs to given Group.
|
boolean |
isInRole(BPMRole role)
Defines whether the BPMIdentity belongs to given
BPMRole |
boolean |
isInRole(java.lang.String groupName)
Deprecated.
since release 11. Use
isInRole(BPMRole) Or (String groupName) instead |
boolean |
isOwner(BPMRole role)
Check whether the principal owns the role.
|
getAttribute, getAttributes, getDescription, getDisplayName, getDisplayName, getFullName, getGuid, getRealmName, getUniqueName, toNode
BPMIdentityType getIdentityType()
BPMIdentityType
for the possible values.java.lang.String getEmail() throws BPMIdentityException
BPMIdentity
.BPMIdentityException
- If exception condition occurs.BPMIdentityException
boolean isInRole(BPMRole role) throws BPMIdentityException
BPMRole
role
- The role against which the check is to be made.BPMRole
, false otherwise.BPMIdentityException
- If exception condition occurs or the role could not be found.BPMIdentityException
boolean isInGroup(java.lang.String groupName) throws BPMIdentityException
groupName
- The group against which the check is to be made.BPMIdentityException
- If exception condition occursBPMIdentityException
boolean isInAppRole(java.lang.String appRoleName, java.lang.String appId) throws BPMIdentityException
appRoleName
- The AppRole against which the check is to be made.appId
- application IdBPMIdentityException
- If exception condition occursBPMIdentityException
boolean isInRole(java.lang.String groupName) throws BPMIdentityException, BPMIdentityNotFoundException
isInRole(BPMRole)
Or (String groupName)
insteadBPMGroup
namegroupName
- is a BPMGroup nameBPMIdentityNotFoundException
- If the group could not be found.BPMIdentityException
- If exception condition occurs.BPMIdentityException
BPMIdentityNotFoundException
java.util.List getAppRoles(boolean direct) throws BPMIdentityException
BPMAppRole
s, which this BPMIndentity
has been granted.direct
- a boolean if true only direct roles, else all rolesList
of granted BPMRole
s objects which this
BPMIndentity
hasBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.List getAppRoles(boolean direct, java.lang.String appName) throws BPMIdentityException
BPMAppRole
s, which this BPMIndentity
has been granted.direct
- a boolean if true only direct roles, else all rolesappName
- a application NameList
of granted BPMRole
s objects which this
BPMIndentity
hasBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.List getRoles(RoleClassifier roleType, boolean direct) throws BPMIdentityException
getGrantedRoles(boolean)
insteadBPMRole
s which this BPMIndentity
hasroleType
- a role classifierdirect
- a boolean if true method returns only direct granted roles, else all rolesList
of granted BPMRole
s objects which this
BPMIndentity
hasBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.List getGroups(boolean direct) throws BPMIdentityException
BPMGroup
objects which this BPMIndentity
has been granted.direct
- is a boolean flag. If is true the method returns only direct granted groups, else all groupsList
of BPMGroup
s objects which this
BPMIndentity
belongsBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.Set getGrantedRoles(boolean direct) throws BPMIdentityException
BPMRole
objects which the BPMIndentity
has been granteddirect
- is a boolean flag. If is true the method returns only direct granted roles, else allSet
of BPMRole
objects which are graned to given identityBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.Set getGrantedRoles(boolean direct, java.lang.String appName) throws BPMIdentityException
BPMRole
objects which the BPMIndentity
has been granteddirect
- is a boolean flag. If is true the method returns only direct granted roles, else allappName
- a application NameSet
of BPMRole
objects which are graned to given identityBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.Set getActions() throws BPMIdentityException
BPMUser.hasPermission(Permission, String)
for user objectActions which this BPMIndentity
has.
List
of ActionsBPMIdentityException
- If exception condition occurs.BPMIdentityException
java.util.Set getOwnedRoles(boolean direct) throws BPMIdentityException
direct
- a boolean flag. If true return direct onwed roles, else all owned rolseBPMIdentityException
- If exception condition occurs.boolean isOwner(BPMRole role) throws BPMIdentityException
role
- a BPMRoleBPMIdentityException
- If exception condition occurs.java.util.List<BPMRole> getManagedRoles(boolean direct) throws BPMIdentityException
direct
- a boolean flag. If true, returns only directly managed roles, else all.BPMIdentityException
- if error occurs