org.kuali.student.core.logging.service

Class LoggingServiceMapImpl

java.lang.Object

org.kuali.student.core.logging.service.LoggingServiceMapImpl

All Implemented Interfaces:

MockService, LoggingService

public class LoggingServiceMapImpl
extends Object
implements MockService, LoggingService

Constructor Summary

Constructors

Constructor and Description
LoggingServiceMapImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all cached service data.
LogInfo	createLog(String key, String logTypeKey, LogInfo logInfo, ContextInfo contextInfo) Creates a new Log.
LogEntryInfo	createLogEntry(String logKey, String logEntryTypeKey, LogEntryInfo logEntryInfo, ContextInfo contextInfo) Creates a new Log Entry.
StatusInfo	deleteLog(String logKey, ContextInfo contextInfo) Deletes an existing Log and all it's related parts
StatusInfo	deleteLogEntry(String logEntryId, ContextInfo contextInfo) Deletes an existing Log Entry.
LogInfo	findCreateLog(String logKey, String logTypeKey, ContextInfo contextInfo) Finds/creates a log with the specified key and type.
LogInfo	getLog(String logKey, ContextInfo contextInfo) Retrieves a Log by a Log ID
List<LogEntryInfo>	getLogEntriesByIds(List<String> logEntryIds, ContextInfo contextInfo) Retrieves a list of log entries by a list of Log Entry IDs
List<LogEntryInfo>	getLogEntriesByLog(String logKey, ContextInfo contextInfo) Get log entries for a log
LogEntryInfo	getLogEntry(String logEntryId, ContextInfo contextInfo) Retrieves a Log Entry by a Log Entry ID
List<String>	getLogEntryIdsByType(String logEntryTypeKey, ContextInfo contextInfo) Retrieves a list of Log Entry Ids by log type.
List<String>	getLogKeysByType(String logTypeKey, ContextInfo contextInfo) Retrieves a list of Log Ids by log type.
List<LogInfo>	getLogsByKeys(List<String> logKeys, ContextInfo contextInfo) Retrieves a list of logs by a list of Log IDs
StatusInfo	logEntry(String logKey, String logEntryTypeKey, String levelTypeKey, String logEntry, ContextInfo contextInfo) Convenience method to log a new entry quickly.
List<LogEntryInfo>	searchForLogEntries(QueryByCriteria criteria, ContextInfo contextInfo) Searches for log entries based on the criteria and returns a list of logs which match the search criteria.
List<String>	searchForLogEntryIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Log Entry Ids based on the criteria and returns a list of Log Entry entries which match the search criteria.
List<String>	searchForLogKeys(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Log Ids based on the criteria and returns a list of Log entries which match the search criteria.
List<LogInfo>	searchForLogs(QueryByCriteria criteria, ContextInfo contextInfo) Searches for logs based on the criteria and returns a list of logs which match the search criteria.
LogInfo	updateLog(String logKey, LogInfo logInfo, ContextInfo contextInfo) Updates an existing Log.
LogEntryInfo	updateLogEntry(String logEntryId, LogEntryInfo logEntryInfo, ContextInfo contextInfo) Updates an existing Log Entry.
List<ValidationResultInfo>	validateLog(String validationTypeKey, String logTypeKey, LogInfo logInfo, ContextInfo contextInfo) Validates a Log.
List<ValidationResultInfo>	validateLogEntry(String validationTypeKey, String logEntryTypeKey, String logKey, LogEntryInfo logEntryInfo, ContextInfo contextInfo) Validates a LogEntry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoggingServiceMapImpl

public LoggingServiceMapImpl()

Method Detail

clear

public void clear()

Description copied from interface: MockService

Clear all cached service data. This should place the service back to its initial configuration.

Specified by:

clear in interface MockService

getLog

public LogInfo getLog(String logKey,
             ContextInfo contextInfo)
               throws DoesNotExistException,
                      InvalidParameterException,
                      MissingParameterException,
                      OperationFailedException,
                      PermissionDeniedException

Description copied from interface: LoggingService

Retrieves a Log by a Log ID

Specified by:

getLog in interface LoggingService

Parameters:

logKey - the Log ID

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the Log

Throws:

DoesNotExistException - logKey not found

InvalidParameterException - invalid logKey or contextInfo

MissingParameterException - logKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLogsByKeys

public List<LogInfo> getLogsByKeys(List<String> logKeys,
                          ContextInfo contextInfo)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Description copied from interface: LoggingService

Retrieves a list of logs by a list of Log IDs

Specified by:

getLogsByKeys in interface LoggingService

Parameters:

logKeys - a list of Log IDs

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of People

Throws:

DoesNotExistException - logKey not found

InvalidParameterException - invalid logKey or contextInfo

MissingParameterException - logKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLogKeysByType

public List<String> getLogKeysByType(String logTypeKey,
                            ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: LoggingService

Retrieves a list of Log Ids by log type.

Specified by:

getLogKeysByType in interface LoggingService

Parameters:

logTypeKey - the logTypeKey to search by

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of Log IDs

Throws:

DoesNotExistException - logKey not found

InvalidParameterException - invalid logKey or contextInfo

MissingParameterException - logKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLogKeys

public List<String> searchForLogKeys(QueryByCriteria criteria,
                            ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: LoggingService

Searches for Log Ids based on the criteria and returns a list of Log entries which match the search criteria.

Specified by:

searchForLogKeys in interface LoggingService

Parameters:

criteria - the search criteria

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of Log IDs

Throws:

InvalidParameterException - invalid criteria or contextInfo

MissingParameterException - logKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLogs

public List<LogInfo> searchForLogs(QueryByCriteria criteria,
                          ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Description copied from interface: LoggingService

Searches for logs based on the criteria and returns a list of logs which match the search criteria.

Specified by:

searchForLogs in interface LoggingService

Parameters:

criteria - the search criteria

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of People

Throws:

InvalidParameterException - invalid logKey or contextInfo

MissingParameterException - logKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateLog

public List<ValidationResultInfo> validateLog(String validationTypeKey,
                                     String logTypeKey,
                                     LogInfo logInfo,
                                     ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Description copied from interface: LoggingService

Validates a Log. If an entry is present for the Log and a record is found for that entry, the validation checks if the Log can be updated to the new values. If an entry is not present or a record does not exist, the validation checks if the log with the given data can be created.

Specified by:

validateLog in interface LoggingService

Parameters:

validationTypeKey - the entry for the validation Type

logTypeKey - the entry for the log type key to be validated

logInfo - the log to be validated

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey or logTypeKey is not found

InvalidParameterException - logInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, logTypeKey, logInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createLog

public LogInfo createLog(String key,
                String logTypeKey,
                LogInfo logInfo,
                ContextInfo contextInfo)
                  throws AlreadyExistsException,
                         DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException

Description copied from interface: LoggingService

Creates a new Log. The Log Id, Type, and Meta information may not be set in the supplied data.

Specified by:

createLog in interface LoggingService

Parameters:

key - to the new log

logTypeKey - the entry for the log type to be validated

logInfo - the log to be validated

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the new Log

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - logTypeKey does not exist or is not supported

InvalidParameterException - logInfo or contextInfo is not valid

MissingParameterException - logTypeKey, logInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

AlreadyExistsException

findCreateLog

public LogInfo findCreateLog(String logKey,
                    String logTypeKey,
                    ContextInfo contextInfo)
                      throws DataValidationErrorException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException,
                             ReadOnlyException

Description copied from interface: LoggingService

Finds/creates a log with the specified key and type. If created the name is set to the specified key.

Specified by:

findCreateLog in interface LoggingService

Parameters:

logKey - key to the log

logTypeKey - type of log

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the new or existing Log

Throws:

DataValidationErrorException - supplied data is invalid

InvalidParameterException - logInfo or contextInfo is not valid

MissingParameterException - logTypeKey, logInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

updateLog

public LogInfo updateLog(String logKey,
                LogInfo logInfo,
                ContextInfo contextInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException,
                         VersionMismatchException

Description copied from interface: LoggingService

Updates an existing Log. The Log Id, Type, and Meta information may not be changed.

Specified by:

updateLog in interface LoggingService

Parameters:

logKey - the entry for the Log to be updated

logInfo - the log to be validated

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the updated Log

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - logKey is not found

InvalidParameterException - logKey, logInfo or contextInfo is not valid

MissingParameterException - logKey, logInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

VersionMismatchException - if someone else has updated this log record since you fetched the version you are updating.

deleteLog

public StatusInfo deleteLog(String logKey,
                   ContextInfo contextInfo)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Description copied from interface: LoggingService

Deletes an existing Log and all it's related parts

Specified by:

deleteLog in interface LoggingService

Parameters:

logKey - the entry for the log to be deleted

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the status of the delete operation. This must always be true.

Throws:

DoesNotExistException - logInfo is not found

InvalidParameterException - logInfo or contextInfo is not valid

MissingParameterException - logInfo or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLogEntry

public LogEntryInfo getLogEntry(String logEntryId,
                       ContextInfo contextInfo)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException

Description copied from interface: LoggingService

Retrieves a Log Entry by a Log Entry ID

Specified by:

getLogEntry in interface LoggingService

Parameters:

logEntryId - the Log Entry ID

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the LogEntry

Throws:

DoesNotExistException - logEntryId not found

InvalidParameterException - invalid logEntryId or contextInfo

MissingParameterException - logEntryId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLogEntriesByIds

public List<LogEntryInfo> getLogEntriesByIds(List<String> logEntryIds,
                                    ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: LoggingService

Retrieves a list of log entries by a list of Log Entry IDs

Specified by:

getLogEntriesByIds in interface LoggingService

Parameters:

logEntryIds - a list of Log Entry IDs

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of Log Entries

Throws:

DoesNotExistException - logEntryId not found

InvalidParameterException - invalid logEntryId or contextInfo

MissingParameterException - logEntryId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLogEntryIdsByType

public List<String> getLogEntryIdsByType(String logEntryTypeKey,
                                ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: LoggingService

Retrieves a list of Log Entry Ids by log type.

Specified by:

getLogEntryIdsByType in interface LoggingService

Parameters:

logEntryTypeKey - the logEntry Type Key to search by

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of LogEntry IDs

Throws:

DoesNotExistException - logEntryTypeKey not found

InvalidParameterException - invalid logEntryTypeKey or contextInfo

MissingParameterException - logEntryTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLogEntryIds

public List<String> searchForLogEntryIds(QueryByCriteria criteria,
                                ContextInfo contextInfo)
                                  throws InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: LoggingService

Searches for Log Entry Ids based on the criteria and returns a list of Log Entry entries which match the search criteria.

Specified by:

searchForLogEntryIds in interface LoggingService

Parameters:

criteria - the search criteria

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of LogEntry IDs

Throws:

InvalidParameterException - invalid criteria or contextInfo

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLogEntries

public List<LogEntryInfo> searchForLogEntries(QueryByCriteria criteria,
                                     ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Description copied from interface: LoggingService

Searches for log entries based on the criteria and returns a list of logs which match the search criteria.

Specified by:

searchForLogEntries in interface LoggingService

Parameters:

criteria - the search criteria

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a List of Log Entries

Throws:

InvalidParameterException - invalid criteria or contextInfo

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateLogEntry

public List<ValidationResultInfo> validateLogEntry(String validationTypeKey,
                                          String logEntryTypeKey,
                                          String logKey,
                                          LogEntryInfo logEntryInfo,
                                          ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: LoggingService

Validates a LogEntry. If an entry is present for the Log Entry and a record is found for that entry, the validation checks if the LogEntry can be updated to the new values. If an entry is not present or a record does not exist, the validation checks if the log with the given data can be created.

Specified by:

validateLogEntry in interface LoggingService

Parameters:

validationTypeKey - the entry for the validation Type

logEntryTypeKey - the entry for the log entry type to be validated

logKey - id of log for whom this entry is being applied

logEntryInfo - the log to be validated

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey or logEntryTypeKey is not found

InvalidParameterException - logEntryInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, logEntryTypeKey, logEntryInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createLogEntry

public LogEntryInfo createLogEntry(String logKey,
                          String logEntryTypeKey,
                          LogEntryInfo logEntryInfo,
                          ContextInfo contextInfo)
                            throws DataValidationErrorException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   ReadOnlyException

Description copied from interface: LoggingService

Creates a new Log Entry. The Log Entry Id, Type, and Meta information may not be set in the supplied data.

Specified by:

createLogEntry in interface LoggingService

Parameters:

logKey - id of the log to whom this entry is attached

logEntryTypeKey - the entry for the log entry Type to assign to this entry object

logEntryInfo - the log to be created

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the new LogEntry

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - logEntryType does not exist or is not supported

InvalidParameterException - logInfo or contextInfo is not valid

MissingParameterException - logEntryType, logEntryInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

logEntry

public StatusInfo logEntry(String logKey,
                  String logEntryTypeKey,
                  String levelTypeKey,
                  String logEntry,
                  ContextInfo contextInfo)
                    throws DataValidationErrorException,
                           DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           ReadOnlyException

Description copied from interface: LoggingService

Convenience method to log a new entry quickly.

Specified by:

logEntry in interface LoggingService

Parameters:

logKey - of the log to whom this entry is attached

logEntryTypeKey - the entry for the log entry Type to assign to this entry object

levelTypeKey - log level type key

logEntry - the entry to be logged

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

status info

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - logEntryType does not exist or is not supported

InvalidParameterException - logInfo or contextInfo is not valid

MissingParameterException - logEntryType, logEntryInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

updateLogEntry

public LogEntryInfo updateLogEntry(String logEntryId,
                          LogEntryInfo logEntryInfo,
                          ContextInfo contextInfo)
                            throws DataValidationErrorException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   ReadOnlyException,
                                   VersionMismatchException

Description copied from interface: LoggingService

Updates an existing Log Entry. The Log Entry Id, Type, and Meta information may not be changed.

Specified by:

updateLogEntry in interface LoggingService

Parameters:

logEntryId - the entry for the LogEntry to be updated

logEntryInfo - the log to be validated

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the updated LogEntry

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - logKey is not found

InvalidParameterException - logKey, logEntryInfo or contextInfo is not valid

MissingParameterException - logKey, logEntryInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read only

VersionMismatchException - if someone else has updated this log record since you fetched the version you are updating.

deleteLogEntry

public StatusInfo deleteLogEntry(String logEntryId,
                        ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException

Description copied from interface: LoggingService

Deletes an existing Log Entry.

Specified by:

deleteLogEntry in interface LoggingService

Parameters:

logEntryId - the entry for the log entry record to be deleted

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the status of the delete operation. This must always be true.

Throws:

DoesNotExistException - logEntryId is not found

InvalidParameterException - logEntryId or contextInfo is not valid

MissingParameterException - logEntryId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLogEntriesByLog

public List<LogEntryInfo> getLogEntriesByLog(String logKey,
                                    ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: LoggingService

Get log entries for a log

Specified by:

getLogEntriesByLog in interface LoggingService

Parameters:

logKey - the entry for the log

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of entries for that log

Throws:

DoesNotExistException - logKey is not found

InvalidParameterException - logKey or contextInfo is not valid

MissingParameterException - logKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred