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.
Modifier and Type | Method and 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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the logging
service.proxy
- a proxy LoggingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogging()
is false
optional
- This method must be implemented if
supportsLogging()
is true.
LoggingSession getLoggingSessionForLog(Id logId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the logging
service for the given log.logId
- the Id
of the Log
proxy
- a proxy LoggingSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the logging
reading service.proxy
- a proxy LogEntryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryLookup()
is false
optional
- This method must be implemented if
supportsLogEntryLookup()
is true.
LogEntryLookupSession getLogEntryLookupSessionForLog(Id logId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the log reading
service for the given log.logId
- the Id
of the Log
proxy
- a proxy LogEntryLookupSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the logging entry
query service.proxy
- a proxy LogEntryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryQuery()
is false
optional
- This method must be implemented if
supportsLogEntryQuery()
is true.
LogEntryQuerySession getLogEntryQuerySessionForLog(Id logId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
query service for the given log.logId
- the Id
of the Log
proxy
- a proxy LogEntryQuerySession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the logging entry
search service.proxy
- a proxy LogEntrySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntrySearch()
is false
optional
- This method must be implemented if
supportsLogEntrySearch()
is true.
LogEntrySearchSession getLogEntrySearchSessionForLog(Id logId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
search service for the given log.logId
- the Id
of the Log
proxy
- a proxy LogEntrySearchSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the logging entry
administrative service.proxy
- a proxy LogEntryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryAdmin()
is false
optional
- This method must be implemented if
supportsLogEntryAdmin()
is true.
LogEntryAdminSession getLogEntryAdminSessionForLog(Id logId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
administrative service for the given log.logId
- the Id
of the Log
proxy
- a proxy LogEntryAdminSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the logging entry
notification service.logEntryReceiver
- the receiverproxy
- a proxy LogEntryNotificationSession
NullArgumentException
- logEntryReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the log entry
notification service for the given log.logEntryReceiver
- the receiverlogId
- the Id
of the Log
proxy
- a proxy LogEntryNotificationSession
NotFoundException
- no Log
found by the
given Id
NullArgumentException
- logEntryReceiver, logId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy LogEntryLogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogEntryLog()
is false
optional
- This method must be implemented if
supportsLogEntryLog()
is true.
LogEntryLogAssignmentSession getLogEntryLogAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy LogEntryLogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntryLogAssignment()
is false
optional
- This method must be implemented if
supportsLogEntryLogAssignment()
is true.
LogEntrySmartLogSession getLogEntrySmartLogSession(Id logId, Proxy proxy) throws NotFoundException, OperationFailedException
logId
- the Id
of the logproxy
- a proxy LogEntrySmartLogSession
NotFoundException
- logId
not foundNullArgumentException
- logId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogEntrySmartLog()
is false
optional
- This method must be implemented if
supportsLogEntrySmartLog()
is true.
LogLookupSession getLogLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the log lookup
service.proxy
- a proxy LogLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogLookup()
is false
optional
- This method must be implemented if
supportsLogLookup()
is true.
LogQuerySession getLogQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the log query
service.proxy
- a proxy LogQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogQuery()
is false
optional
- This method must be implemented if
supportsLogQuery()
is true.
LogSearchSession getLogSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the log search
service.proxy
- a proxy LogSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogSearch()
is false
optional
- This method must be implemented if
supportsLogSearch()
is true.
LogAdminSession getLogAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the log
administrative service.proxy
- a proxy LogAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogAdmin()
is false
optional
- This method must be implemented if
supportsLogAdmin()
is true.
LogNotificationSession getLogNotificationSession(LogReceiver logReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the log
notification service.logReceiver
- the receiverproxy
- a proxy LogNotificationSession
NullArgumentException
- logReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogNotification()
is false
optional
- This method must be implemented if
supportsLogNotification()
is true.
LogHierarchySession getLogHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the log hierarchy
service.proxy
- a proxy LogHierarchySession
for logsNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLogHierarchy()
is false
optional
- This method must be implemented if
supportsLogHierarchy()
is true.
LogHierarchyDesignSession getLogHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the log hierarchy
design service.proxy
- a proxy HierarchyDesignSession
for logsNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLogHierarchyDesign()
is false
optional
- This method must be implemented if
supportsLogHierarchyDesign()
is true.
LoggingBatchProxyManager getLoggingBatchProxyManager() throws OperationFailedException
LoggingBatchProxyManager.
LoggingBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLoggingBatch()
is false
optional
- This method must be implemented if
supportsLoggingBatch()
is true.