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 Detail

      • 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 IvyScript and Java. It has the visibility EXPERT.

      • 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 IvyScript and Java. It has the visibility NOVICE.
        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 IvyScript and Java. It has the visibility NOVICE.
        Security:
        Role: SESSION OWNS RoleReadName PERMISSION OR OWNS RoleReadName@SYSTEM PERMISSION
        User: SESSION (MATCHES THIS AND OWNS UserReadOwnName PERMISSION) OR OWNS UserReadName PERMISSION OR OWNS UserReadName@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 IvyScript and Java. It has the visibility NOVICE.
        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 IvyScript and Java. It has the visibility NOVICE.

      • getId

        long getId()
        Gets the identifier of the security member
        Returns:
        identifier
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • 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 IvyScript and Java. It has the visibility EXPERT.