Package it.uniroma2.art.semanticturkey.project

Class ProjectACL

java.lang.Object

it.uniroma2.art.semanticturkey.project.ProjectACL

public class ProjectACL
extends Object

This class describes the Access Control List for a given Project. It consists in:

• a list of ProjectConsumers, together with their access permissions.
• a "lockable" property, telling if the project associated to this ACL, can be locked for use by a ProjectConsumer, and with which modality

Author:

Manuel Fiorelli <fiorelli@info.uniroma2.it>, Armando Stellato <stellato@info.uniroma2.it>, Andrea Turbati <turbati@info.uniroma2.it>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProjectACL.AccessLevel
static enum	ProjectACL.LockLevel

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACL
static final String	LOCKLEVEL
static final String	WILDCARD_CONSUMER

Method Summary

Modifier and Type	Method	Description
ProjectACL.AccessLevel	getAccessLevelForConsumer(ProjectConsumer consumer)	This method returns the AccessLevel granted from the project that is owning this ACL to the given consumer.
ProjectACL.LockLevel	getLockLevel()	Returns the lock level of the project that is owning this ACL
ProjectACL.AccessLevel	getUniversalAccessLevel()	Returns the AccessLevel granted from the project that is owning this ACL to all the consumers ("*" consumer).
void	grantAccess(ProjectConsumer consumer, ProjectACL.AccessLevel reqAccessLevel)
void	grantUniversalAccess(ProjectACL.AccessLevel reqAccessLevel)	Grants universally (to all consumer) the given access level
boolean	hasInACL(ProjectConsumer consumer)	this method tells if consumer consumer is listed in the ACL of the current project.
boolean	isAccessibleFrom(ProjectConsumer consumer, ProjectACL.AccessLevel reqAccessLevel, ProjectACL.LockLevel reqLock)	this method tells if the project that is owning this ACL can be accessed with the desired access/lock level specifications.
boolean	isLockable()
boolean	isUniversallyAccessible()	Tells if the project that is owning this ACL can be universally accessed with any level
boolean	isUniversallyAccessible(ProjectACL.AccessLevel reqAccessLevel)	Tells if the project that is owning this ACL can be universally accessed with the given level
void	revokeAccess(ProjectConsumer consumer)
void	revokeUniversalAccess()	Revokes the universal access level
static String	serializeACL(String consumerName, ProjectACL.AccessLevel accessLevel)	serialization of the ACL for a specific consumer.
static String	serializeACL(Map<String,ProjectACL.AccessLevel> acl)	serialization of the whole ACL (of a project), containing all of its consumers and access levels
void	setLockableWithLevel(ProjectACL.LockLevel lockLevel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ACL

public static final String ACL

See Also:

• Constant Field Values

LOCKLEVEL

public static final String LOCKLEVEL

See Also:

• Constant Field Values

WILDCARD_CONSUMER

public static final String WILDCARD_CONSUMER

See Also:

• Constant Field Values

Method Details

isLockable

public boolean isLockable()

getAccessLevelForConsumer

public ProjectACL.AccessLevel getAccessLevelForConsumer(ProjectConsumer consumer)

This method returns the AccessLevel granted from the project that is owning this ACL to the given consumer. null if no AccessLevel is specified for the consumer.

Parameters:

consumer -

Returns:

getUniversalAccessLevel

public ProjectACL.AccessLevel getUniversalAccessLevel()

Returns the AccessLevel granted from the project that is owning this ACL to all the consumers ("*" consumer). null if no AccessLevel is specified.

Returns:

getLockLevel

public ProjectACL.LockLevel getLockLevel()

Returns the lock level of the project that is owning this ACL

Returns:

isAccessibleFrom

public boolean isAccessibleFrom(ProjectConsumer consumer,
 ProjectACL.AccessLevel reqAccessLevel,
 ProjectACL.LockLevel reqLock)

this method tells if the project that is owning this ACL can be accessed with the desired access/lock level specifications.
This is not considering the runtime status of the project, in case it has already been accessed by another ProjectConsumer

Parameters:

consumer -

reqAccessLevel -

reqLock -

Returns:

isUniversallyAccessible

public boolean isUniversallyAccessible()

Tells if the project that is owning this ACL can be universally accessed with any level

Returns:

isUniversallyAccessible

public boolean isUniversallyAccessible(ProjectACL.AccessLevel reqAccessLevel)

Tells if the project that is owning this ACL can be universally accessed with the given level

Returns:

hasInACL

public boolean hasInACL(ProjectConsumer consumer)

this method tells if consumer consumer is listed in the ACL of the current project. This does not tell anything about the ProjectACL.AccessLevel nor the ProjectACL.LockLevel which would be accepted for a request from consumer

Parameters:

consumer -

Returns:

grantAccess

public void grantAccess(ProjectConsumer consumer,
 ProjectACL.AccessLevel reqAccessLevel)
                 throws ProjectUpdateException,
ReservedPropertyUpdateException

Throws:

ProjectUpdateException

ReservedPropertyUpdateException

grantUniversalAccess

public void grantUniversalAccess(ProjectACL.AccessLevel reqAccessLevel)
                          throws ProjectUpdateException,
ReservedPropertyUpdateException

Grants universally (to all consumer) the given access level

Parameters:

reqAccessLevel -

Throws:

ProjectUpdateException

ReservedPropertyUpdateException

revokeAccess

public void revokeAccess(ProjectConsumer consumer)
                  throws ProjectUpdateException,
ReservedPropertyUpdateException

Throws:

ProjectUpdateException

ReservedPropertyUpdateException

revokeUniversalAccess

public void revokeUniversalAccess()
                           throws ProjectUpdateException,
ReservedPropertyUpdateException

Revokes the universal access level

Throws:

ProjectUpdateException

ReservedPropertyUpdateException

setLockableWithLevel

public void setLockableWithLevel(ProjectACL.LockLevel lockLevel)
                          throws ProjectUpdateException,
ReservedPropertyUpdateException

Throws:

ProjectUpdateException

ReservedPropertyUpdateException

serializeACL

public static String serializeACL(String consumerName,
 ProjectACL.AccessLevel accessLevel)

serialization of the ACL for a specific consumer.

Parameters:

consumerName -

accessLevel -

Returns:

serializeACL

public static String serializeACL(Map<String,ProjectACL.AccessLevel> acl)

serialization of the whole ACL (of a project), containing all of its consumers and access levels

Parameters:

acl -

Returns: