com.yahoo.elide.core.audit

Class LogMessageImpl

java.lang.Object

com.yahoo.elide.core.audit.LogMessageImpl

All Implemented Interfaces:

LogMessage

public class LogMessageImpl
extends Object
implements LogMessage

An audit log message that can be logged to a logger.

Constructor Summary

Constructors

Constructor and Description
LogMessageImpl(Audit audit, PersistentResource record, Optional<ChangeSpec> changeSpec) Construct a log message from an Audit annotation and the record that was updated in some way.
LogMessageImpl(String template, int code) Construct a log message that does not involve any templating.
LogMessageImpl(String template, PersistentResource record, String[] expressions, int code, Optional<ChangeSpec> changeSpec) Construct a log message.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Gets message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.elide.core.audit.LogMessage

getChangeSpec, getOperationCode, getPersistentResource, getUser

Constructor Detail

LogMessageImpl

public LogMessageImpl(String template,
                      int code)

Construct a log message that does not involve any templating.

Parameters:

template - - The unsubstituted text that will be logged.

code - - The operation code of the auditable action.

LogMessageImpl

public LogMessageImpl(Audit audit,
                      PersistentResource record,
                      Optional<ChangeSpec> changeSpec)
               throws InvalidSyntaxException

Construct a log message from an Audit annotation and the record that was updated in some way.

Parameters:

audit - - The annotation containing the type of operation (UPDATE, DELETE, CREATE)

record - - The modified record

changeSpec - - Change spec of modified elements (if logging object change). empty otherwise

Throws:

InvalidSyntaxException - if the Audit annotation has invalid syntax.

LogMessageImpl

public LogMessageImpl(String template,
                      PersistentResource record,
                      String[] expressions,
                      int code,
                      Optional<ChangeSpec> changeSpec)
               throws InvalidSyntaxException

Construct a log message.

Parameters:

template - - The log message template that requires variable substitution.

record - - The record which will serve as the data to substitute.

expressions - - A set of UEL expressions that reference record.

code - - The operation code of the auditable action.

changeSpec - - the change spec that we want to log

Throws:

InvalidSyntaxException - the invalid syntax exception

Method Detail

getMessage

public String getMessage()

Description copied from interface: LogMessage

Gets message.

Specified by:

getMessage in interface LogMessage

Returns:

the message