Package ch.ivyteam.ivy.security

Interface ISecurity

  • All Known Subinterfaces:
    ISecurityContext
    public interface ISecurity

    The security is responsible to manage users, roles, security members and sessions.

    Examples:

    Find a role: 
    
 IRole manager = ivy.security.roles().find("Manager");
    Find a user: 
    
 IUser user = ivy.security.users().find("Ivy");
    Find a security member (user): 
    
 ISecurityMember member = ivy.security.members().find("#Ivy");
    Count sessions: 
    
 Number sessionCount = ivy.security.sessions().count();
    Since:
    9.3
    See Also:
    ISecurityContext
    API:
    This is a public API.

    • Method Detail

      • roles

        IRoleRepository roles()

        Gets the role repository of this security context. Allows to find roles of this security context / application.

        Example:

        
 IRole manager = ivy.security.roles().find("Manager");
        Returns:
        role repository
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • users

        IUserRepository users()

        Gets the user repository of this security context. Allows to create, delete, find, query users of this security context / application.

        Example:

        
 IUser user = ivy.security.users().find("Ivy");
        Returns:
        user repository
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • members

        IMemberRepository members()

        Gets the security member repository fo this security context. Allows to find security members of this security context / application.

        Example:

        
 ISecurityMember member = ivy.security.members().find("#Ivy");
        Returns:
        security member repository
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • sessions

        ISessionRepository sessions()

        Gets the session repository of this security context. Allows to create, destroy, find sessions of this security context / application.

        Example:

        
 Number sessionCount = ivy.security.sessions().count();
        Returns:
        session repository
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • current

        static ISecurity current()

        Gets the current security.

        Will return null if called out of scope. The scope is set if you call this method from an ivy process or any supported ivy environment. It is not set in non supported ivy environments (e.g. if you start your own threads, etc.).

        Returns:
        current security or null if out of scope
        API:
        This public API is available in Java.