public interface LoggingManager extends OsidManager, LoggingProfile
The logging manager provides access to logging sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
LoggingSession:
a session to write to a log LogEntryLookupSession:
a session to read a log
LogEntryQuerySession:
a session to search a log
LogEntrySearchSession:
a session to search a log
LogEntryAdminSession:
a session to manage log
entries in a log LogEntryNotificationSession:
a session to
subscribe to notifications of new log entries LogEntryLogSession:
a session to examine log entry
to log mappings LogEntryLogAssignmentSession:
a session to manage
log entry to log mappings LogEntrySmartLogSession:
a session to manage
dynamic logs LogLookupSession:
a session to retrieve log
objects LogQuerySession:
a session to search for logs
LogSearchSession:
a session to search for logs
LogAdminSession:
a session to create, update and
delete logs LogNotificationSession:
a session to receive
notifications for changes in logs LogHierarchyTraversalSession:
a session to
traverse hierarchies of logs LogHierarchyDesignSession:
a session to manage
hierarchies of logs The logging manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
LogAdminSession |
getLogAdminSession()
Gets the
OsidSession associated with the log
administrative service. |
LogEntryAdminSession |
getLogEntryAdminSession()
Gets the
OsidSession associated with the logging entry
administrative service. |
LogEntryAdminSession |
getLogEntryAdminSessionForLog(Id logId)
Gets the
OsidSession associated with the log entry
administrative service for the given log. |
LogEntryLogAssignmentSession |
getLogEntryLogAssignmentSession()
Gets the session for assigning log entry to logs mappings.
|
LogEntryLogSession |
getLogEntryLogSession()
Gets the session for retrieving log entry to log mappings.
|
LogEntryLookupSession |
getLogEntryLookupSession()
Gets the
OsidSession associated with the log reading
service. |
LogEntryLookupSession |
getLogEntryLookupSessionForLog(Id logId)
Gets the
OsidSession associated with the log reading
service for the given log. |
LogEntryNotificationSession |
getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver)
Gets the
OsidSession associated with the logging entry
notification service. |
LogEntryNotificationSession |
getLogEntryNotificationSessionForLog(LogEntryReceiver logEntryReceiver,
Id logId)
Gets the
OsidSession associated with the log entry
notification service for the given log. |
LogEntryQuerySession |
getLogEntryQuerySession()
Gets the
OsidSession associated with the logging entry
query service. |
LogEntryQuerySession |
getLogEntryQuerySessionForLog(Id logId)
Gets the
OsidSession associated with the log entry
query service for the given log. |
LogEntrySearchSession |
getLogEntrySearchSession()
Gets the
OsidSession associated with the logging entry
search service. |
LogEntrySearchSession |
getLogEntrySearchSessionForLog(Id logId)
Gets the
OsidSession associated with the log entry
search service for the given log. |
LogEntrySmartLogSession |
getLogEntrySmartLogSession(Id logId)
Gets the session for managing dynamic logEntry log.
|
LoggingBatchManager |
getLoggingBatchManager()
Gets a
LoggingBatchManager. |
LoggingSession |
getLoggingSession()
Gets the
OsidSession associated with the logging
service. |
LoggingSession |
getLoggingSessionForLog(Id logId)
Gets the
OsidSession associated with the logging
service for the given log. |
LogHierarchyDesignSession |
getLogHierarchyDesignSession()
Gets the
OsidSession associated with the log hierarchy
design service. |
LogHierarchySession |
getLogHierarchySession()
Gets the
OsidSession associated with the log hierarchy
service. |
LogLookupSession |
getLogLookupSession()
Gets the
OsidSession associated with the log lookup
service. |
LogNotificationSession |
getLogNotificationSession(LogReceiver logReceiver)
Gets the
OsidSession associated with the log
notification service. |
LogQuerySession |
getLogQuerySession()
Gets the
OsidSession associated with the log query
service. |
LogSearchSession |
getLogSearchSession()
Gets the
OsidSession associated with the log search
service. |
changeBranch, initialize, rollbackService
close
getContentTypes, getLogEntryRecordTypes, getLogEntrySearchRecordTypes, getLogRecordTypes, getLogSearchRecordTypes, getPriorityTypes, supportsContentType, supportsLogAdmin, supportsLogEntryLog, supportsLogEntryLogAssignment, supportsLogEntryLookup, supportsLogEntryNotification, supportsLogEntryQuery, supportsLogEntryRecordType, supportsLogEntrySearch, supportsLogEntrySearchRecordType, supportsLogEntrySmartLog, supportsLogging, supportsLoggingBatch, supportsLogHierarchy, supportsLogHierarchyDesign, supportsLogLookup, supportsLogNotification, supportsLogQuery, supportsLogRecordType, supportsLogSearch, supportsLogSearchRecordType, supportsPriorityType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
LoggingSession getLoggingSession() throws OperationFailedException
OsidSession
associated with the logging
service. LoggingSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogging()
is false
optional
- This method must be implemented if
supportsLogging()
is true.
LoggingSession getLoggingSessionForLog(Id logId) throws NotFoundException, OperationFailedException
OsidSession
associated with the logging
service for the given log.logId
- the Id
of the Log
LoggingSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogging()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLogging()
and
supportsVisibleFederation()
are true
LogEntryLookupSession getLogEntryLookupSession() throws OperationFailedException
OsidSession
associated with the log reading
service. LogEntryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryLookup()
is false
optional
- This method must be implemented if
supportsLogEntryLookup()
is true.
LogEntryLookupSession getLogEntryLookupSessionForLog(Id logId) throws NotFoundException, OperationFailedException
OsidSession
associated with the log reading
service for the given log.logId
- the Id
of the Log
LogEntryLookupSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLogEntryLookup()
and
supportsVisibleFederation()
are true
LogEntryQuerySession getLogEntryQuerySession() throws OperationFailedException
OsidSession
associated with the logging entry
query service. LogEntryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryQuery()
is false
optional
- This method must be implemented if
supportsLogEntryQuery()
is true.
LogEntryQuerySession getLogEntryQuerySessionForLog(Id logId) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
query service for the given log.logId
- the Id
of the Log
LogEntryQuerySession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLogEntryQuery()
and
supportsVisibleFederation()
are true
LogEntrySearchSession getLogEntrySearchSession() throws OperationFailedException
OsidSession
associated with the logging entry
search service. LogEntrySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntrySearch()
is false
optional
- This method must be implemented if
supportsLogEntrySearch()
is true.
LogEntrySearchSession getLogEntrySearchSessionForLog(Id logId) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
search service for the given log.logId
- the Id
of the Log
LogEntrySearchSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntrySearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLogEntrySearch()
and
supportsVisibleFederation()
are true
LogEntryAdminSession getLogEntryAdminSession() throws OperationFailedException
OsidSession
associated with the logging entry
administrative service. LogEntryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryAdmin()
is false
optional
- This method must be implemented if
supportsLogEntryAdmin()
is true.
LogEntryAdminSession getLogEntryAdminSessionForLog(Id logId) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
administrative service for the given log.logId
- the Id
of the Log
LogEntryAdminSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLogEntryAdmin()
and
supportsVisibleFederation()
are true
LogEntryNotificationSession getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver) throws OperationFailedException
OsidSession
associated with the logging entry
notification service.logEntryReceiver
- the receiver LogEntryNotificationSession
NullArgumentException
- logEntryReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryNotification()
is false
optional
- This method must be implemented if
supportsLogEntryNotification()
is true.
LogEntryNotificationSession getLogEntryNotificationSessionForLog(LogEntryReceiver logEntryReceiver, Id logId) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
notification service for the given log.logEntryReceiver
- the receiverlogId
- the Id
of the Log
LogEntryNotificationSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logEntryReceiver
or logId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLogEntryNotification()
and
supportsVisibleFederation()
are true
LogEntryLogSession getLogEntryLogSession() throws OperationFailedException
LogEntryLogSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryLog()
is false
optional
- This method must be implemented if
supportsLogEntryLog()
is true.
LogEntryLogAssignmentSession getLogEntryLogAssignmentSession() throws OperationFailedException
LogEntryLogAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryLogAssignment()
is false
optional
- This method must be implemented if
supportsLogEntryLogAssignment()
is true.
LogEntrySmartLogSession getLogEntrySmartLogSession(Id logId) throws NotFoundException, OperationFailedException
logId
- the Id
of the log LogEntrySmartLogSession
NotFoundException
- logId
not foundNullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntrySmartLog()
is false
optional
- This method must be implemented if
supportsLogEntrySmartLog()
is true.
LogLookupSession getLogLookupSession() throws OperationFailedException
OsidSession
associated with the log lookup
service. LogLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogLookup()
is false
optional
- This method must be implemented if
supportsLogLookup()
is true.
LogQuerySession getLogQuerySession() throws OperationFailedException
OsidSession
associated with the log query
service. LogQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogQuery()
is false
optional
- This method must be implemented if
supportsLogQuery()
is true.
LogSearchSession getLogSearchSession() throws OperationFailedException
OsidSession
associated with the log search
service. LogSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogSearch()
is false
optional
- This method must be implemented if
supportsLogSearch()
is true.
LogAdminSession getLogAdminSession() throws OperationFailedException
OsidSession
associated with the log
administrative service. LogAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogAdmin()
is false
optional
- This method must be implemented if
supportsLogAdmin()
is true.
LogNotificationSession getLogNotificationSession(LogReceiver logReceiver) throws OperationFailedException
OsidSession
associated with the log
notification service.logReceiver
- the receiver LogNotificationSession
NullArgumentException
- logReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogNotification()
is false
optional
- This method must be implemented if
supportsLogNotification()
is true.
LogHierarchySession getLogHierarchySession() throws OperationFailedException
OsidSession
associated with the log hierarchy
service. LogHierarchySession
for logsOperationFailedException
- unable to complete requestUnimplementedException
- supportsLogHierarchy()
is false
optional
- This method must be implemented if
supportsLogHierarchy()
is true.
LogHierarchyDesignSession getLogHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the log hierarchy
design service. HierarchyDesignSession
for logsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogHierarchyDesign()
is false
optional
- This method must be implemented if
supportsLogHierarchyDesign()
is true.
LoggingBatchManager getLoggingBatchManager() throws OperationFailedException
LoggingBatchManager.
LoggingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLoggingBatch()
is false
optional
- This method must be implemented if
supportsLoggingBatch()
is true.