public interface FilingManager extends OsidManager, FilingProfile
The filing manager provides access sessions to retrieve and manage
files and directories. Some of the federated access methods support
pathnames in addition to directory Ids.
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 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 Modifier and Type | Method and Description |
---|---|
DirectoryAdminSession |
getDirectoryAdminSession()
Gets the session for creating and removing files.
|
DirectoryAdminSession |
getDirectoryAdminSessionForDirectory(Id directoryId)
Gets the session for searching for creating and removing files in the
given directory.
|
DirectoryLookupSession |
getDirectoryLookupSession()
Gets the session for examining directories.
|
DirectoryLookupSession |
getDirectoryLookupSessionForDirectory(Id directoryId)
Gets the session for examining a given directory.
|
DirectoryNotificationSession |
getDirectoryNotificationSession(DirectoryReceiver directoryReceiver)
Gets the session for receiving messages about changes to directories.
|
DirectoryNotificationSession |
getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver,
Id directoryId)
Gets the session for receiving messages about changes to directories
in the given directory.
|
DirectoryQuerySession |
getDirectoryQuerySession()
Gets the session for querying directories.
|
DirectoryQuerySession |
getDirectoryQuerySessionForDirectory(Id directoryId)
Gets the session for querying directories within a given directory.
|
DirectorySearchSession |
getDirectorySearchSession()
Gets the session for searching for directories.
|
DirectorySearchSession |
getDirectorySearchSessionForDirectory(Id directoryId)
Gets the session for searching for directories within a given
directory.
|
FileContentSession |
getFileContentSession()
Gets the session for reading and writing files.
|
FileContentSession |
getFileContentSessionForDirectory(Id directoryId)
Gets the session for reading and writing files for the given path.
|
FileContentSession |
getFileContentSessionForPath(java.lang.String path)
Gets the session for reading and writing files for the given path.
|
FileLookupSession |
getFileLookupSession()
Gets the session for looking up files.
|
FileLookupSession |
getFileLookupSessionForDirectory(Id directoryId)
Gets the session for manipulating files for the given path.
|
FileNotificationSession |
getFileNotificationSession(FileReceiver fileReceiver)
Gets the session for receiving messages about changes to files.
|
FileNotificationSession |
getFileNotificationSessionForDirectory(FileReceiver fileReceiver,
Id directoryId)
Gets a file notification session for the specified directory.
|
FileQuerySession |
getFileQuerySession()
Gets the session for querying files.
|
FileQuerySession |
getFileQuerySessionForDirectory(Id directoryId)
Gets a file query session for the specified directory.
|
FileSearchSession |
getFileSearchSession()
Gets the session for searching for files.
|
FileSearchSession |
getFileSearchSessionForDirectory(Id directoryId)
Gets a file search session for the specified directory.
|
FileSmartDirectorySession |
getFileSmartDirectorySession(Id directoryId)
Gets the session for managing dynamic directories.
|
FileSystemManagementSession |
getFileSystemManagementSession()
Gets the session for manipulating file systems.
|
FileSystemManagementSession |
getFileSystemManagementSessionForDirectory(Id directoryId)
Gets the session for manipulating files for the given path.
|
FileSystemManagementSession |
getFileSystemManagementSessionForPath(java.lang.String path)
Gets the session for manipulating files for the given path.
|
FileSystemSession |
getFileSystemSession()
Gets the session for examining file systems.
|
FileSystemSession |
getFileSystemSessionForDirectory(Id directoryId)
Gets the session for exmaning file systems for the given directory.
|
FileSystemSession |
getFileSystemSessionForPath(java.lang.String path)
Gets the session for exmaning file systems for the given path.
|
FilingAllocationManager |
getFilingAllocationManager()
Gets the
FilingAllocationManager. |
changeBranch, initialize, rollbackService
close
getDirectoryRecordTypes, getDirectorySearchRecordTypes, getFileRecordTypes, getFileSearchRecordTypes, supportsDirectoryAdmin, supportsDirectoryLookup, supportsDirectoryNotification, supportsDirectoryQuery, supportsDirectoryRecordType, supportsDirectorySearch, supportsDirectorySearchRecordType, supportsFileContent, supportsFileLookup, supportsFileNotification, supportsFileQuery, supportsFileRecordType, supportsFileSearch, supportsFileSearchRecordType, supportsFileSmartDirectory, supportsFileSystem, supportsFileSystemManagement, supportsFilingAllocation, supportsFilingManagement, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
FileSystemSession getFileSystemSession() throws OperationFailedException
FileSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSystem()
is false
optional
- This method must be implemented if
supportsFileSystem()
is true.
FileSystemSession getFileSystemSessionForPath(java.lang.String path) throws NotFoundException, OperationFailedException
path
- the path to a directory FileSystemSession
NotFoundException
- path
is not found or
is not a directoryNullArgumentException
- path
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSystem()
is false
optional
- This method must be implemented if
supportsFileSystem()
and
supportsVisibleFederation()
are true.
FileSystemSession getFileSystemSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of a directory FileSystemSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSystem()
is false
optional
- This method must be implemented if
supportsFileSystem()
and
supportsVisibleFederation()
are true.
FileSystemManagementSession getFileSystemManagementSession() throws OperationFailedException
FileSystemManagementSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSystemManagement()
is false
optional
- This method must be implemented if
supportsFileSystemManagement()
is true.
FileSystemManagementSession getFileSystemManagementSessionForPath(java.lang.String path) throws NotFoundException, OperationFailedException
path
- the path to a directory FileSystemManagementSession
NotFoundException
- path
is not found or
is not a directoryNullArgumentException
- path
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSystemManagement()
is false
optional
- This method must be implemented if
supportsFileSystemManagement()
and
supportsVisibleFederation()
are true.
FileSystemManagementSession getFileSystemManagementSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of a directory FileSystemManagementSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSystemManagement()
is false
optional
- This method must be implemented if
supportsFileSystemManagement()
and
supportsVisibleFederation()
are true.
FileContentSession getFileContentSession() throws OperationFailedException
FileContentSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileContent()
is false
optional
- This method must be implemented if
supportsFileContent()
is true.
FileContentSession getFileContentSessionForPath(java.lang.String path) throws NotFoundException, OperationFailedException
path
- the path to a directory FileContentSession
NotFoundException
- path
is not found or
is not a directoryNullArgumentException
- path
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileContent()
is false
optional
- This method must be implemented if
supportsFileContent()
and
supportsVisibleFederation()
are true.
FileContentSession getFileContentSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of a directory FileContentSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileContent()
is false
optional
- This method must be implemented if
supportsFileContent()
and
supportsVisibleFederation()
are true.
FileLookupSession getFileLookupSession() throws OperationFailedException
FileLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileLookup()
is false
optional
- This method must be implemented if
supportsFileLookup()
is true.
FileLookupSession getFileLookupSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory FileLookupSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileLookup()
is false
optional
- This method must be implemented if
supportsFileLookup()
and
supportsVisibleFederation()
are true.
FileQuerySession getFileQuerySession() throws OperationFailedException
FileQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileQuery()
is false
optional
- This method must be implemented if
supportsFileQuery()
is true.
FileQuerySession getFileQuerySessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory FileQuerySession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileQuery()
is false
optional
- This method must be implemented if
supportsFileQuery()
and
supportsVisibleFederation()
are true.
FileSearchSession getFileSearchSession() throws OperationFailedException
FileSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSearch()
is false
optional
- This method must be implemented if
supportsFileSearch()
is true.
FileSearchSession getFileSearchSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory FileSearchSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSearch()
is false
optional
- This method must be implemented if
supportsFileSearch()
and
supportsVisibleFederation()
are true.
FileNotificationSession getFileNotificationSession(FileReceiver fileReceiver) throws OperationFailedException
fileReceiver
- the notification callback a FileNotificationSession
NullArgumentException
- fileReceiver
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileNotification()
is false
optional
- This method must be implemented if
supportsFileNotification()
is true.
FileNotificationSession getFileNotificationSessionForDirectory(FileReceiver fileReceiver, Id directoryId) throws NotFoundException, OperationFailedException
fileReceiver
- the notification callbackdirectoryId
- the Id
of the directory FileNotificationSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- fileReceiver
or
directoryId
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileNotification()
is false
optional
- This method must be implemented if
supportsFileNotification()
and
supportsVisibleFederation()
are true.
FileSmartDirectorySession getFileSmartDirectorySession(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory FileSmartDirectorySession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSmartDirectory()
is false
optional
- This method must be implemented if
supportsFileSmartDirectory()
and
supportsVisibleFederation()
are true.
DirectoryLookupSession getDirectoryLookupSession() throws OperationFailedException
DirectoryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryLookup()
is false
optional
- This method must be implemented if
supportsDirectoryLookup()
is true.
DirectoryLookupSession getDirectoryLookupSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory DirectoryLookupSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryLookup()
is false
optional
- This method must be implemented if
supportsDirectoryLookup()
and
supportsVisibleFederation()
are true.
DirectoryQuerySession getDirectoryQuerySession() throws OperationFailedException
DirectoryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryQuery()
is false
optional
- This method must be implemented if
supportsDirectoryQuery()
is true.
DirectoryQuerySession getDirectoryQuerySessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory DirectoryQuerySession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryQuery()
is false
optional
- This method must be implemented if
supportsDirectoryQuery()
and
supportsVisibleFederation()
are true.
DirectorySearchSession getDirectorySearchSession() throws OperationFailedException
DirectorySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectorySearch()
is false
optional
- This method must be implemented if
supportsDirectorySearch()
is true.
DirectorySearchSession getDirectorySearchSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory DirectorySearchSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectorySearch()
is false
optional
- This method must be implemented if
supportsDirectorySearch()
and
supportsVisibleFederation()
are true.
DirectoryAdminSession getDirectoryAdminSession() throws OperationFailedException
DirectoryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryAdmin()
is false
optional
- This method must be implemented if
supportsDirectoryAdmin()
is true.
DirectoryAdminSession getDirectoryAdminSessionForDirectory(Id directoryId) throws NotFoundException, OperationFailedException
directoryId
- the Id
of the directory DirectoryAdminSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryAdmin()
is false
optional
- This method must be implemented if
supportsDirectoryAdmin()
and
supportsVisibleFederation()
are true.
DirectoryNotificationSession getDirectoryNotificationSession(DirectoryReceiver directoryReceiver) throws OperationFailedException
directoryReceiver
- the notification callback DirectoryNotificationSession
NullArgumentException
- directoryReceiver
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryNotification()
is false
optional
- This method must be implemented if
supportsDirectoryNotification()
is true.
DirectoryNotificationSession getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver, Id directoryId) throws NotFoundException, OperationFailedException
directoryReceiver
- the notification callbackdirectoryId
- the Id
of the directory DirectoryNotificationSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryReceiver
or directoryId
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryNotification()
is false
optional
- This method must be implemented if
supportsDirectoryNotification()
and
supportsVisibleFederation()
are true.
FilingAllocationManager getFilingAllocationManager() throws OperationFailedException
FilingAllocationManager.
FilingAllocationManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFilingAllocation()
is false
optional
- This method must be implemented if
supportsFilingAllocation()
is true.