org.osid.topology

Interface EdgeNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface EdgeNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Edge objects in this Graph. This also includes existing edges 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 EdgeLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForEdgeNotifications() Tests if this user can register for Edge notifications.
Graph	getGraph() Gets the Graph associated with this session.
Id	getGraphId() Gets the Graph Id associated with this session.
void	registerForChangedEdge(Id edgeId) Registers for notification of an updated edge.
void	registerForChangedEdges() Registers for notification of updated edges.
void	registerForChangedEdgesByGenusType(Type edgeGenusType) Register for notifications of updated edges by genus type.
void	registerForChangedEdgesForDestinationNode(Id nodeId) Register for notifications of updated edges to a specified node.
void	registerForChangedEdgesForSourceNode(Id nodeId) Register for notifications of updated edges from a specified node.
void	registerForDeletedEdge(Id edgeId) Registers for notification of a deleted edge.
void	registerForDeletedEdges() Registers for notification of deleted edges.
void	registerForDeletedEdgesByGenusType(Type edgeGenusType) Register for notifications of deleted edges by genus type.
void	registerForDeletedEdgesForDestinationNode(Id nodeId) Register for notifications of new edges to a specified node.
void	registerForDeletedEdgesForSourceNode(Id nodeId) Register for notifications of new edges from a specified node.
void	registerForNewEdges() Register for notifications of new edges.
void	registerForNewEdgesByGenusType(Type edgeGenusType) Register for notifications of new edges by genus type.
void	registerForNewEdgesForDestinationNode(Id nodeId) Register for notifications of new edges to a specified node.
void	registerForNewEdgesForSourceNode(Id nodeId) Register for notifications of new edges from a specified node.
void	useFederatedGraphView() Federates the view for methods in this session.
void	useIsolatedGraphView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getGraphId

Id getGraphId()

Gets the Graph Id associated with this session.

Returns:

the Graph Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraph

Graph getGraph()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Graph associated with this session.

Returns:

the graph

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForEdgeNotifications

boolean canRegisterForEdgeNotifications()

Tests if this user can register for Edge 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedGraphView

void useFederatedGraphView()

Federates the view for methods in this session. A federated view will include edges in graphs which are children of this graph in the graph hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedGraphView

void useIsolatedGraphView()

Isolates the view for methods in this session. An isolated view restricts notifications to this graph only.

Compliance:

mandatory - This method is must be implemented.

registerForNewEdges

void registerForNewEdges()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new edges. EdgeReceiver.newEdge() is invoked when a new Edge appears in this graph.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewEdgesByGenusType

void registerForNewEdgesByGenusType(Type edgeGenusType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Register for notifications of new edges by genus type. EdgeReceiver.newEdgeConnection() is invoked when a new Edge is connected to the specified node.

Parameters:

edgeGenusType - an edge genus type

Throws:

NullArgumentException - edgeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewEdgesForSourceNode

void registerForNewEdgesForSourceNode(Id nodeId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of new edges from a specified node. EdgeReceiver.newEdgeConnection() is invoked when a new Edge is connected to the specified node.

Parameters:

nodeId - the Id of the Node to monitor

Throws:

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewEdgesForDestinationNode

void registerForNewEdgesForDestinationNode(Id nodeId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new edges to a specified node. EdgeReceiver.newEdgeConnection() is invoked when a new Edge is connected to the specified node.

Parameters:

nodeId - the Id of the Node to monitor

Throws:

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedEdges

void registerForChangedEdges()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated edges. EdgeReceiver.changedEdge() is invoked when an edge in this graph is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedEdgesByGenusType

void registerForChangedEdgesByGenusType(Type edgeGenusType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of updated edges by genus type. EdgeReceiver.changedEdgeConnection() is invoked when an Edge in this graph is changed.

Parameters:

edgeGenusType - an edge genus type

Throws:

NullArgumentException - edgeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedEdgesForSourceNode

void registerForChangedEdgesForSourceNode(Id nodeId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of updated edges from a specified node. EdgeReceiver.changedEdgeConnection() is invoked when an Edge in this graph is changed.

Parameters:

nodeId - the Id of the Node to monitor

Throws:

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedEdgesForDestinationNode

void registerForChangedEdgesForDestinationNode(Id nodeId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of updated edges to a specified node. EdgeReceiver.changedEdgeConnection() is invoked when an Edge in this graph is changed.

Parameters:

nodeId - the Id of the Node to monitor

Throws:

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedEdge

void registerForChangedEdge(Id edgeId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of an updated edge. EdgeReceiver.changedEdge() is invoked when the specified edge in this graph is changed.

Parameters:

edgeId - the Id of the Edge to monitor

Throws:

NullArgumentException - edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedEdges

void registerForDeletedEdges()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted edges. EdgeReceiver.deletedEdge() is invoked when an edge is deleted or removed from this graph.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedEdgesByGenusType

void registerForDeletedEdgesByGenusType(Type edgeGenusType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of deleted edges by genus type. EdgeReceiver.deletedEdgeConnection() is invoked when an Edge in this graph is removed.

Parameters:

edgeGenusType - an edge genus type

Throws:

NullArgumentException - edgeGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedEdgesForSourceNode

void registerForDeletedEdgesForSourceNode(Id nodeId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new edges from a specified node. EdgeReceiver.deletedEdgeConnection() is invoked when a new Edge is connected to the specified node.

Parameters:

nodeId - the Id of the Node to monitor

Throws:

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedEdgesForDestinationNode

void registerForDeletedEdgesForDestinationNode(Id nodeId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Register for notifications of new edges to a specified node. EdgeReceiver.deletedEdgeConnection() is invoked when a new Edge is connected to the specified node.

Parameters:

nodeId - the Id of the Node to monitor

Throws:

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedEdge

void registerForDeletedEdge(Id edgeId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Registers for notification of a deleted edge. EdgeReceiver.deletedEdge() is invoked when the specified edge is deleted or removed from this graph.

Parameters:

edgeId - the Id of the Edge to monitor

Throws:

NotFoundException - an edge was not found identified by the given Id

NullArgumentException - edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.