org.osid.filing

Interface FileSystemManagementSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface FileSystemManagementSession
extends OsidSession

This session defines methods for operating on files and directories. This session is an expanded version of the DirectoryAdminSession that defines methods requiring path names for navigating a federation of directories as opposed to working within a single directory node.

The directory associated with this session is the current working directory and any relative path names provided are with respect to this directory. Absolute pathnames may be supplied outside this directory.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canManageFiling() Tests if this user can perform functions in this session.
Directory	copyDirectory(Id src, java.lang.String dst) Copies a directory and all of its contents to another path.
File	copyFile(Id src, java.lang.String dst) Copies a file to another path.
void	createMissingPaths(boolean create) Create any missing directories for a destination path that does not exist.
Directory	getDirectory() Gets the directory associated with this session.
Id	getDirectoryId() Gets the Id of this directory.
Directory	linkDirectory(Id directoryId, java.lang.String link) Creates a link from one directory to another.
File	linkFile(Id fileId, java.lang.String link) Creates a link from one file to another.
void	moveDirectory(Id src, java.lang.String dst) Moves a directory to another path.
void	moveFile(Id src, java.lang.String dst) Moves a file to another path.
void	overwrite(boolean overwite) Overwrite files if a destination pathname exists.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDirectoryId

Id getDirectoryId()

Gets the Id of this directory.

Returns:

the Id of this directory

Compliance:

mandatory - This method must be implemented.

getDirectory

Directory getDirectory()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the directory associated with this session.

Returns:

the directory associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageFiling

boolean canManageFiling()

Tests if this user can perform functions in this session. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if filing management methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

overwrite

void overwrite(boolean overwite)

Overwrite files if a destination pathname exists.

Parameters:

overwite - true if files can be overwritten, false otherwise

Compliance:

mandatory - This method is must be implemented.

createMissingPaths

void createMissingPaths(boolean create)

Create any missing directories for a destination path that does not exist.

Parameters:

create - true if intermediate directories should be created, false otherwise

Compliance:

mandatory - This method is must be implemented.

moveFile

void moveFile(Id src,
            java.lang.String dst)
              throws AlreadyExistsException,
                     NotFoundException,
                     OperationFailedException,
                     PermissionDeniedException

Moves a file to another path. The detination path may be a file or directory. If the destination is a file and exists, the destination is only replaced if overwrite() is true. If the destination is a directory and does not exist, the missing directories are only created if createMissingPaths() is true.

Parameters:

src - the source Id of the file

dst - the destination name or path of the directory or file

Throws:

AlreadyExistsException - dst exists and overwrite() is false

InvalidArgumentException - src is not a file

NotFoundException - src is not found, or the path to dst is not found and createMissingPaths() is false

NullArgumentException - src or dst is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveDirectory

void moveDirectory(Id src,
                 java.lang.String dst)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Moves a directory to another path. The destination must be a directory and if exists, the source directory is placed as a child to the given directory. If a path component in the destination does not exist, the path is created is createMissingPaths() is true.

Parameters:

src - the source Id of the directory

dst - the destination name or path of the directory

Throws:

InvalidArgumentException - src is not a directory

NotFoundException - src is not found, or the path to dst is not found and createMissingPaths() is false

NullArgumentException - src or dst is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

copyFile

File copyFile(Id src,
            java.lang.String dst)
              throws AlreadyExistsException,
                     NotFoundException,
                     OperationFailedException,
                     PermissionDeniedException

Copies a file to another path. The detination path may be a file or directory. If the destination is a file and exists, the destination is only replaced if overwrite() is true. If the destination is a directory and does not exist, the missing directories are only created if createMissingPaths() is true.

Parameters:

src - the source Id of the file

dst - the destination name or path of the directory or file

Returns:

the new file

Throws:

AlreadyExistsException - dst exists and overwrite() is false

InvalidArgumentException - src is not a file

NotFoundException - src is not found, or the path to dst is not found and createMissingPaths() is false

NullArgumentException - src or dst is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

copyDirectory

Directory copyDirectory(Id src,
                      java.lang.String dst)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Copies a directory and all of its contents to another path. The destination must be a directory and if exists, the source directory is placed as a child to the given directory. If a path component in the destination does not exist, the path is created is createMissingPaths() is true.

Parameters:

src - the source Id of the directory

dst - the destination name or path of the directory

Returns:

the new file

Throws:

InvalidArgumentException - src is not a directory

NotFoundException - src is not found, or the path to dst is not found and createMissingPaths() is false

NullArgumentException - src or dst is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

linkFile

File linkFile(Id fileId,
            java.lang.String link)
              throws AlreadyExistsException,
                     NotFoundException,
                     OperationFailedException,
                     PermissionDeniedException

Creates a link from one file to another.

Parameters:

fileId - the Id of a file

link - the link path

Returns:

the link

Throws:

AlreadyExistsException - link already exists

NotFoundException - fileId is not found, or the path to link is not found and createMissingPaths() is false

NullArgumentException - fileId or link is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

linkDirectory

Directory linkDirectory(Id directoryId,
                      java.lang.String link)
                        throws AlreadyExistsException,
                               NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Creates a link from one directory to another.

Parameters:

directoryId - the Id of a directory

link - the destination path

Returns:

the link

Throws:

AlreadyExistsException - link already exists

NotFoundException - directoryId is not found, or the path to link is not found and createMissingPaths() is false

NullArgumentException - directoryId or link is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.