Package ch.ivyteam.ivy.security

Interface ISecurityMember

All Known Subinterfaces:
IRole, IUser
public interface ISecurityMember
Base interface for IUser and IRole.
Since:
17.05.2006
API:
This is a public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disable()
    Disables the security member if enabled.
    void
    enable()
    Enables the security member if disabled.
    String
    getDisplayName()
    Returns the display name of this security member.
    long
    getId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    use getSecurityMemberId()
    String
    getMemberName()
    Returns the member name of the security member.
    String
    getName()
    Returns the name of this security member.
    ISecurityContext
    getSecurityContext()
    Gets the security context this security member is defined in
    boolean
    isEnabled()
    Whether the security member is enabled or not.
    boolean
    isMember(IUserToken userToken, boolean useSessionRoles)
    Returns true if the user token is a member of this task activator
    boolean
    isUser()
    Is this member a user

  • Method Details

    • isMember

      boolean isMember(IUserToken userToken, boolean useSessionRoles)
      Returns true if the user token is a member of this task activator
      Parameters:
      userToken - the user token
      useSessionRoles - if true the temporary roles set on a user session are also used for the check.
      Returns:
      true if user token is a member, otherwise false
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.

    • isEnabled

      boolean isEnabled()
      Whether the security member is enabled or not.
      Returns:
      true if enabled otherwise false
      Since:
      9.1
      See Also:
      API:
      This public API is available in Java.

    • enable

      void enable()

      Enables the security member if disabled.

      A disabled user cannot be enabled if the license lacks named users.

      Disabling and enabling a security member has no effect on:

      • The task history or task assignment
      • User to role assignments or role memberships

      External identity providers may enable security members automatically when synchronizing.

      Since:
      9.1
      See Also:
      API:
      This public API is available in Java.

    • disable

      void disable()

      Disables the security member if enabled.

      Disabling a security member has the following effect:

      • A disabled user will no longer count as a named user for the license.
      • A disabled user will no longer be able to log in.
      • A disabled user is not shown in the Engine Cockpit by default. Choose the special filter on the users view to show it.
      • A disabled users can be enabled again in the Engine Cockpit.
      • All tasks assigned to the security member will be kept assigned to it. Use the Portal or the TaskQuery#IFilterableColumn#activatorAvailable() API to find tasks assigned to a disabled security member so that you can reassign them to an enabled one.
      • The history of tasks will not be changed.
      • User to role assignments and role membership will not be changed.
      • Normally disabled security members are not displayed. E.g., by the Portal to reassign a task.

      External identity providers may disable security members automatically when synchronizing.

      Since:
      9.1
      See Also:
      API:
      This public API is available in Java.

    • getMemberName

      String getMemberName()
      Returns the member name of the security member. In case of a role the role name is returned. In case of a user "#" + user name is returned.
      Returns:
      member name of this security member
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION (MATCHES THIS AND OWNS UserReadOwnName PERMISSION) OR OWNS UserReadName PERMISSION OR OWNS UserReadName@SYSTEM PERMISSION

    • getName

      String getName()
      Returns the name of this security member.
      Returns:
      name of this security member
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS RoleReadName PERMISSION OR OWNS RoleReadName@SYSTEM PERMISSION

    • getDisplayName

      String getDisplayName()
      Returns the display name of this security member. If the display name is empty, it returns the name getName() of this security member.
      Returns:
      display name of this security member
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      Role: SESSION OWNS RoleReadDisplayName PERMISSION OR OWNS RoleReadDisplayName@SYSTEM PERMISSION
      User: SESSION ((MATCHES THIS AND OWNS UserReadOwnName PERMISSION) OR OWNS UserReadName PERMISSION OR OWNS UserReadName@SYSTEM PERMISSION) AND ((MATCHES THIS AND OWNS UserReadOwnFullName PERMISSION) OR OWNS UserReadFullName PERMISSION OR OWNS UserReadFullName@SYSTEM PERMISSION)

    • isUser

      boolean isUser()
      Is this member a user
      Returns:
      true if the member is a user, false if it is role
      API:
      This public API is available in Java.

    • getId

      @Deprecated(since="9.4", forRemoval=true) long getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getSecurityMemberId()
      API:
      This public API is available in Java.

    • getSecurityContext

      ISecurityContext getSecurityContext()
      Gets the security context this security member is defined in
      Returns:
      security context
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.