public interface SignalNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Signal
objects in this Map.
This also
includes existing signals that may appear or disappear due to changes in
the Signal
hierarchy, 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
SignalLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForSignalNotifications()
Tests if this user can register for
Signal
notifications. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForChangedSignal(Id signalId)
Registers for notification of an updated signal.
|
void |
registerForChangedSignals()
Registers for notification of updated signals.
|
void |
registerForChangedSignalsForPath(Id pathId)
Registers for notification of updated signals for the given path.
|
void |
registerForDeletedSignal(Id signalId)
Registers for notification of a deleted signal.
|
void |
registerForDeletedSignals()
Registers for notification of deleted signals.
|
void |
registerForDeletedSignalsForPath(Id pathId)
Registers for notification of deleted signals for the given path.
|
void |
registerForNewSignals()
Register for notifications of new signals.
|
void |
registerForNewSignalsForPath(Id pathId)
Registers for notification of new signals for the given path.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForSignalNotifications()
Signal
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 useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. void registerForNewSignals() throws OperationFailedException, PermissionDeniedException
SignalReceiver.newSignals()
is invoked when a new
Signal
appears in this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SignalReceiver.newSignals()
is invoked when a signal appears
in this map.pathId
- the Id
of the path to monitorNullArgumentException
- pathId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSignals() throws OperationFailedException, PermissionDeniedException
SignalReceiver.changedSignals()
is invoked when a signal in
this map is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SignalReceiver.changedSignals()
is invoked when a
signal in this map is changed.pathId
- the Id
of the path to monitorNullArgumentException
- pathId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSignal(Id signalId) throws OperationFailedException, PermissionDeniedException
SignalReceiver.changedSignals()
is invoked when the specified
signal in this map is changed.signalId
- the Id
of the Signal
to
monitorNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSignals() throws OperationFailedException, PermissionDeniedException
SignalReceiver.deletedSignals()
is invoked when a signal is
deleted or removed from this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSignal(Id signalId) throws OperationFailedException, PermissionDeniedException
SignalReceiver.deletedSignals()
is invoked when the specified
signal is deleted or removed from this map.signalId
- the Id
of the Signal
to
monitorNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SignalReceiver.deletedSignals()
is invoked when a
signal is deleted or removed from this map.pathId
- the Id
of the path to monitorNullArgumentException
- pathId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.