public interface LogEntryNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeLogEntryNotification(Id notificationId)
Acknowledge a log entry notification.
|
boolean |
canRegisterForLogEntryNotifications()
Tests if this user can register for
Log entry
notifications. |
Log |
getLog()
Gets the
Log associated with this session. |
Id |
getLogId()
Gets the
Log Id associated with this
session. |
void |
registerForChangedEntriesAtPriority(Type priorityType)
Register for notifications of updated log entries at or above the
given priority type.
|
void |
registerForChangedEntriesForResource(Id resourceId)
Register for notifications of updated log entries logged by an agent
associated with the given resource.
|
void |
registerForChangedLogEntries()
Register for notifications of updated log entries.
|
void |
registerForChangedLogEntry(Id logEntryId)
Registers for notification of an updated log entry.
|
void |
registerForDeletedLogEntries()
Registers for notification of deleted log entries.
|
void |
registerForDeletedLogEntriesAtPriority(Type priorityType)
Register for notifications of deleted log entries at or above the
given priority type.
|
void |
registerForDeletedLogEntriesForResource(Id resourceId)
Register for notifications of deleted log entries logged by an agent
associated with the given resource.
|
void |
registerForDeletedLogEntry(Id logEntryId)
Registers for notification of a deleted log entry.
|
void |
registerForNewLogEntries()
Register for notifications of new log entries.
|
void |
registerForNewLogEntriesAtPriority(Type priorityType)
Register for notifications of new log entries at or above the given
priority type.
|
void |
registerForNewLogEntriesForResource(Id resourceId)
Register for notifications of new log entries logged by an agent
associated with the given resource.
|
void |
reliableLogEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableLogEntryNotifications()
Unreliable notifications are desired.
|
void |
useFederatedLogView()
Federates the view for methods in this session.
|
void |
useIsolatedLogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getLogId()
Log
Id
associated with this
session. Log Id
associated with this sessionmandatory
- This method must be implemented. Log getLog() throws OperationFailedException, PermissionDeniedException
Log
associated with this session. Log
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForLogEntryNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedLogView()
mandatory
- This method is must be implemented. void useIsolatedLogView()
mandatory
- This method is must be implemented. void reliableLogEntryNotifications()
acknowledgeLogEntryNotification()
.mandatory
- This method is must be implemented. void unreliableLogEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeLogEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.newLogEntries()
is invoked when a new
LogEntry
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewLogEntriesAtPriority(Type priorityType) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.newLogEntries()
is
invoked when a new LogEntry
is created.priorityType
- a priority typeNullArgumentException
- priorityType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewLogEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.newLogEntries()
is invoked when a new
LogEntry
is created.resourceId
- a resource Id
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.changedLogEntries()
is invoked when a
LogEntry
iin this log is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntriesAtPriority(Type priorityType) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.changedLogEntries()
is invoked when a LogEntry
in this log is
changed.priorityType
- a priority typeNullArgumentException
- priorityType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.changedLogEntry()
is invoked when a
LogEntry
in this log is changed.resourceId
- a resource Id
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLogEntry(Id logEntryId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.changedLogEntries()
is invoked when the
specified log entry is changed.logEntryId
- the Id
of the LogEntry
to monitorNullArgumentException
- logEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when a log
entry is deleted or removed from this log.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntriesAtPriority(Type priorityType) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when a LogEntry
is deleted or
removed from this log.priorityType
- a priority typeNullArgumentException
- priorityType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when a
LogEntry
is deleted or removed from this log.resourceId
- a resource Id
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntry(Id logEntryId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deleteddLogEntries()
is invoked when the
specified log entry is deleted or removed from this log.logEntryId
- the Id
of the LogEntry
to monitorNullArgumentException
- logEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.