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 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(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. |
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy FileSystemSession
NullArgumentException
- proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSystem()
is false
optional
- This method must be implemented if
supportsFileSystem()
is true.
FileSystemSession getFileSystemSessionForPath(java.lang.String path, Proxy proxy) throws NotFoundException, OperationFailedException
path
- the path to a directoryproxy
- a proxy FileSystemSession
NotFoundException
- path
is not found or
is not a directoryNullArgumentException
- path
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
of a directoryproxy
- a proxy FileSystemSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSystem()
is false
optional
- This method must be implemented if
supportsFileSystem()
and
supportsVisibleFederation()
are true.
FileSystemManagementSession getFileSystemManagementSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FileSystemManagementSession
NullArgumentException
- proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSystemManagement()
is false
optional
- This method must be implemented if
supportsFileSystemManagement()
is true.
FileSystemManagementSession getFileSystemManagementSessionForPath(java.lang.String path, Proxy proxy) throws NotFoundException, OperationFailedException
path
- the path to a directoryproxy
- a proxy FileSystemManagementSession
NotFoundException
- path
is not found or
is not a directoryNullArgumentException
- path
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
of a directoryproxy
- a proxy FileSystemManagementSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSystemManagement()
is false
optional
- This method must be implemented if
supportsFileSystemManagement()
and
supportsVisibleFederation()
are true.
FileContentSession getFileContentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FileContentSession
NullArgumentException
- proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileContent()
is false
optional
- This method must be implemented if
supportsFileContent()
is true.
FileContentSession getFileContentSessionForPath(java.lang.String path, Proxy proxy) throws NotFoundException, OperationFailedException
path
- the path to a directoryproxy
- a proxy FileContentSession
NotFoundException
- path
is not found or
is not a directoryNullArgumentException
- path
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
of a directoryproxy
- a proxy FileContentSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileContent()
is false
optional
- This method must be implemented if
supportsFileContent()
and
supportsVisibleFederation()
are true.
FileLookupSession getFileLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FileLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileLookup()
is false
optional
- This method must be implemented if
supportsFileLookup()
is true.
FileLookupSession getFileLookupSessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy FileLookupSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileLookup()
is false
optional
- This method must be implemented if
supportsFileLookup()
and
supportsVisibleFederation()
are true.
FileQuerySession getFileQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FileQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileQuery()
is false
optional
- This method must be implemented if
supportsFileQuery()
is true.
FileQuerySession getFileQuerySessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy FileQuerySession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsFileQuery()
is false
optional
- This method must be implemented if
supportsFileQuery()
and
supportsVisibleFederation()
are true.
FileSearchSession getFileSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FileSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsFileSearch()
is false
optional
- This method must be implemented if
supportsFileSearch()
is true.
FileSearchSession getFileSearchSessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy FileSearchSession
NotFoundException
- directoryId
is not
foundNullArgumentException
- directoryId
or
proxy
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, Proxy proxy) throws OperationFailedException
fileReceiver
- the notification callbackproxy
- a proxy a FileNotificationSession
NullArgumentException
- fileReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileNotification()
is false
optional
- This method must be implemented if
supportsFileNotification()
is true.
FileNotificationSession getFileNotificationSessionForDirectory(FileReceiver fileReceiver, Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
fileReceiver
- the notification callbackdirectoryId
- the Id
to the directoryproxy
- a proxy FileNotificationSession
NotFoundException
- directoryPath
is not
foundNullArgumentException
- fileReceiver,
directoryId,
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy FileSmartDirectorySession
NotFoundException
- directoryId is not found
NullArgumentException
- directoryId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFileSmartDirectory()
is false
optional
- This method must be implemented if
supportsFileSmartDirectory()
and
supportsVisibleFederation()
are true.
DirectoryLookupSession getDirectoryLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DirectoryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryLookup()
is false
optional
- This method must be implemented if
supportsDirectoryLookup()
is true.
DirectoryLookupSession getDirectoryLookupSessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy DirectoryLookupSession
NotFoundException
- directoryId is not found
NullArgumentException
- directoryId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryLookup()
is false
optional
- This method must be implemented if
supportsDirectoryLookup()
and
supportsVisibleFederation()
are true.
DirectoryQuerySession getDirectoryQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DirectoryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryQuery()
is false
optional
- This method must be implemented if
supportsDirectoryQuery()
is true.
DirectoryQuerySession getDirectoryQuerySessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy DirectoryQuerySession
NotFoundException
- directoryId is not found
NullArgumentException
- directoryId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryQuery()
is false
optional
- This method must be implemented if
supportsDirectoryQuery()
and
supportsVisibleFederation()
are true.
DirectorySearchSession getDirectorySearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DirectorySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectorySearch()
is false
optional
- This method must be implemented if
supportsDirectorySearch()
is true.
DirectorySearchSession getDirectorySearchSessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy DirectorySearchSession
NotFoundException
- directoryId is not found
NullArgumentException
- directoryId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectorySearch()
is false
optional
- This method must be implemented if
supportsDirectorySearch()
and
supportsVisibleFederation()
are true.
DirectoryAdminSession getDirectoryAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy DirectoryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryAdmin()
is false
optional
- This method must be implemented if
supportsDirectoryAdmin()
is true.
DirectoryAdminSession getDirectoryAdminSessionForDirectory(Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryId
- the Id
to the directoryproxy
- a proxy DirectoryAdminSession
NotFoundException
- directoryId is not found
NullArgumentException
- directoryId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryAdmin()
is false
optional
- This method must be implemented if
supportsDirectoryAdmin()
and
supportsVisibleFederation()
are true.
DirectoryNotificationSession getDirectoryNotificationSession(DirectoryReceiver directoryReceiver, Proxy proxy) throws OperationFailedException
directoryReceiver
- the notification callbackproxy
- a proxy DirectoryNotificationSession
NullArgumentException
- directoryReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryNotification()
is false
optional
- This method must be implemented if
supportsDirectoryNotification()
is true.
DirectoryNotificationSession getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver, Id directoryId, Proxy proxy) throws NotFoundException, OperationFailedException
directoryReceiver
- the notification callbackdirectoryId
- the Id
to the directoryproxy
- a proxy DirectoryNotificationSession
NotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryReceiver,
directoryId,
or proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectoryNotification()
is false
optional
- This method must be implemented if
supportsDirectoryNotification()
and
supportsVisibleFederation()
are true.
FilingAllocationProxyManager getFilingAllocationProxyManager() throws OperationFailedException
FilingAllocationProxyManager.
FilingAllocationProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFilingAllocation()
is false
optional
- This method must be implemented if
supportsFilingAllocation()
is true.