public interface FilingAllocationProxyManager extends OsidProxyManager, FilingAllocationProfile
The filing allocation manager provides access sessions to allocations.
Methods in this manager support the passing of a Proxy
to
pass information from server environments. The sessions included in this
manager are:
AllocationSession:
a session for accessing usage
information and quotas for the current user AllocationLookupSession:
a session for accessing
usage information and quotas AllocationAdminSession
a session for assigning
quotas AllocationNotificationSession:
a session for
subscribing to usage warnings and quota changes Modifier and Type | Method and Description |
---|---|
AllocationAdminSession |
getAllocationAdminSession(Proxy proxy)
Gets the session for assigning quotas.
|
AllocationAdminSession |
getAllocationAdminSessionForDirectory(java.lang.String directoryPath,
Proxy proxy)
Gets the session for assigning quotas for the given directory.
|
AllocationLookupSession |
getAllocationLookupSession(Proxy proxy)
Gets the session for accessing usage and quotas.
|
AllocationLookupSession |
getAllocationLookupSessionForDirectory(java.lang.String directoryPath,
Proxy proxy)
Gets the session for accessing usage and quotas for a given directory.
|
AllocationNotificationSession |
getAllocationNotificationSession(AllocationReceiver allocationReceiver,
Proxy proxy)
Gets the session for receiving messages about changes to directories.
|
AllocationNotificationSession |
getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver,
java.lang.String directoryPath,
Proxy proxy)
Gets the session for receiving messages about usage warnings and quota
changes for the given directory.
|
AllocationSession |
getAllocationSession(Proxy proxy)
Gets the session for accessing usage and quotas.
|
AllocationSession |
getAllocationSessionForDirectory(java.lang.String directoryPath,
Proxy proxy)
Gets the session for accessing usage and quotas for a given directory.
|
changeBranch, initialize, rollbackService
close
getAllocationRecordTypes, supportsAllocation, supportsAllocationAdmin, supportsAllocationLookup, supportsAllocationNotification, supportsAllocationRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AllocationSession getAllocationSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AllocationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAllocation()
is false
optional
- This method must be implemented if
supportsAllocation()
is true.
AllocationSession getAllocationSessionForDirectory(java.lang.String directoryPath, Proxy proxy) throws NotFoundException, OperationFailedException
directoryPath
- the pathname to the directoryproxy
- a proxy AllocationSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryPath
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsAllocation()
is false
optional
- This method must be implemented if
supportsAllocation()
and
supportsVisibleFederation()
are true.
AllocationLookupSession getAllocationLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AllocationLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationLookup()
is false
optional
- This method must be implemented if
supportsAllocationLookup()
is true.
AllocationLookupSession getAllocationLookupSessionForDirectory(java.lang.String directoryPath, Proxy proxy) throws NotFoundException, OperationFailedException
directoryPath
- the pathname to the directoryproxy
- a proxy AllocationLookupSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryPath
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationLookup()
is false
optional
- This method must be implemented if
supportsAllocationLookup()
and
supportsVisibleFederation()
are true.
AllocationAdminSession getAllocationAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy AllocationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationAdmin()
is false
optional
- This method must be implemented if
supportsAllocationAdmin()
is true.
AllocationAdminSession getAllocationAdminSessionForDirectory(java.lang.String directoryPath, Proxy proxy) throws NotFoundException, OperationFailedException
directoryPath
- the pathname to the directoryproxy
- a proxy AllocationAdminSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryPath
or
proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationAdmin()
is false
optional
- This method must be implemented if
supportsAllocationAdmin()
and
supportsVisibleFederation()
are true.
AllocationNotificationSession getAllocationNotificationSession(AllocationReceiver allocationReceiver, Proxy proxy) throws OperationFailedException
allocationReceiver
- the notification callbackproxy
- a proxy AllocationNotificationSession
NullArgumentException
- allocationReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationNotification()
is false
optional
- This method must be implemented if
supportsDirectoryNotification()
is true.
AllocationNotificationSession getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver, java.lang.String directoryPath, Proxy proxy) throws NotFoundException, OperationFailedException
allocationReceiver
- the notification callbackdirectoryPath
- the pathname to the directoryproxy
- a proxy AllocationNotificationSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- allocationReceiver,
directoryPath
or proxy
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationNotification()
is false
optional
- This method must be implemented if
supportsAllocationNotification()
and
supportsVisibleFederation()
are true.