org.osid.filing

Interface FilingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FilingProfile, OsidProfile, OsidProxyManager, Sourceable

public interface FilingProxyManager
extends OsidProxyManager, FilingProfile

The filing manager provides access sessions to retrieve and manage files and directories. A manager may support federation in that files and directories can be accessed by a specified path. Methods in this manager support the passing of a Proxy to pass information from server environments. The sessions included in this manager are:

• FileSystemSession: a session for traversing file systems
• FileSystemManagementSession: a session for performing operations across directories
• FileContentSession: a basic session for reading and writing a file
• FileLookupSession: a session for looking up files
• FileQuerySession: a session for searching for files
• FileSearchSession: a session for searching for files
• FileNotificationSession: a session for subscribing to changes in files
• FileSmartDirectorySession: a session for managing smart directories of files
• DirectoryLookupSession: a session for looking up a directories
• DirectorQuerySession: a session for searching for directories
• DirectorySearchSession: a session for searching for directories
• DirectoryNotificationSession: a session for subscribing to changes in directories

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryAdminSession	getDirectoryAdminSession(Proxy proxy) Gets the session for creating and removing files.
DirectoryAdminSession	getDirectoryAdminSessionForDirectory(Id directoryId, Proxy proxy) Gets the session for searching for creating and removing files in the given directory.
DirectoryLookupSession	getDirectoryLookupSession(Proxy proxy) Gets the session for examining directories.
DirectoryLookupSession	getDirectoryLookupSessionForDirectory(Id directoryId, Proxy proxy) Gets the session for examining a given directory.
DirectoryNotificationSession	getDirectoryNotificationSession(DirectoryReceiver directoryReceiver, Proxy proxy) Gets the session for receiving messages about changes to directories.
DirectoryNotificationSession	getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver, Id directoryId, Proxy proxy) Gets the session for receiving messages about changes to directories in the given directory.
DirectoryQuerySession	getDirectoryQuerySession(Proxy proxy) Gets the session for querying directories.
DirectoryQuerySession	getDirectoryQuerySessionForDirectory(Id directoryId, Proxy proxy) Gets the session for querying directories within a given directory.
DirectorySearchSession	getDirectorySearchSession(Proxy proxy) Gets the session for searching for directories.
DirectorySearchSession	getDirectorySearchSessionForDirectory(Id directoryId, Proxy proxy) Gets the session for searching for directories within a given directory.
FileContentSession	getFileContentSession(Proxy proxy) Gets the session for reading and writing files.
FileContentSession	getFileContentSessionForDirectory(Id directoryId, Proxy proxy) Gets the session for reading and writing files for the given path.
FileContentSession	getFileContentSessionForPath(java.lang.String path, Proxy proxy) Gets the session for reading and writing files for the given path.
FileLookupSession	getFileLookupSession(Proxy proxy) Gets the session for looking up files.
FileLookupSession	getFileLookupSessionForDirectory(Id directoryId, Proxy proxy) Gets a file lookup session for the specified directory.
FileNotificationSession	getFileNotificationSession(FileReceiver fileReceiver, Proxy proxy) Gets the session for receiving messages about changes to files.
FileNotificationSession	getFileNotificationSessionForDirectory(FileReceiver fileReceiver, Id directoryId, Proxy proxy) Gets a file notification session for the specified directory.
FileQuerySession	getFileQuerySession(Proxy proxy) Gets the session for querying files.
FileQuerySession	getFileQuerySessionForDirectory(Id directoryId, Proxy proxy) Gets a file query session for the specified directory.
FileSearchSession	getFileSearchSession(Proxy proxy) Gets the session for searching for files.
FileSearchSession	getFileSearchSessionForDirectory(Id directoryId, Proxy proxy) Gets a file search session for the specified directory.
FileSmartDirectorySession	getFileSmartDirectorySession(Id directoryId, Proxy proxy) Gets the session for managing dynamic diectories.
FileSystemManagementSession	getFileSystemManagementSession(Proxy proxy) Gets the session for manipulating file systems.
FileSystemManagementSession	getFileSystemManagementSessionForDirectory(Id directoryId, Proxy proxy) Gets the session for manipulating files for the given path.
FileSystemManagementSession	getFileSystemManagementSessionForPath(java.lang.String path, Proxy proxy) Gets the session for manipulating files for the given path.
FileSystemSession	getFileSystemSession(Proxy proxy) Gets the session for examining file systems.
FileSystemSession	getFileSystemSessionForDirectory(Id directoryId, Proxy proxy) Gets the session for exmaning file systems for the given directory.
FileSystemSession	getFileSystemSessionForPath(java.lang.String path, Proxy proxy) Gets the session for exmaning file systems for the given path.
FilingAllocationProxyManager	getFilingAllocationProxyManager() Gets the FilingAllocationProxyManager.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.filing.FilingProfile

getDirectoryRecordTypes, getDirectorySearchRecordTypes, getFileRecordTypes, getFileSearchRecordTypes, supportsDirectoryAdmin, supportsDirectoryLookup, supportsDirectoryNotification, supportsDirectoryQuery, supportsDirectoryRecordType, supportsDirectorySearch, supportsDirectorySearchRecordType, supportsFileContent, supportsFileLookup, supportsFileNotification, supportsFileQuery, supportsFileRecordType, supportsFileSearch, supportsFileSearchRecordType, supportsFileSmartDirectory, supportsFileSystem, supportsFileSystemManagement, supportsFilingAllocation, supportsFilingManagement, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getFileSystemSession

FileSystemSession getFileSystemSession(Proxy proxy)
                                       throws OperationFailedException

Gets the session for examining file systems.

Parameters:

proxy - a proxy

Returns:

a FileSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystem() is false

Compliance:

optional - This method must be implemented if supportsFileSystem() is true.

getFileSystemSessionForPath

FileSystemSession getFileSystemSessionForPath(java.lang.String path,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets the session for exmaning file systems for the given path.

Parameters:

path - the path to a directory

proxy - a proxy

Returns:

a FileSystemSession

Throws:

NotFoundException - path is not found or is not a directory

NullArgumentException - path or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystem() is false

Compliance:

optional - This method must be implemented if supportsFileSystem() and supportsVisibleFederation() are true.

getFileSystemSessionForDirectory

FileSystemSession getFileSystemSessionForDirectory(Id directoryId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session for exmaning file systems for the given directory.

Parameters:

directoryId - the Id of a directory

proxy - a proxy

Returns:

a FileSystemSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystem() is false

Compliance:

optional - This method must be implemented if supportsFileSystem() and supportsVisibleFederation() are true.

getFileSystemManagementSession

FileSystemManagementSession getFileSystemManagementSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session for manipulating file systems.

Parameters:

proxy - a proxy

Returns:

a FileSystemManagementSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystemManagement() is false

Compliance:

optional - This method must be implemented if supportsFileSystemManagement() is true.

getFileSystemManagementSessionForPath

FileSystemManagementSession getFileSystemManagementSessionForPath(java.lang.String path,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the session for manipulating files for the given path.

Parameters:

path - the path to a directory

proxy - a proxy

Returns:

a FileSystemManagementSession

Throws:

NotFoundException - path is not found or is not a directory

NullArgumentException - path or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystemManagement() is false

Compliance:

optional - This method must be implemented if supportsFileSystemManagement() and supportsVisibleFederation() are true.

getFileSystemManagementSessionForDirectory

FileSystemManagementSession getFileSystemManagementSessionForDirectory(Id directoryId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the session for manipulating files for the given path.

Parameters:

directoryId - the Id of a directory

proxy - a proxy

Returns:

a FileSystemManagementSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystemManagement() is false

Compliance:

optional - This method must be implemented if supportsFileSystemManagement() and supportsVisibleFederation() are true.

getFileContentSession

FileContentSession getFileContentSession(Proxy proxy)
                                         throws OperationFailedException

Gets the session for reading and writing files.

Parameters:

proxy - a proxy

Returns:

a FileContentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileContent() is false

Compliance:

optional - This method must be implemented if supportsFileContent() is true.

getFileContentSessionForPath

FileContentSession getFileContentSessionForPath(java.lang.String path,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the session for reading and writing files for the given path.

Parameters:

path - the path to a directory

proxy - a proxy

Returns:

a FileContentSession

Throws:

NotFoundException - path is not found or is not a directory

NullArgumentException - path or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileContent() is false

Compliance:

optional - This method must be implemented if supportsFileContent() and supportsVisibleFederation() are true.

getFileContentSessionForDirectory

FileContentSession getFileContentSessionForDirectory(Id directoryId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the session for reading and writing files for the given path.

Parameters:

directoryId - the Id of a directory

proxy - a proxy

Returns:

a FileContentSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileContent() is false

Compliance:

optional - This method must be implemented if supportsFileContent() and supportsVisibleFederation() are true.

getFileLookupSession

FileLookupSession getFileLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the session for looking up files.

Parameters:

proxy - a proxy

Returns:

the FileLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileLookup() is false

Compliance:

optional - This method must be implemented if supportsFileLookup() is true.

getFileLookupSessionForDirectory

FileLookupSession getFileLookupSessionForDirectory(Id directoryId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a file lookup session for the specified directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a FileLookupSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileLookup() is false

Compliance:

optional - This method must be implemented if supportsFileLookup() and supportsVisibleFederation() are true.

getFileQuerySession

FileQuerySession getFileQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the session for querying files.

Parameters:

proxy - a proxy

Returns:

the FileQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileQuery() is false

Compliance:

optional - This method must be implemented if supportsFileQuery() is true.

getFileQuerySessionForDirectory

FileQuerySession getFileQuerySessionForDirectory(Id directoryId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets a file query session for the specified directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a FileQuerySession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileQuery() is false

Compliance:

optional - This method must be implemented if supportsFileQuery() and supportsVisibleFederation() are true.

getFileSearchSession

FileSearchSession getFileSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the session for searching for files.

Parameters:

proxy - a proxy

Returns:

the FileSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSearch() is false

Compliance:

optional - This method must be implemented if supportsFileSearch() is true.

getFileSearchSessionForDirectory

FileSearchSession getFileSearchSessionForDirectory(Id directoryId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a file search session for the specified directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a FileSearchSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSearch() is false

Compliance:

optional - This method must be implemented if supportsFileSearch() and supportsVisibleFederation() are true.

getFileNotificationSession

FileNotificationSession getFileNotificationSession(FileReceiver fileReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the session for receiving messages about changes to files.

Parameters:

fileReceiver - the notification callback

proxy - a proxy

Returns:

a FileNotificationSession

Throws:

NullArgumentException - fileReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileNotification() is false

Compliance:

optional - This method must be implemented if supportsFileNotification() is true.

getFileNotificationSessionForDirectory

FileNotificationSession getFileNotificationSessionForDirectory(FileReceiver fileReceiver,
                                                             Id directoryId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets a file notification session for the specified directory.

Parameters:

fileReceiver - the notification callback

directoryId - the Id to the directory

proxy - a proxy

Returns:

a FileNotificationSession

Throws:

NotFoundException - directoryPath is not found

NullArgumentException - fileReceiver, directoryId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileNotification() is false

Compliance:

optional - This method must be implemented if supportsFileNotification() and supportsVisibleFederation() are true.

getFileSmartDirectorySession

FileSmartDirectorySession getFileSmartDirectorySession(Id directoryId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic diectories.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a FileSmartDirectorySession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSmartDirectory() is false

Compliance:

optional - This method must be implemented if supportsFileSmartDirectory() and supportsVisibleFederation() are true.

getDirectoryLookupSession

DirectoryLookupSession getDirectoryLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the session for examining directories.

Parameters:

proxy - a proxy

Returns:

a DirectoryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryLookup() is false

Compliance:

optional - This method must be implemented if supportsDirectoryLookup() is true.

getDirectoryLookupSessionForDirectory

DirectoryLookupSession getDirectoryLookupSessionForDirectory(Id directoryId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the session for examining a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a DirectoryLookupSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryLookup() is false

Compliance:

optional - This method must be implemented if supportsDirectoryLookup() and supportsVisibleFederation() are true.

getDirectoryQuerySession

DirectoryQuerySession getDirectoryQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the session for querying directories.

Parameters:

proxy - a proxy

Returns:

a DirectoryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryQuery() is false

Compliance:

optional - This method must be implemented if supportsDirectoryQuery() is true.

getDirectoryQuerySessionForDirectory

DirectoryQuerySession getDirectoryQuerySessionForDirectory(Id directoryId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the session for querying directories within a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a DirectoryQuerySession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryQuery() is false

Compliance:

optional - This method must be implemented if supportsDirectoryQuery() and supportsVisibleFederation() are true.

getDirectorySearchSession

DirectorySearchSession getDirectorySearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the session for searching for directories.

Parameters:

proxy - a proxy

Returns:

a DirectorySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectorySearch() is false

Compliance:

optional - This method must be implemented if supportsDirectorySearch() is true.

getDirectorySearchSessionForDirectory

DirectorySearchSession getDirectorySearchSessionForDirectory(Id directoryId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the session for searching for directories within a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a DirectorySearchSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectorySearch() is false

Compliance:

optional - This method must be implemented if supportsDirectorySearch() and supportsVisibleFederation() are true.

getDirectoryAdminSession

DirectoryAdminSession getDirectoryAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the session for creating and removing files.

Parameters:

proxy - a proxy

Returns:

a DirectoryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryAdmin() is false

Compliance:

optional - This method must be implemented if supportsDirectoryAdmin() is true.

getDirectoryAdminSessionForDirectory

DirectoryAdminSession getDirectoryAdminSessionForDirectory(Id directoryId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the session for searching for creating and removing files in the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryId - the Id to the directory

proxy - a proxy

Returns:

a DirectoryAdminSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryAdmin() is false

Compliance:

optional - This method must be implemented if supportsDirectoryAdmin() and supportsVisibleFederation() are true.

getDirectoryNotificationSession

DirectoryNotificationSession getDirectoryNotificationSession(DirectoryReceiver directoryReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the session for receiving messages about changes to directories.

Parameters:

directoryReceiver - the notification callback

proxy - a proxy

Returns:

a DirectoryNotificationSession

Throws:

NullArgumentException - directoryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryNotification() is false

Compliance:

optional - This method must be implemented if supportsDirectoryNotification() is true.

getDirectoryNotificationSessionForDirectory

DirectoryNotificationSession getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver,
                                                                       Id directoryId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the session for receiving messages about changes to directories in the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryReceiver - the notification callback

directoryId - the Id to the directory

proxy - a proxy

Returns:

a DirectoryNotificationSession

Throws:

NotFoundException - directoryPath is not found

NullArgumentException - directoryReceiver, directoryId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryNotification() is false

Compliance:

optional - This method must be implemented if supportsDirectoryNotification() and supportsVisibleFederation() are true.

getFilingAllocationProxyManager

FilingAllocationProxyManager getFilingAllocationProxyManager()
                                                             throws OperationFailedException

Gets the FilingAllocationProxyManager.

Returns:

a FilingAllocationProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFilingAllocation() is false

Compliance:

optional - This method must be implemented if supportsFilingAllocation() is true.