public interface AllocationNotificationSession extends OsidSession
This session defines methods to receive notifications of allocation warnings and changed quota assignments. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAllocationNotifications()
Tests if this user can register for
Directory
notifications. |
Directory |
getDirectory()
Gets the
Directory associated with this session. |
java.lang.String |
getDirectoryPath()
Gets the absolute path of this directory.
|
void |
registerForAllocationClearWarnings()
Register for notifications of clearing of allocation warnings.
|
void |
registerForAllocationWarnings()
Register for notifications of allocation warnings.
|
void |
registerForChangedAllocations()
Registers for notification of new, updated or changed allocations
across an entire file system not specific to any user.
|
void |
registerForChangedAllocationsForDirectory(Id dircetory)
Registers for notification of new, updated or changed allocations
across an entire file system not specific to any user.
|
void |
registerForChangedUserAllocations()
Registers for notification of new, updated or changed user quotas.
|
void |
registerForChangedUserAllocationsForUser(Id agentId)
Registers for notification of new, updated or changed quotas for a
specific user.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
java.lang.String getDirectoryPath()
mandatory
- This method must be implemented. Directory getDirectory() throws OperationFailedException, PermissionDeniedException
Directory
associated with this session. Directory
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAllocationNotifications()
Directory
notifications. 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 notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForAllocationWarnings() throws OperationFailedException, PermissionDeniedException
AllocationReceiver.warning()
is invoked when a new warning is
issued.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForAllocationClearWarnings() throws OperationFailedException, PermissionDeniedException
AllocationReceiver.clearWarning()
is invoked when a warning is
cleared.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAllocations() throws OperationFailedException, PermissionDeniedException
AllocationReceiver.changedAllocation()
is invoked when a quota
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAllocationsForDirectory(Id dircetory) throws OperationFailedException, PermissionDeniedException
AllocationReceiver.changedAllocation()
is invoked when a quota
is changed.dircetory
- the pathNullArgumentException
- directory
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedUserAllocations() throws OperationFailedException, PermissionDeniedException
AllocationReceiver.changedUserAllocation()
is invoked
when a quota is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedUserAllocationsForUser(Id agentId) throws OperationFailedException, PermissionDeniedException
AllocationReceiver.changedUserAllocation()
is invoked when a quota is changed.agentId
- the Id
of the userNullArgumentException
- agentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.