blackboard.cms.filesystem
Class CSAccessControlEntry

java.lang.Object
  blackboard.cms.filesystem.CSAccessControlEntry

public class CSAccessControlEntry

extends java.lang.Object

The CSAccessControlEntry class provides a representation of an Access Control Entry within the Blackboard application. An object exposing the individual permissions of on a file/directory for a specific user or list of users. Methods exist to both read and set the permissions.

Since:

Bb CS 1.2

Version:

$Revision: $

Method Summary

boolean	canDelete() Is this file/directory deleteable by the user/users identified by the associated PrincipalID
boolean	canManage() Is this file/directory manageable by the user/users identified by the associated PrincipalID
boolean	canRead() Is this file/directory readable by the user/users identified by the associated PrincipalID
boolean	canWrite() Is this file/directory writeable by the user/users identified by the associated PrincipalID
java.lang.String	getPrincipalID() Get the PrincipalID for this set of permissions.
void	updatePermissions(boolean read, boolean write, boolean delete, boolean manage) Sets the permissions (read/write/delete/manage) for the user/users identified by the associated PrincipalID

Methods inherited from class java.lang.Object

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

Method Detail

getPrincipalID

public java.lang.String getPrincipalID()
                                throws CSFileSystemException

Get the PrincipalID for this set of permissions.

Returns:

a String denoting the principal Id of the CSAccessControlEntry.

Throws:

CSFileSystemException

canRead

public boolean canRead()

Is this file/directory readable by the user/users identified by the associated PrincipalID

Returns:

a boolean denoting Read permissions status.

canWrite

public boolean canWrite()

Is this file/directory writeable by the user/users identified by the associated PrincipalID

Returns:

a boolean denoting Write permission status.

canDelete

public boolean canDelete()

Is this file/directory deleteable by the user/users identified by the associated PrincipalID

Returns:

a boolean denoting Delete permission status.

canManage

public boolean canManage()

Is this file/directory manageable by the user/users identified by the associated PrincipalID

Returns:

a boolean denoting Manage permission status.

updatePermissions

public void updatePermissions(boolean read,
                              boolean write,
                              boolean delete,
                              boolean manage)
                       throws CSFileSystemException

Sets the permissions (read/write/delete/manage) for the user/users identified by the associated PrincipalID

Parameters:

read - true if the CSAccessControlEntry should have Read permissions, false otherwise.

write - true if the CSAccessControlEntry should have Write permissions, false otherwise.

delete - true if the CSAccessControlEntry should have Delete permissions, false otherwise.

manage - true if the CSAccessControlEntry should have Manage permissions, false otherwise.

Throws:

CSFileSystemException