org.osid.logging

Interface LogNotificationSession

All Superinterfaces:

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

public interface LogNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForLogNotifications() Tests if this user can register for Log notifications.
void	registerForChangedLog(Id logId) Registers for notification of an updated log.
void	registerForChangedLogs() Registers for notification of updated logs.
void	registerForDeletedLog(Id logId) Registers for notification of a deleted log.
void	registerForDeletedLogAncestors(Id logId) Registers for notification of an updated hierarchy structure that removes an ancestor of the specified log.
void	registerForDeletedLogDescendants(Id logId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified log.
void	registerForDeletedLogs() Registers for notification of deleted logs.
void	registerForNewLogAncestors(Id logId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified log.
void	registerForNewLogDescendants(Id logId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified log.
void	registerForNewLogs() Register for notifications of new logs.

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

canRegisterForLogNotifications

boolean canRegisterForLogNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

registerForNewLogs

void registerForNewLogs()
                        throws OperationFailedException,
                               PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewLogAncestors

void registerForNewLogAncestors(Id logId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified log. LogReceiver.newAncestorLog() is invoked when the specified log node gets a new ancestor.

Parameters:

logId - the Id of the Log node to monitor

Throws:

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewLogDescendants

void registerForNewLogDescendants(Id logId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified log. LogReceiver.newDescendantLog() is invoked when the specified log node gets a new descendant.

Parameters:

logId - the Id of the Log node to monitor

Throws:

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLogs

void registerForChangedLogs()
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLog

void registerForChangedLog(Id logId)
                           throws OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

logId - the Id of the Log to monitor

Throws:

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogs

void registerForDeletedLogs()
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLog

void registerForDeletedLog(Id logId)
                           throws OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

logId - the Id of the Log to monitor

Throws:

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogAncestors

void registerForDeletedLogAncestors(Id logId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified log. LogReceiver.deletedAncestor() is invoked when the specified log node loses an ancestor.

Parameters:

logId - the Id of the Log node to monitor

Throws:

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogDescendants

void registerForDeletedLogDescendants(Id logId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes a descendant of the specified log. LogReceiver.deletedDescendant() is invoked when the specified log node loses a descendant.

Parameters:

logId - the Id of the Log node to monitor

Throws:

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.