public interface ChainNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Chain
objects in this dDstributor.
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.
The two views defined in this session correspond to the views in the
ChainLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeChainNotification(Id notificationId)
Acknowledge a chain notification.
|
boolean |
canRegisterForChainNotifications()
Tests if this user can register for
Chain
notifications. |
Antimatroid |
getAntimatroid()
Gets the
Antimatroid associated with this session. |
Id |
getAntimatroidId()
Gets the
Antimatroid Id associated with
this session. |
void |
registerForChangedChain(Id chainId)
Registers for notification of an updated chain.
|
void |
registerForChangedChains()
Registers for notification of updated chains.
|
void |
registerForDeletedChain(Id chainId)
Registers for notification of a deleted chain.
|
void |
registerForDeletedChains()
Registers for notification of deleted chains.
|
void |
registerForNewChains()
Register for notifications of new chains.
|
void |
reliableChainNotifications()
Reliable notifications are desired.
|
void |
unreliableChainNotifications()
Unreliable notifications are desired.
|
void |
useFederatedAntimatroidView()
Federates the view for methods in this session.
|
void |
useIsolatedAntimatroidView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAntimatroidId()
Antimatroid
Id
associated with
this session. Antimatroid Id
associated with this sessionmandatory
- This method must be implemented. Antimatroid getAntimatroid() throws OperationFailedException, PermissionDeniedException
Antimatroid
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForChainNotifications()
Chain
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 useFederatedAntimatroidView()
mandatory
- This method is must be implemented. void useIsolatedAntimatroidView()
mandatory
- This method is must be implemented. void reliableChainNotifications()
acknowledgeChainNotification()
.mandatory
- This method is must be implemented. void unreliableChainNotifications()
mandatory
- This method is must be implemented. void acknowledgeChainNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewChains() throws OperationFailedException, PermissionDeniedException
ChainReceiver.newChains()
is invoked when a new Chain
appears in this antimatroid.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedChains() throws OperationFailedException, PermissionDeniedException
ChainReceiver.changedChains()
is invoked when a chain in this
antimatroid is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedChain(Id chainId) throws OperationFailedException, PermissionDeniedException
ChainReceiver.changedChains()
is invoked when the specified
chain in this antimatroid is changed.chainId
- the Id
of the Chain
to
monitorNullArgumentException
- chainId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChains() throws OperationFailedException, PermissionDeniedException
ChainReceiver.deletedChains()
is invoked when a chain is
deleted or removed from this antimatroid.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChain(Id chainId) throws OperationFailedException, PermissionDeniedException
ChainReceiver.deletedChains()
is invoked when the specified
chain is deleted or removed from this antimatroid.chainId
- the Id
of the Chain
to
monitorNullArgumentException
- chainId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.