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

This session defines methods to receive notifications on new or deleted log entries. 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 assignments of Ids to this log. For notifications of changes to the Log object use LogNotificationSession.

MethodgetLogId
Description

Gets the Log Id associated with this session.

Returnosid.id.Idthe Log Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetLog
Description

Gets the Log associated with this session.

Returnosid.logging.Logthe Log associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForLogEntryNotifications
Description

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

Federates the view for methods in this session. A federated view will include entries from parent logs in the log hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedLogView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableLogEntryNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableLogEntryNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeLogEntryNotification
Description

Acknowledge a log entry notification.

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

Register for notifications of new log entries. LogEntryReceiver.newLogEntries() is invoked when a new LogEntry is created.

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

Register for notifications of new log entries at or above the given priority type. LogEntryReceiver.newLogEntries() is invoked when a new LogEntry is created.

Parametersosid.type.TypepriorityTypea priority type
ErrorsNULL_ARGUMENT priorityType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewLogEntriesForResource
Description

Register for notifications of new log entries logged by an agent associated with the given resource. LogEntryReceiver.newLogEntries() is invoked when a new LogEntry is created.

Parametersosid.id.IdresourceIda resource Id
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLogEntries
Description

Register for notifications of updated log entries. LogEntryReceiver.changedLogEntries() is invoked when a LogEntry iin this log is changed.

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

Register for notifications of updated log entries at or above the given priority type. LogEntryReceiver.changedLogEntries() is invoked when a LogEntry in this log is changed.

Parametersosid.type.TypepriorityTypea priority type
ErrorsNULL_ARGUMENT priorityType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEntriesForResource
Description

Register for notifications of updated log entries logged by an agent associated with the given resource. LogEntryReceiver.changedLogEntry() is invoked when a LogEntry in this log is changed.

Parametersosid.id.IdresourceIda resource Id
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLogEntry
Description

Registers for notification of an updated log entry. LogEntryReceiver.changedLogEntries() is invoked when the specified log entry is changed.

Parametersosid.id.IdlogEntryIdthe Id of the LogEntry to monitor
ErrorsNULL_ARGUMENT logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLogEntries
Description

Registers for notification of deleted log entries. LogEntryReceiver.deletedLogEntries() is invoked when a log entry is deleted or removed from this log.

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

Register for notifications of deleted log entries at or above the given priority type. LogEntryReceiver.deletedLogEntries() is invoked when a LogEntry is deleted or removed from this log.

Parametersosid.type.TypepriorityTypea priority type
ErrorsNULL_ARGUMENT priorityType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLogEntriesForResource
Description

Register for notifications of deleted log entries logged by an agent associated with the given resource. LogEntryReceiver.deletedLogEntries() is invoked when a LogEntry is deleted or removed from this log.

Parametersosid.id.IdresourceIda resource Id
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLogEntry
Description

Registers for notification of a deleted log entry. LogEntryReceiver.deleteddLogEntries() is invoked when the specified log entry is deleted or removed from this log.

Parametersosid.id.IdlogEntryIdthe Id of the LogEntry to monitor
ErrorsNULL_ARGUMENT logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.