Package oracle.tip.pc.services.identity

Interface BPMIdentity

All Superinterfaces:
BPMPrincipal, 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 Details

    • getIdentityType

      BPMIdentityType getIdentityType()
      Gets identity type. Refer BPMIdentityType for the possible values.
      Returns:
      BPMIdentityType.

    • getEmail

      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

    • 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

    • isInGroup

      boolean isInGroup(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

    • isInAppRole

      boolean isInAppRole(String appRoleName, 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

    • isInRole

      boolean isInRole(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:
      BPMIdentityException
      BPMIdentityNotFoundException

    • getAppRoles

      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

    • getAppRoles

      List getAppRoles(boolean direct, 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

    • getRoles

      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

    • getGroups

      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

    • getGrantedRoles

      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

    • getGrantedRoles

      Set getGrantedRoles(boolean direct, 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

    • getActions

      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

    • getOwnedRoles

      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

      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