org.osid.logging

Interface LoggingManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LoggingProfile, OsidManager, OsidProfile, Sourceable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.logging.LoggingProfile

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

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getLoggingSession

LoggingSession getLoggingSession()
                                 throws OperationFailedException

Gets the OsidSession associated with the logging service.

Returns:

a LoggingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogging() is false

Compliance:

optional - This method must be implemented if supportsLogging() is true.

getLoggingSessionForLog

LoggingSession getLoggingSessionForLog(Id logId)
                                       throws NotFoundException,
                                              OperationFailedException

Gets the OsidSession associated with the logging service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LoggingSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogging() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogging() and supportsVisibleFederation() are true

getLogEntryLookupSession

LogEntryLookupSession getLogEntryLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the log reading service.

Returns:

a LogEntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLookup() is false

Compliance:

optional - This method must be implemented if supportsLogEntryLookup() is true.

getLogEntryLookupSessionForLog

LogEntryLookupSession getLogEntryLookupSessionForLog(Id logId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the log reading service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LogEntryLookupSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntryLookup() and supportsVisibleFederation() are true

getLogEntryQuerySession

LogEntryQuerySession getLogEntryQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the logging entry query service.

Returns:

a LogEntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsLogEntryQuery() is true.

getLogEntryQuerySessionForLog

LogEntryQuerySession getLogEntryQuerySessionForLog(Id logId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the log entry query service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LogEntryQuerySession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntryQuery() and supportsVisibleFederation() are true

getLogEntrySearchSession

LogEntrySearchSession getLogEntrySearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the logging entry search service.

Returns:

a LogEntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntrySearch() is false

Compliance:

optional - This method must be implemented if supportsLogEntrySearch() is true.

getLogEntrySearchSessionForLog

LogEntrySearchSession getLogEntrySearchSessionForLog(Id logId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the log entry search service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LogEntrySearchSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntrySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntrySearch() and supportsVisibleFederation() are true

getLogEntryAdminSession

LogEntryAdminSession getLogEntryAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the logging entry administrative service.

Returns:

a LogEntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryAdmin() is false

Compliance:

optional - This method must be implemented if supportsLogEntryAdmin() is true.

getLogEntryAdminSessionForLog

LogEntryAdminSession getLogEntryAdminSessionForLog(Id logId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the log entry administrative service for the given log.

Parameters:

logId - the Id of the Log

Returns:

a LogEntryAdminSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntryAdmin() and supportsVisibleFederation() are true

getLogEntryNotificationSession

LogEntryNotificationSession getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver)
                                                           throws OperationFailedException

Gets the OsidSession associated with the logging entry notification service.

Parameters:

logEntryReceiver - the receiver

Returns:

a LogEntryNotificationSession

Throws:

NullArgumentException - logEntryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryNotification() is false

Compliance:

optional - This method must be implemented if supportsLogEntryNotification() is true.

getLogEntryNotificationSessionForLog

LogEntryNotificationSession getLogEntryNotificationSessionForLog(LogEntryReceiver logEntryReceiver,
                                                               Id logId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the log entry notification service for the given log.

Parameters:

logEntryReceiver - the receiver

logId - the Id of the Log

Returns:

a LogEntryNotificationSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logEntryReceiver or logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLogEntryNotification() and supportsVisibleFederation() are true

getLogEntryLogSession

LogEntryLogSession getLogEntryLogSession()
                                         throws OperationFailedException

Gets the session for retrieving log entry to log mappings.

Returns:

a LogEntryLogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLog() is false

Compliance:

optional - This method must be implemented if supportsLogEntryLog() is true.

getLogEntryLogAssignmentSession

LogEntryLogAssignmentSession getLogEntryLogAssignmentSession()
                                                             throws OperationFailedException

Gets the session for assigning log entry to logs mappings.

Returns:

a LogEntryLogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLogAssignment() is false

Compliance:

optional - This method must be implemented if supportsLogEntryLogAssignment() is true.

getLogEntrySmartLogSession

LogEntrySmartLogSession getLogEntrySmartLogSession(Id logId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session for managing dynamic logEntry log.

Parameters:

logId - the Id of the log

Returns:

a LogEntrySmartLogSession

Throws:

NotFoundException - logId not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntrySmartLog() is false

Compliance:

optional - This method must be implemented if supportsLogEntrySmartLog() is true.

getLogLookupSession

LogLookupSession getLogLookupSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the log lookup service.

Returns:

a LogLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogLookup() is false

Compliance:

optional - This method must be implemented if supportsLogLookup() is true.

getLogQuerySession

LogQuerySession getLogQuerySession()
                                   throws OperationFailedException

Gets the OsidSession associated with the log query service.

Returns:

a LogQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogQuery() is false

Compliance:

optional - This method must be implemented if supportsLogQuery() is true.

getLogSearchSession

LogSearchSession getLogSearchSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the log search service.

Returns:

a LogSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogSearch() is false

Compliance:

optional - This method must be implemented if supportsLogSearch() is true.

getLogAdminSession

LogAdminSession getLogAdminSession()
                                   throws OperationFailedException

Gets the OsidSession associated with the log administrative service.

Returns:

a LogAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogAdmin() is false

Compliance:

optional - This method must be implemented if supportsLogAdmin() is true.

getLogNotificationSession

LogNotificationSession getLogNotificationSession(LogReceiver logReceiver)
                                                 throws OperationFailedException

Gets the OsidSession associated with the log notification service.

Parameters:

logReceiver - the receiver

Returns:

a LogNotificationSession

Throws:

NullArgumentException - logReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogNotification() is false

Compliance:

optional - This method must be implemented if supportsLogNotification() is true.

getLogHierarchySession

LogHierarchySession getLogHierarchySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the log hierarchy service.

Returns:

a LogHierarchySession for logs

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogHierarchy() is false

Compliance:

optional - This method must be implemented if supportsLogHierarchy() is true.

getLogHierarchyDesignSession

LogHierarchyDesignSession getLogHierarchyDesignSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the log hierarchy design service.

Returns:

a HierarchyDesignSession for logs

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsLogHierarchyDesign() is true.

getLoggingBatchManager

LoggingBatchManager getLoggingBatchManager()
                                           throws OperationFailedException

Gets a LoggingBatchManager.

Returns:

a LoggingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLoggingBatch() is false

Compliance:

optional - This method must be implemented if supportsLoggingBatch() is true.