com.attivio.sdk.security

Class AttivioAclEntry

java.lang.Object

com.attivio.sdk.security.AttivioAclEntry

All Implemented Interfaces:

Serializable, Cloneable, AclEntry, Enumeration<Permission>

public class AttivioAclEntry
extends Object
implements AclEntry, Enumeration<Permission>, Serializable

Represents an access control list entry. Basically, a mapping of a principal (a user or a group) to the list of their permissions.

Note that an ACL entry may be positive (access granted) or negative (access denied).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AttivioAclEntry	ANON_READ The ACL entry defining read access granted to the anonymous user.

Constructor Summary

Constructors

Constructor and Description
AttivioAclEntry() Constructs a blank ACL entry.
AttivioAclEntry(AttivioPrincipal prin, List<AttivioPermission> perms, boolean isNeg) Constructs an ACL entry, given a principal and their permissions.

Method Summary

Modifier and Type	Method and Description
boolean	addPermission(Permission perm)
boolean	checkPermission(Permission perm)
Object	clone()
boolean	equals(Object obj)
AttivioPrincipal	getAttivioPrincipal()
List<AttivioPermission>	getPermissions()
Principal	getPrincipal()
int	hashCode()
boolean	hasMoreElements()
boolean	isNegative()
Permission	nextElement()
Enumeration<Permission>	permissions()
boolean	removePermission(Permission perm)
void	setNegativePermissions()
boolean	setPrincipal(Principal prin)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANON_READ

public static final AttivioAclEntry ANON_READ

The ACL entry defining read access granted to the anonymous user.

Constructor Detail

AttivioAclEntry

public AttivioAclEntry()

Constructs a blank ACL entry.

AttivioAclEntry

public AttivioAclEntry(AttivioPrincipal prin,
                       List<AttivioPermission> perms,
                       boolean isNeg)

Constructs an ACL entry, given a principal and their permissions.

Parameters:

prin - the principal (must not be null)

perms - the set of permissions (must not be null or empty)

isNeg - if true, the permissions are denied, otherwise granted

Method Detail

addPermission

public boolean addPermission(Permission perm)

Specified by:

addPermission in interface AclEntry

checkPermission

public boolean checkPermission(Permission perm)

Specified by:

checkPermission in interface AclEntry

getPrincipal

public Principal getPrincipal()

Specified by:

getPrincipal in interface AclEntry

getAttivioPrincipal

public AttivioPrincipal getAttivioPrincipal()

Returns:

the Attivio principal object set into this ACL entry

isNegative

public boolean isNegative()

Specified by:

isNegative in interface AclEntry

permissions

public Enumeration<Permission> permissions()

Specified by:

permissions in interface AclEntry

getPermissions

public List<AttivioPermission> getPermissions()

Returns:

the list of permissions

removePermission

public boolean removePermission(Permission perm)

Specified by:

removePermission in interface AclEntry

setNegativePermissions

public void setNegativePermissions()

Specified by:

setNegativePermissions in interface AclEntry

setPrincipal

public boolean setPrincipal(Principal prin)

Specified by:

setPrincipal in interface AclEntry

clone

public Object clone()

Specified by:

clone in interface AclEntry

Overrides:

clone in class Object

hasMoreElements

public boolean hasMoreElements()

Specified by:

hasMoreElements in interface Enumeration<Permission>

nextElement

public Permission nextElement()

Specified by:

nextElement in interface Enumeration<Permission>

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 AclEntry

Overrides:

toString in class Object