BPMIdentity (Oracle Fusion Middleware Workflow Services Java API Reference for Oracle SOA Suite)

All Superinterfaces:

BPMPrincipal, java.security.Principal

All Known Subinterfaces:

BPMAppRole, BPMGroup, BPMRole, BPMUser
```
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.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.

Methods inherited from interface oracle.tip.pc.services.identity.BPMPrincipal
getAttribute, getAttributes, getDescription, getDisplayName, getDisplayName, getFullName, getGuid, getRealmName, getUniqueName, toNode

Methods inherited from interface java.security.Principal
equals, getName, hashCode, implies, toString

- Method Detail
  - getIdentityType
```
BPMIdentityType getIdentityType()
```
    Gets identity type. Refer BPMIdentityType for the possible values.
    
    Returns:
    
    BPMIdentityType.
  - getEmail
```
java.lang.String getEmail()
                   throws BPMIdentityException
```
    Gets e-mail address for this BPMIdentity.
    
    Returns:
    
    e-mail adderess or null if not populated in the system.
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - isInRole
```
boolean isInRole(BPMRole role)
          throws BPMIdentityException
```
    Defines whether the BPMIdentity belongs to given BPMRole
    
    Parameters:
    
    role - The role against which the check is to be made.
    
    Returns:
    
    true if this identity belongs to given BPMRole, false otherwise.
    
    Throws:
    
    BPMIdentityException - If exception condition occurs or the role could not be found.
    
    BPMIdentityException
  - isInGroup
```
boolean isInGroup(java.lang.String groupName)
           throws BPMIdentityException
```
    Defines whether the BPMIdentity belongs to given Group. Note that isInGroup just checks whether the identity is in given group, it does not validate the existence of the group itself.
    
    Parameters:
    
    groupName - The group against which the check is to be made.
    
    Returns:
    
    true if this identity belongs to given Group, false otherwise.
    
    Throws:
    
    BPMIdentityException - If exception condition occurs
    
    BPMIdentityException
  - isInAppRole
```
boolean isInAppRole(java.lang.String appRoleName,
                    java.lang.String appId)
             throws BPMIdentityException
```
    Defines whether the BPMIdentity belongs to given Application Role. Note that isInAppRole just checks whether the identity is in given app role, it does not validate the existence of the group itself.
    
    Parameters:
    
    appRoleName - The AppRole against which the check is to be made.
    
    appId - application Id
    
    Returns:
    
    true if this identity belongs to given AppRole, false otherwise.
    
    Throws:
    
    BPMIdentityException - If exception condition occurs
    
    BPMIdentityException
  - isInRole
```
boolean isInRole(java.lang.String groupName)
          throws BPMIdentityException,
                 BPMIdentityNotFoundException
```
    Deprecated. since release 11. Use isInRole(BPMRole) Or (String groupName) instead
    
    Defines whether the BPMIdentity belongs to given BPMGroup name
    
    Parameters:
    
    groupName - is a BPMGroup name
    
    Returns:
    
    boolean true if user in group
    
    Throws:
    
    BPMIdentityNotFoundException - If the group could not be found.
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
    
    BPMIdentityNotFoundException
  - getAppRoles
```
java.util.List getAppRoles(boolean direct)
                    throws BPMIdentityException
```
    Gets list of application roles,BPMAppRoles, which this BPMIndentity has been granted.
    
    Parameters:
    
    direct - a boolean if true only direct roles, else all roles
    
    Returns:
    
    List of granted BPMRoles objects which this BPMIndentity has
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getAppRoles
```
java.util.List getAppRoles(boolean direct,
                           java.lang.String appName)
                    throws BPMIdentityException
```
    Gets list of application roles,BPMAppRoles, which this BPMIndentity has been granted.
    
    Parameters:
    
    direct - a boolean if true only direct roles, else all roles
    
    appName - a application Name
    
    Returns:
    
    List of granted BPMRoles objects which this BPMIndentity has
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getRoles
```
java.util.List getRoles(RoleClassifier roleType,
                        boolean direct)
                 throws BPMIdentityException
```
    Deprecated. since release 11. Use getGrantedRoles(boolean) instead
    
    Gets list of all BPMRoles which this BPMIndentity has
    
    Parameters:
    
    roleType - a role classifier
    
    direct - a boolean if true method returns only direct granted roles, else all roles
    
    Returns:
    
    List of granted BPMRoles objects which this BPMIndentity has
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getGroups
```
java.util.List getGroups(boolean direct)
                  throws BPMIdentityException
```
    Gets list of all BPMGroup objects which this BPMIndentity has been granted.
    
    Parameters:
    
    direct - is a boolean flag. If is true the method returns only direct granted groups, else all groups
    
    Returns:
    
    List of BPMGroups objects which this BPMIndentity belongs
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getGrantedRoles
```
java.util.Set getGrantedRoles(boolean direct)
                       throws BPMIdentityException
```
    Gets set of all BPMRole objects which the BPMIndentity has been granted
    
    Parameters:
    
    direct - is a boolean flag. If is true the method returns only direct granted roles, else all
    
    Returns:
    
    Set of BPMRole objects which are graned to given identity
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getGrantedRoles
```
java.util.Set getGrantedRoles(boolean direct,
                              java.lang.String appName)
                       throws BPMIdentityException
```
    Gets set of all BPMRole objects which the BPMIndentity has been granted
    
    Parameters:
    
    direct - is a boolean flag. If is true the method returns only direct granted roles, else all
    
    appName - a application Name
    
    Returns:
    
    Set of BPMRole objects which are graned to given identity
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getActions
```
java.util.Set getActions()
                  throws BPMIdentityException
```
    Deprecated. since 11. Use BPMUser.hasPermission(Permission, String) for user object
    
    Gets list of Actions which this BPMIndentity has.
    
    Returns:
    
    List of Actions
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
    
    BPMIdentityException
  - getOwnedRoles
```
java.util.Set getOwnedRoles(boolean direct)
                     throws BPMIdentityException
```
    Gets all roles owned by this identity.
    
    Parameters:
    
    direct - a boolean flag. If true return direct onwed roles, else all owned rolse
    
    Returns:
    
    Set of BPMRole objects which the principal owns
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
  - isOwner
```
boolean isOwner(BPMRole role)
         throws BPMIdentityException
```
    Check whether the principal owns the role.
    
    Parameters:
    
    role - a BPMRole
    
    Returns:
    
    boolean true, if principal owns the role, else false. Method returns false if role is BPMAppRole
    
    Throws:
    
    BPMIdentityException - If exception condition occurs.
  - getManagedRoles
```
java.util.List<BPMRole> getManagedRoles(boolean direct)
                                 throws BPMIdentityException
```
    Gets a List of BPMRoles managed by this identity.
    
    Parameters:
    
    direct - a boolean flag. If true, returns only directly managed roles, else all.
    
    Returns:
    
    List of BPMRole objects that are managed by this identity
    
    Throws:
    
    BPMIdentityException - if error occurs

Interface BPMIdentity

Method Summary

Methods inherited from interface oracle.tip.pc.services.identity.BPMPrincipal

Methods inherited from interface java.security.Principal

Method Detail

getIdentityType

getEmail

isInRole

isInGroup

isInAppRole

isInRole

getAppRoles

getAppRoles

getRoles

getGroups

getGrantedRoles

getGrantedRoles

getActions

getOwnedRoles

isOwner

getManagedRoles