Package com.attivio.sdk.security

Class AttivioAcl

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<AttivioAclEntry>, java.security.acl.Acl, java.security.acl.Owner
    public class AttivioAcl
extends java.lang.Object
implements java.security.acl.Acl, java.lang.Iterable<AttivioAclEntry>, java.io.Serializable
    Represents an access control list (ACL). Basically, a collection of ACL entries.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static AttivioAcl ANON_ACL
      Represents the ACL that grants read access to the anonymous user (and therefore, effectively to everyone).

    • Constructor Summary

      Constructors 
      Constructor Description
      AttivioAcl()
      Creates a blank ACL object.
      AttivioAcl​(java.lang.String aclName)
      Creates a blank ACL object with a name.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addEntries​(java.lang.Iterable<AttivioAclEntry> entries2)  
      void addEntries​(java.util.List<AttivioAclEntry> newEntries)
      Adds entries to the ACL.
      boolean addEntry​(java.security.acl.AclEntry entry)
      Adds an ACL entry to the ACL.
      boolean addEntry​(java.security.Principal caller, java.security.acl.AclEntry entry)
      boolean addOwner​(java.security.Principal caller, java.security.Principal owner)
      boolean checkPermission​(java.security.Principal principal, java.security.acl.Permission permission)
      boolean deleteOwner​(java.security.Principal caller, java.security.Principal owner)
      java.util.Enumeration<java.security.acl.AclEntry> entries()  
      boolean equals​(java.lang.Object obj)
      java.lang.String getName()
      java.util.Enumeration<java.security.acl.Permission> getPermissions​(java.security.Principal prin)
      int hashCode()
      boolean isOwner​(java.security.Principal owner)
      java.util.Iterator<AttivioAclEntry> iterator()  
      boolean removeEntry​(java.security.Principal caller, java.security.acl.AclEntry entry)
      void setName​(java.security.Principal caller, java.lang.String name)
      int size()  
      java.lang.String toString()

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Field Detail

      • ANON_ACL

        public static final AttivioAcl ANON_ACL
        Represents the ACL that grants read access to the anonymous user (and therefore, effectively to everyone).

    • Constructor Detail

      • AttivioAcl

        public AttivioAcl()
        Creates a blank ACL object.

      • AttivioAcl

        public AttivioAcl​(java.lang.String aclName)
        Creates a blank ACL object with a name.
        Parameters:
        aclName - the ACL name

    • Method Detail

      • addEntry

        public boolean addEntry​(java.security.Principal caller,
                        java.security.acl.AclEntry entry)
                 throws java.security.acl.NotOwnerException
        Specified by:
        addEntry in interface java.security.acl.Acl
        Throws:
        java.security.acl.NotOwnerException

      • addEntry

        public boolean addEntry​(java.security.acl.AclEntry entry)
        Adds an ACL entry to the ACL.
        Parameters:
        entry - the entry to add
        Returns:
        true if the entry was successfully added, false if it was already in the ACL

      • addEntries

        public void addEntries​(java.util.List<AttivioAclEntry> newEntries)
        Adds entries to the ACL. Any duplicates are ignored.
        Parameters:
        newEntries - the entries to add

      • checkPermission

        public boolean checkPermission​(java.security.Principal principal,
                               java.security.acl.Permission permission)
        Specified by:
        checkPermission in interface java.security.acl.Acl

      • entries

        public java.util.Enumeration<java.security.acl.AclEntry> entries()
        Specified by:
        entries in interface java.security.acl.Acl

      • size

        public int size()
        Returns:
        the number of ACL entries in the ACL

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface java.security.acl.Acl

      • getPermissions

        public java.util.Enumeration<java.security.acl.Permission> getPermissions​(java.security.Principal prin)
        Specified by:
        getPermissions in interface java.security.acl.Acl

      • removeEntry

        public boolean removeEntry​(java.security.Principal caller,
                           java.security.acl.AclEntry entry)
                    throws java.security.acl.NotOwnerException
        Specified by:
        removeEntry in interface java.security.acl.Acl
        Throws:
        java.security.acl.NotOwnerException

      • setName

        public void setName​(java.security.Principal caller,
                    java.lang.String name)
             throws java.security.acl.NotOwnerException
        Specified by:
        setName in interface java.security.acl.Acl
        Throws:
        java.security.acl.NotOwnerException

      • addOwner

        public boolean addOwner​(java.security.Principal caller,
                        java.security.Principal owner)
                 throws java.security.acl.NotOwnerException
        Specified by:
        addOwner in interface java.security.acl.Owner
        Throws:
        java.security.acl.NotOwnerException

      • deleteOwner

        public boolean deleteOwner​(java.security.Principal caller,
                           java.security.Principal owner)
                    throws java.security.acl.NotOwnerException,
                           java.security.acl.LastOwnerException
        Specified by:
        deleteOwner in interface java.security.acl.Owner
        Throws:
        java.security.acl.NotOwnerException
        java.security.acl.LastOwnerException

      • isOwner

        public boolean isOwner​(java.security.Principal owner)
        Specified by:
        isOwner in interface java.security.acl.Owner

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface java.security.acl.Acl
        Overrides:
        toString in class java.lang.Object

      • addEntries

        public void addEntries​(java.lang.Iterable<AttivioAclEntry> entries2)