blackboard.cms.filesystem
Class CSEntry

java.lang.Object
  blackboard.cms.filesystem.CSEntry

Direct Known Subclasses:

CSDirectory, CSFile

public class CSEntry

extends java.lang.Object

An object for a node in the file system. Subclasses include CSFile, CSDirectory, CSFileSystemException, and CSCustomDirectory.

bb-manifest note: In order to use these methods, please be sure to include the following permissions within the bb-manifest under the permissions section:
<permission type="java.lang.RuntimePermission" name="db.connection.*" />
<permission type="attribute" name="user.authinfo" actions="get,set" />
<permission type="attribute" name="user.personalinfo" actions="get,set" />
<permission type="persist" name="user" actions="create,modify,delete" />
<permission type="persist" name="userrole" actions="create,modify,delete" />
<permission type="persist" name="course" actions="create,modify,delete" />

Since:

Bb CS 1.2

Version:

$Revision: $

Method Summary

void	delete() Deletes the CSEntry
void	deleteAccessControlEntry(java.lang.String principalID) Delete the explicit permissions entry for a user or user list.
CSAccessControlEntry[]	getAccessControlEntries() Get an array of all explicit permissions entries for the CSEntry .
CSAccessControlEntry	getAccessControlEntry(java.lang.String principalID) Gets the explicit permissions entry for a user or user list.
java.lang.String	getBaseName() Returns the base name to the CSEntry.
CSEntryMetadata	getCSEntryMetadata() Get a CSEntryMetadata object from the CSEntry.
java.lang.String	getFullPath() Returns the full path to the CSEntry.
java.lang.String	getParentPath() Returns the parent path to the CSEntry.
long	getSize() Returns the size (in bytes) of the CSEntry.

Methods inherited from class java.lang.Object

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

Method Detail

getFullPath

public java.lang.String getFullPath()

Returns the full path to the CSEntry.

For example: "/users/jsmith/test.txt" => "/users/jsmith/test.txt"

Returns:

a String representing the full path to the CSEntry

getParentPath

public java.lang.String getParentPath()

Returns the parent path to the CSEntry.

For example: "/users/jsmith/test.txt" => "/users/jsmith"

Returns:

a String representing the parent path to the CSEntry

getBaseName

public java.lang.String getBaseName()

Returns the base name to the CSEntry.

For example: "/users/jsmith/test.txt" => "test.txt"

Returns:

a String representing the base name of the CSEntry

getSize

public long getSize()

Returns the size (in bytes) of the CSEntry.

Returns:

a long representing the size (in bytes) of the CSEntry

delete

public void delete()
            throws CSFileSystemException

Deletes the CSEntry

Throws:

CSFileSystemException

getAccessControlEntry

public CSAccessControlEntry getAccessControlEntry(java.lang.String principalID)
                                           throws CSFileSystemException

Gets the explicit permissions entry for a user or user list.

Parameters:

principalID - a String representing the principalID of the user or user list

Returns:

a CSAccessControlEntry for the CSEntry

Throws:

CSFileSystemException

deleteAccessControlEntry

public void deleteAccessControlEntry(java.lang.String principalID)
                              throws CSFileSystemException

Delete the explicit permissions entry for a user or user list.

Parameters:

principalID - a String representing the principalID of the user or user list

Throws:

CSFileSystemException

getAccessControlEntries

public CSAccessControlEntry[] getAccessControlEntries()
                                               throws CSFileSystemException

Get an array of all explicit permissions entries for the CSEntry .

Throws:

CSFileSystemException

getCSEntryMetadata

public CSEntryMetadata getCSEntryMetadata()

Get a CSEntryMetadata object from the CSEntry.