public interface EdgeEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to EdgeEnabler
objects in this Graph.
This
also includes existing EdgeEnablers
that may appear or
disappear due to changes in the Graph
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
EdgeEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeEdgeEnablerNotification(Id notificationId)
Acknowledge an edge enabler notification.
|
boolean |
canRegisterForEdgeEnablerNotifications()
Tests if this user can register for
EdgeEnabler
notifications. |
Graph |
getGraph()
Gets the
Graph associated with this session. |
Id |
getGraphId()
Gets the
Graph Id associated with this
session. |
void |
registerForChangedEdgeEnabler(Id edgeEnablerId)
Registers for notification of an updated edge enabler.
|
void |
registerForChangedEdgeEnablers()
Registers for notification of updated graph enabelrs.
|
void |
registerForDeletedEdgeEnabler(Id edgeEnablerId)
Registers for notification of a deleted edge enabler.
|
void |
registerForDeletedEdgeEnablers()
Registers for notification of deleted edge enablers.
|
void |
registerForNewEdgeEnablers()
Register for notifications of new edge enablers.
|
void |
reliableEdgeEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableEdgeEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedGraphView()
Federates the view for methods in this session.
|
void |
useIsolatedGraphView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGraphId()
Graph
Id
associated with this
session. Graph Id
associated with this sessionmandatory
- This method must be implemented. Graph getGraph() throws OperationFailedException, PermissionDeniedException
Graph
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForEdgeEnablerNotifications()
EdgeEnabler
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 useFederatedGraphView()
mandatory
- This method is must be implemented. void useIsolatedGraphView()
mandatory
- This method is must be implemented. void reliableEdgeEnablerNotifications()
acknowledgeEdgeEnabelrNotification()
.mandatory
- This method is must be implemented. void unreliableEdgeEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeEdgeEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEdgeEnablers() throws OperationFailedException, PermissionDeniedException
EdgeEnablerReceiver.newEdgeEnablers()
is invoked when a new
EdgeEnabler
appears in this graph.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEdgeEnablers() throws OperationFailedException, PermissionDeniedException
EdgeEnablerReceiver.changedEdgeEnablers()
is invoked when an
edge enabler in this graph is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEdgeEnabler(Id edgeEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedEdgeEnablers()
is invoked when
the specified edge enabler in this graph is changed.edgeEnablerId
- the Id
of the EdgeEnabler
to monitorNullArgumentException
- edgeEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEdgeEnablers() throws OperationFailedException, PermissionDeniedException
EdgeEnablerReceiver.deletedEdgeEnablers()
is invoked when an
edge enabler is deleted or removed from this graph.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEdgeEnabler(Id edgeEnablerId) throws OperationFailedException, PermissionDeniedException
EdgeEnablerReceiver.deletedEdgeEnablers()
is invoked when the
specified edge enabler is deleted or removed from this graph.edgeEnablerId
- the Id
of the EdgeEnabler
to monitorNullArgumentException
- edgeEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.