com.attivio.sdk.security

Class AttivioAcl

java.lang.Object

com.attivio.sdk.security.AttivioAcl

All Implemented Interfaces:

Serializable, Iterable<AttivioAclEntry>, Acl, Owner

public class AttivioAcl
extends Object
implements Acl, Iterable<AttivioAclEntry>, Serializable

Represents an access control list (ACL). Basically, a collection of ACL entries.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and 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 and Description
AttivioAcl() Creates a blank ACL object.
AttivioAcl(String aclName) Creates a blank ACL object with a name.

Method Summary

Modifier and Type	Method and Description
void	addEntries(Iterable<AttivioAclEntry> entries2)
void	addEntries(List<AttivioAclEntry> newEntries) Adds entries to the ACL.
boolean	addEntry(AclEntry entry) Adds an ACL entry to the ACL.
boolean	addEntry(Principal caller, AclEntry entry)
boolean	addOwner(Principal caller, Principal owner)
boolean	checkPermission(Principal principal, Permission permission)
boolean	deleteOwner(Principal caller, Principal owner)
Enumeration<AclEntry>	entries()
boolean	equals(Object obj)
String	getName()
Enumeration<Permission>	getPermissions(Principal prin)
int	hashCode()
boolean	isOwner(Principal owner)
Iterator<AttivioAclEntry>	iterator()
boolean	removeEntry(Principal caller, AclEntry entry)
void	setName(Principal caller, String name)
int	size()
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(String aclName)

Creates a blank ACL object with a name.

Parameters:

aclName - the ACL name

Method Detail

addEntry

public boolean addEntry(Principal caller,
                        AclEntry entry)
                 throws NotOwnerException

Specified by:

addEntry in interface Acl

Throws:

NotOwnerException

addEntry

public boolean addEntry(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(List<AttivioAclEntry> newEntries)

Adds entries to the ACL. Any duplicates are ignored.

Parameters:

newEntries - the entries to add

checkPermission

public boolean checkPermission(Principal principal,
                               Permission permission)

Specified by:

checkPermission in interface Acl

entries

public Enumeration<AclEntry> entries()

Specified by:

entries in interface Acl

size

public int size()

Returns:

the number of ACL entries in the ACL

getName

public String getName()

Specified by:

getName in interface Acl

getPermissions

public Enumeration<Permission> getPermissions(Principal prin)

Specified by:

getPermissions in interface Acl

removeEntry

public boolean removeEntry(Principal caller,
                           AclEntry entry)
                    throws NotOwnerException

Specified by:

removeEntry in interface Acl

Throws:

NotOwnerException

setName

public void setName(Principal caller,
                    String name)
             throws NotOwnerException

Specified by:

setName in interface Acl

Throws:

NotOwnerException

addOwner

public boolean addOwner(Principal caller,
                        Principal owner)
                 throws NotOwnerException

Specified by:

addOwner in interface Owner

Throws:

NotOwnerException

deleteOwner

public boolean deleteOwner(Principal caller,
                           Principal owner)
                    throws NotOwnerException,
                           LastOwnerException

Specified by:

deleteOwner in interface Owner

Throws:

NotOwnerException

LastOwnerException

isOwner

public boolean isOwner(Principal owner)

Specified by:

isOwner in interface Owner

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface Acl

Overrides:

toString in class Object

iterator

public Iterator<AttivioAclEntry> iterator()

Specified by:

iterator in interface Iterable<AttivioAclEntry>

addEntries

public void addEntries(Iterable<AttivioAclEntry> entries2)