org.adroitlogic.ultraesb.api.mediation

Interface AuditSupport

public interface AuditSupport

Since:

1.8.0

Author:

Ruwan Linton

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuditSupport.AuditMode This enumeration represents the mode at which a particular audit log should be generated.
static class	AuditSupport.AuditSeverity This enumeration represents the severity of the audit log.
static class	AuditSupport.AuditType

Method Summary

Methods

Modifier and Type	Method and Description
void	auditLog(Message msg) Audit log the given message with the AuditSupport.AuditMode.COMPLETE
void	auditLog(Message msg, AuditSupport.AuditMode mode) Audit log the given message with the given audit mode
void	auditLog(Message msg, AuditSupport.AuditMode mode, Map<String,String> properties) Audit log the given message with the given audit mode, including the given additional properties.
void	auditLog(Message msg, AuditSupport.AuditSeverity auditSeverity, String auditDescription) Audit log the given audit message with the given audit severity.
void	auditLog(Message msg, String tag) Audit log the given message with the AuditSupport.AuditMode.COMPLETE with the given tag
void	auditLog(Message msg, String tag, AuditSupport.AuditMode mode) Audit log the given message with the given audit mode, and the tag
void	auditLog(Message msg, String subject, AuditSupport.AuditMode mode, Map<String,String> properties) Audit log the given message with the given audit mode, including the given additional properties.
void	auditLog(Message msg, String tag, String subject, AuditSupport.AuditMode mode, AuditSupport.AuditType type, String auditDescription, AuditSupport.AuditSeverity auditSeverity, String projectName, String username, Map<String,String> properties) Audit log the given message with the given message including tag, subject, mode, type, audit description, severity, project id and properties.
void	auditLog(Message msg, String tag, String subject, AuditSupport.AuditMode mode, Map<String,String> properties) Audit log the given message with the given audit mode, including the given additional properties and the tag.

Method Detail

auditLog

void auditLog(Message msg)

Audit log the given message with the AuditSupport.AuditMode.COMPLETE

Parameters:

msg - the message being audit logged

auditLog

void auditLog(Message msg,
            String tag)

Audit log the given message with the AuditSupport.AuditMode.COMPLETE with the given tag

Parameters:

msg - the message being audit logged

tag - the tag for this audit log

auditLog

void auditLog(Message msg,
            AuditSupport.AuditMode mode)

Audit log the given message with the given audit mode

Parameters:

msg - the message being audit logged

mode - the audit mode at which this message is logged

auditLog

void auditLog(Message msg,
            String tag,
            AuditSupport.AuditMode mode)

Audit log the given message with the given audit mode, and the tag

Parameters:

msg - the message being audit logged

tag - the tag to be associated with this audit log

mode - the audit mode at which this message is logged

auditLog

void auditLog(Message msg,
            AuditSupport.AuditMode mode,
            Map<String,String> properties)

Audit log the given message with the given audit mode, including the given additional properties. Given that the properties is not null the method always persists to the properties

Parameters:

msg - the message being audit logged

mode - the audit mode at which this message is logged

properties - additional properties to be logged

auditLog

void auditLog(Message msg,
            String subject,
            AuditSupport.AuditMode mode,
            Map<String,String> properties)

Audit log the given message with the given audit mode, including the given additional properties. Given that the properties is not null the method always persists to the properties

Parameters:

msg - the message being audit logged

subject - authentication subject such as user or any other subject related to the message

mode - the audit mode at which this message is logged

properties - additional properties to be logged

auditLog

void auditLog(Message msg,
            String tag,
            String subject,
            AuditSupport.AuditMode mode,
            Map<String,String> properties)

Audit log the given message with the given audit mode, including the given additional properties and the tag. Given that the properties is not null the method always persists to the properties

Parameters:

msg - the message being audit logged

tag - the tag to be associated with this audit log

subject - authentication subject such as user or any other subject related to the message

mode - the audit mode at which this message is logged

properties - additional properties to be logged

auditLog

void auditLog(Message msg,
            AuditSupport.AuditSeverity auditSeverity,
            String auditDescription)

Audit log the given audit message with the given audit severity.

Parameters:

msg - the message being audit logged

auditSeverity - the severity of the audit log

auditDescription - the description to be logged with the audit message.

auditLog

void auditLog(Message msg,
            String tag,
            String subject,
            AuditSupport.AuditMode mode,
            AuditSupport.AuditType type,
            String auditDescription,
            AuditSupport.AuditSeverity auditSeverity,
            String projectName,
            String username,
            Map<String,String> properties)

Audit log the given message with the given message including tag, subject, mode, type, audit description, severity, project id and properties. Given that the properties is not null the method always persists to the properties

Parameters:

msg - the message being audit logged

tag - the tag to be associated with this audit log

subject - authentication subject such as user or any other subject related to the message

mode - the audit mode at which this message is logged

type - type of the audit log (e.g: proxy audit log, sequence audit log, user audit log, server audit log, etc.)

auditDescription - the description to be logged with the audit message.

auditSeverity - the severity of the audit log

projectName - the name of the project for the audit log

username - Person who is responsible for the generation of the audit log

properties - additional properties to be logged