Interface LoggingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, LoggingProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface LoggingProxyManager
extends OsidProxyManager, LoggingProfile

The logging manager provides access to logging sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information from server environments. 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

Modifier and Type	Method	Description
LogAdminSession	getLogAdminSession(Proxy proxy)	Gets the OsidSession associated with the log administrative service.
LogEntryAdminSession	getLogEntryAdminSession(Proxy proxy)	Gets the OsidSession associated with the logging entry administrative service.
LogEntryAdminSession	getLogEntryAdminSessionForLog(Id logId, Proxy proxy)	Gets the OsidSession associated with the log entry administrative service for the given log.
LogEntryLogAssignmentSession	getLogEntryLogAssignmentSession(Proxy proxy)	Gets the session for assigning log entry to log mappings.
LogEntryLogSession	getLogEntryLogSession(Proxy proxy)	Gets the session for retrieving log entry to log mappings.
LogEntryLookupSession	getLogEntryLookupSession(Proxy proxy)	Gets the OsidSession associated with the logging reading service.
LogEntryLookupSession	getLogEntryLookupSessionForLog(Id logId, Proxy proxy)	Gets the OsidSession associated with the log reading service for the given log.
LogEntryNotificationSession	getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver, Proxy proxy)	Gets the OsidSession associated with the logging entry notification service.
LogEntryNotificationSession	getLogEntryNotificationSessionForLog(LogEntryReceiver logEntryReceiver, Id logId, Proxy proxy)	Gets the OsidSession associated with the log entry notification service for the given log.
LogEntryQuerySession	getLogEntryQuerySession(Proxy proxy)	Gets the OsidSession associated with the logging entry query service.
LogEntryQuerySession	getLogEntryQuerySessionForLog(Id logId, Proxy proxy)	Gets the OsidSession associated with the log entry query service for the given log.
LogEntrySearchSession	getLogEntrySearchSession(Proxy proxy)	Gets the OsidSession associated with the logging entry search service.
LogEntrySearchSession	getLogEntrySearchSessionForLog(Id logId, Proxy proxy)	Gets the OsidSession associated with the log entry search service for the given log.
LogEntrySmartLogSession	getLogEntrySmartLogSession(Id logId, Proxy proxy)	Gets the session for managing dynamic log entry logs.
LoggingBatchProxyManager	getLoggingBatchProxyManager()	Gets a LoggingBatchProxyManager .
LoggingSession	getLoggingSession(Proxy proxy)	Gets the OsidSession associated with the logging service.
LoggingSession	getLoggingSessionForLog(Id logId, Proxy proxy)	Gets the OsidSession associated with the logging service for the given log.
LogHierarchyDesignSession	getLogHierarchyDesignSession(Proxy proxy)	Gets the OsidSession associated with the log hierarchy design service.
LogHierarchySession	getLogHierarchySession(Proxy proxy)	Gets the OsidSession associated with the log hierarchy service.
LogLookupSession	getLogLookupSession(Proxy proxy)	Gets the OsidSession associated with the log lookup service.
LogNotificationSession	getLogNotificationSession(LogReceiver logReceiver, Proxy proxy)	Gets the OsidSession associated with the log notification service.
LogQuerySession	getLogQuerySession(Proxy proxy)	Gets the OsidSession associated with the log query service.
LogSearchSession	getLogSearchSession(Proxy proxy)	Gets the OsidSession associated with the log search service.

Methods inherited from interface Closeable

close

Methods inherited from interface LoggingProfile

getContentTypes, getLogEntryRecordTypes, getLogEntrySearchRecordTypes, getLogRecordTypes, getLogSearchRecordTypes, getPriorityTypes, supportsContentType, supportsLogAdmin, supportsLogEntryAdmin, supportsLogEntryLog, supportsLogEntryLogAssignment, supportsLogEntryLookup, supportsLogEntryNotification, supportsLogEntryQuery, supportsLogEntryRecordType, supportsLogEntrySearch, supportsLogEntrySearchRecordType, supportsLogEntrySmartLog, supportsLogging, supportsLoggingBatch, supportsLogHierarchy, supportsLogHierarchyDesign, supportsLogLookup, supportsLogNotification, supportsLogQuery, supportsLogRecordType, supportsLogSearch, supportsLogSearchRecordType, supportsPriorityType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getContentTypes()	Gets the content types supported.
TypeList	getLogEntryRecordTypes()	Gets the supported Log record types.
TypeList	getLogEntrySearchRecordTypes()	Gets the supported log entry search record types.
TypeList	getLogRecordTypes()	Gets the supported Log record types.
TypeList	getLogSearchRecordTypes()	Gets the supported log search record types.
TypeList	getPriorityTypes()	Gets the priority types supported, in ascending order of the priority level.
boolean	supportsContentType(Type contentType)	Tests if the content type is supported.
boolean	supportsLogAdmin()	Tests for the availability of a log administrative service for creating and deleting logs.
boolean	supportsLogEntryAdmin()	Tests if managing log entries is supported.
boolean	supportsLogEntryLog()	Tests if looking up log entry log mappings is supported.
boolean	supportsLogEntryLogAssignment()	Tests if managing log entry log mappings is supported.
boolean	supportsLogEntryLookup()	Tests if reading logs is supported.
boolean	supportsLogEntryNotification()	Tests if log entry notification is supported,.
boolean	supportsLogEntryQuery()	Tests if querying log entries is supported.
boolean	supportsLogEntryRecordType(Type logEntryRecordType)	Tests if the given LogEntry record type is supported.
boolean	supportsLogEntrySearch()	Tests if searching log entries is supported.
boolean	supportsLogEntrySearchRecordType(Type logEntrySearchRecordType)	Tests if the given log entry search record type is supported.
boolean	supportsLogEntrySmartLog()	Tests if smart logs is supported.
boolean	supportsLogging()	Tests if logging is supported.
boolean	supportsLoggingBatch()	Tests for the availability of a logging batch service.
boolean	supportsLogHierarchy()	Tests for the availability of a log hierarchy traversal service.
boolean	supportsLogHierarchyDesign()	Tests for the availability of a log hierarchy design service.
boolean	supportsLogLookup()	Tests for the availability of a log lookup service.
boolean	supportsLogNotification()	Tests for the availability of a log notification service.
boolean	supportsLogQuery()	Tests if querying logs is available.
boolean	supportsLogRecordType(Type logRecordType)	Tests if the given Log record type is supported.
boolean	supportsLogSearch()	Tests if searching for logs is available.
boolean	supportsLogSearchRecordType(Type logSearchRecordType)	Tests if the given log search record type is supported.
boolean	supportsPriorityType(Type priorityType)	Tests if the priority type is supported.
boolean	supportsVisibleFederation()	Tests if visible federation is supported.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getLoggingSession

LoggingSession getLoggingSession(Proxy proxy)
                          throws OperationFailedException

Gets the OsidSession associated with the logging service.

Parameters:

proxy - a proxy

Returns:

a LoggingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogging() is false

Compliance:

optional - This method must be implemented if {@code supportsLogging()} is {@code true} .

getLoggingSessionForLog

LoggingSession getLoggingSessionForLog(Id logId,
 Proxy proxy)
                                throws NotFoundException,
OperationFailedException

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

Parameters:

logId - the Id of the Log

proxy - a proxy

Returns:

a LoggingSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogging() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogging()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntryLookupSession

LogEntryLookupSession getLogEntryLookupSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the logging reading service.

Parameters:

proxy - a proxy

Returns:

a LogEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryLookup()} is {@code true} .

getLogEntryLookupSessionForLog

LogEntryLookupSession getLogEntryLookupSessionForLog(Id logId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

logId - the Id of the Log

proxy - a proxy

Returns:

a LogEntryLookupSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryLookup()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntryQuerySession

LogEntryQuerySession getLogEntryQuerySession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the logging entry query service.

Parameters:

proxy - a proxy

Returns:

a LogEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryQuery()} is {@code true} .

getLogEntryQuerySessionForLog

LogEntryQuerySession getLogEntryQuerySessionForLog(Id logId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

logId - the Id of the Log

proxy - a proxy

Returns:

a LogEntryQuerySession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryQuery()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntrySearchSession

LogEntrySearchSession getLogEntrySearchSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the logging entry search service.

Parameters:

proxy - a proxy

Returns:

a LogEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntrySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntrySearch()} is {@code true} .

getLogEntrySearchSessionForLog

LogEntrySearchSession getLogEntrySearchSessionForLog(Id logId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

logId - the Id of the Log

proxy - a proxy

Returns:

a LogEntrySearchSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntrySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntrySearch()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntryAdminSession

LogEntryAdminSession getLogEntryAdminSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the logging entry administrative service.

Parameters:

proxy - a proxy

Returns:

a LogEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryAdmin()} is {@code true} .

getLogEntryAdminSessionForLog

LogEntryAdminSession getLogEntryAdminSessionForLog(Id logId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

logId - the Id of the Log

proxy - a proxy

Returns:

a LogEntryAdminSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntryNotificationSession

LogEntryNotificationSession getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the logging entry notification service.

Parameters:

logEntryReceiver - the receiver

proxy - a proxy

Returns:

a LogEntryNotificationSession

Throws:

NullArgumentException - logEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryNotification()} is {@code true} .

getLogEntryNotificationSessionForLog

LogEntryNotificationSession getLogEntryNotificationSessionForLog(LogEntryReceiver logEntryReceiver,
 Id logId,
 Proxy proxy)
                                                          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

proxy - a proxy

Returns:

a LogEntryNotificationSession

Throws:

NotFoundException - no Log found by the given Id

NullArgumentException - logEntryReceiver, logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryNotification()} and {@code supportsVisibleFederation()} are {@code true}

getLogEntryLogSession

LogEntryLogSession getLogEntryLogSession(Proxy proxy)
                                  throws OperationFailedException

Gets the session for retrieving log entry to log mappings.

Parameters:

proxy - a proxy

Returns:

a LogEntryLogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLog() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryLog()} is {@code true} .

getLogEntryLogAssignmentSession

LogEntryLogAssignmentSession getLogEntryLogAssignmentSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the session for assigning log entry to log mappings.

Parameters:

proxy - a proxy

Returns:

a LogEntryLogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntryLogAssignment()} is {@code true} .

getLogEntrySmartLogSession

LogEntrySmartLogSession getLogEntrySmartLogSession(Id logId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic log entry logs.

Parameters:

logId - the Id of the log

proxy - a proxy

Returns:

a LogEntrySmartLogSession

Throws:

NotFoundException - logId not found

NullArgumentException - logId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntrySmartLog() is false

Compliance:

optional - This method must be implemented if {@code supportsLogEntrySmartLog()} is {@code true} .

getLogLookupSession

LogLookupSession getLogLookupSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the log lookup service.

Parameters:

proxy - a proxy

Returns:

a LogLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsLogLookup()} is {@code true} .

getLogQuerySession

LogQuerySession getLogQuerySession(Proxy proxy)
                            throws OperationFailedException

Gets the OsidSession associated with the log query service.

Parameters:

proxy - a proxy

Returns:

a LogQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLogQuery()} is {@code true} .

getLogSearchSession

LogSearchSession getLogSearchSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the log search service.

Parameters:

proxy - a proxy

Returns:

a LogSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsLogSearch()} is {@code true} .

getLogAdminSession

LogAdminSession getLogAdminSession(Proxy proxy)
                            throws OperationFailedException

Gets the OsidSession associated with the log administrative service.

Parameters:

proxy - a proxy

Returns:

a LogAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLogAdmin()} is {@code true} .

getLogNotificationSession

LogNotificationSession getLogNotificationSession(LogReceiver logReceiver,
 Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the log notification service.

Parameters:

logReceiver - the receiver

proxy - a proxy

Returns:

a LogNotificationSession

Throws:

NullArgumentException - logReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsLogNotification()} is {@code true} .

getLogHierarchySession

LogHierarchySession getLogHierarchySession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the log hierarchy service.

Parameters:

proxy - a proxy

Returns:

a LogHierarchySession for logs

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsLogHierarchy()} is {@code true} .

getLogHierarchyDesignSession

LogHierarchyDesignSession getLogHierarchyDesignSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the log hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for logs

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsLogHierarchyDesign()} is {@code true} .

getLoggingBatchProxyManager

LoggingBatchProxyManager getLoggingBatchProxyManager()
                                              throws OperationFailedException

Gets a LoggingBatchProxyManager .

Returns:

a LoggingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLoggingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsLoggingBatch()} is {@code true} .