io.committed.invest.plugin.server.audit.services

Interface AuditService

All Known Implementing Classes:

NoAuditService, Slf4jAuditService

public interface AuditService

An interface which all audit services must implement.

Method Summary

Modifier and Type	Method and Description
void	audit(String user, String action, String message, Object params) Log the audit message.
boolean	isLogging() Checks if is audit service is logging.

Method Detail

audit

void audit(String user,
           String action,
           String message,
           Object params)

Log the audit message.

Parameters:

user - the user (may be null if non-auth)

action - an action represneting the action which is being perform

message - the descriptive message (or null)

params - the params any parameters (typically variables passed, or response codes)

isLogging

boolean isLogging()

Checks if is audit service is logging.

If not then audit() will not be called (and other work will not be done).

Most implementation will have this fixed (to true), but it is called each time an audit message may be generated, so it can change dynamically.

Returns:

true, if is logging