OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Log objects. 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.

Notifications are triggered with changes to the Log object itself. Adding and removing entries result in notifications available from the notification session for log entries.

MethodcanRegisterForLogNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableLogNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeLogNotification
Description

Acknowledge a log notification.

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

Register for notifications of new logs. LogReceiver.newLogs() is invoked when a new Log is created.

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

Registers for notification of updated logs. LogReceiver.changedLogs() is invoked when a log is changed.

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

Registers for notification of an updated log. LogReceiver.changedLogs() is invoked when the specified log is changed.

Parametersosid.id.IdlogIdthe Id of the Log to monitor
ErrorsNULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLogs
Description

Registers for notification of deleted logs. LogReceiver.deletedLogs() is invoked when a log is deleted.

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

Registers for notification of a deleted log. LogReceiver.deletedLogs() is invoked when the specified log is deleted.

Parametersosid.id.IdlogIdthe Id of the Log to monitor
ErrorsNULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLogHierarchy
Description

Registers for notification of an updated log hierarchy structure. LogReceiver.changedChildOfLogs() is invoked when a node experiences a change in its children.

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

Log Receiver.changedChildOfLogs() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdlogIdthe Id of the Log node to monitor
ErrorsNULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLogHierarchyForDescendants
Description

Registers for notification of an updated log hierarchy structure. LogReceiver.changedChildOfLogs() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdlogIdthe Id of the Log node to monitor
ErrorsNULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.