OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.path.PathNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetGraphId
Description

Gets the Graph Id associated with this session.

Returnosid.id.Idthe Graph Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGraph
Description

Gets the Graph associated with this session.

Returnosid.topology.Graphthe graph
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForPathNotifications
Description

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

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedGraphView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedGraphView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliablePathNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgePathNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliablePathNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgePathNotification
Description

Acknowledge a path notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPaths
Description

Register for notifications of new paths. PathReceiver.newPaths() is invoked when a new Path appears in this graph.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPathsByGenusType
Description

Register for notifications of new paths of the given genus type. PathReceiver.newPaths() is invoked when a new Path is connected to the specified location.

Parametersosid.type.TypepathGenusTypea path genus type
ErrorsNULL_ARGUMENT pathGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPathsForStartingNode
Description

Register for notifications of new paths from the given node. PathReceiver.newPaths() is invoked when a new Path is connected to the specified location.

Parametersosid.id.IdnodeIdthe Id of the Node to monitor
ErrorsNULL_ARGUMENT nodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPathsForEndingNode
Description

Register for notifications of new paths to the given node. PathReceiver.newPaths() is invoked when a new Path is connected to the specified location.

Parametersosid.id.IdnodeIdthe Id of the Node to monitor
ErrorsNULL_ARGUMENT nodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPaths
Description

Registers for notification of updated paths. PathReceiver.changedPaths() is invoked when a path in this graph is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPathsByGenusType
Description

Registers for notification of updated paths of the given genus type. PathReceiver.changedPaths() is invoked when a path in this graph is changed.

Parametersosid.type.TypepathGenusTypea path genus type
ErrorsNULL_ARGUMENT pathGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPathsForStartingNode
Description

Registers for notification of updated paths from the given node. PathReceiver.changedPaths() is invoked when a path in this graph is changed.

Parametersosid.id.IdnodeIdthe Id of the Node to monitor
ErrorsNULL_ARGUMENT nodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPathsForEndingNode
Description

Registers for notification of updated paths to the given node. PathReceiver.changedPaths() is invoked when a path in this graph is changed.

Parametersosid.id.IdnodeIdthe Id of the Node to monitor
ErrorsNULL_ARGUMENT nodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPath
Description

Registers for notification of an updated path. PathReceiver.changedPaths() is invoked when the specified path in this graph is changed.

Parametersosid.id.IdpathIdthe Id of the Path to monitor
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPaths
Description

Registers for notification of deleted paths. PathReceiver.deletedPaths() is invoked when a path is deleted or removed from this graph.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPathsByGenusType
Description

Registers for notification of deleted paths of the given genus type. PathReceiver.deletedPatsh() is invoked when a path is deleted or removed from this graph.

Parametersosid.type.TypepathGenusTypea path genus type
ErrorsNULL_ARGUMENT pathGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPathsForStartingNode
Description

Register for notifications of removed paths from the given node. PathReceiver.deletedPaths() is invoked when a new Path is removed from the specified location.

Parametersosid.id.IdnodeIdthe Id of the Node to monitor
ErrorsNULL_ARGUMENT nodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPathsForEndingNode
Description

Register for notifications of removed paths to the given node. PathReceiver.deletedPaths() is invoked when a new Path is removed from the specified location.

Parametersosid.id.IdnodeIdthe Id of the Node to monitor
ErrorsNULL_ARGUMENT nodeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPath
Description

Registers for notification of a deleted path. PathReceiver.deletedPaths() is invoked when the specified path is deleted or removed from this graph.

Parametersosid.id.IdpathIdthe Id of the Path to monitor
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.