com.adobe.livecycle.rca
Interface Auditor

public interface Auditor

Method Summary

void	audit(String auditedBy, String moduleName, String auditLevel, String actionName, Map auditAttributes) Audits actionName.
void	auditWithDefaultLevel(String auditedBy, String moduleName, String actionName, Map auditAttributes) Audits actionName.
void	registerModule(String moduleName, AuditModuleTO auditModule) Registers an audit module.
void	removeModule(String moduleName)
void	resetModule(String moduleName, AuditModuleTO auditmodule) Resets already registered audit module with new audit module.
AuditModuleTO	retrieveAuditModule(String moduleName) Retrieves Audit Configuration document for a moduleName.

Method Detail

registerModule

void registerModule(String moduleName,
                    AuditModuleTO auditModule)
                    throws ICRException

Registers an audit module. This audit configuration provided will be persisted and Audit Service will refer to persisted configuration by module name.

Parameters:

moduleName - Name of the audit module. (Required Parameter)

auditModule - Audit Configuration document. (Required Parameter)

Throws:

SAException - - If an audit module with moduleName is already registered with AuditManager

ICRException

resetModule

void resetModule(String moduleName,
                 AuditModuleTO auditmodule)
                 throws ICRException

Resets already registered audit module with new audit module. This audit configuration provided will be persisted and Audit Service will refer to persisted configuration by module name.

Parameters:

moduleName - Name of the audit module. (Required Parameter)

auditmodule - Audit Configuration document. (Required Parameter)

Throws:

ICRException - - If there is no audit module with name moduleName already registered with Audit Service

removeModule

void removeModule(String moduleName)
                  throws PersistenceException

Throws:

PersistenceException

retrieveAuditModule

AuditModuleTO retrieveAuditModule(String moduleName)
                                  throws PersistenceException

Retrieves Audit Configuration document for a moduleName.

Parameters:

moduleName - Name of the audit module. (Required Parameter)

Returns:

audit configuration document.

Throws:

PersistenceException

audit

void audit(String auditedBy,
           String moduleName,
           String auditLevel,
           String actionName,
           Map auditAttributes)
           throws ICRException

Audits actionName. This api persists the auditAttributes along with other information provided depending on auditLevel defined in audit configuration registered with Audit Service by name moduleName.

Parameters:

auditedBy - Id of the actor auditing the action. (Required Parameter)

moduleName - Name of the audit module. (Required Parameter)

auditLevel - Audit level as defined in audit configuration. (Required Parameter)

actionName - Name of the action to be audited defined in audit module configuration. (Required Parameter)

auditAttributes - Map of attributes that need to be audited. (Required Parameter)

Throws:

ICRException - - If no module is registered by moduleName Or if no action is defined by actionName in audit module configuration

auditWithDefaultLevel

void auditWithDefaultLevel(String auditedBy,
                           String moduleName,
                           String actionName,
                           Map auditAttributes)
                           throws ICRException

Audits actionName. This api persists the auditAttributes along with other information provided depending on default audit level defined in audit configuration registered with Audit Service by name moduleName.

Parameters:

auditedBy - Id of the actor auditing the action. (Required Parameter)

moduleName - Name of the audit module. (Required Parameter)

actionName - Name of the action to be audited defined in audit module configuration. (Required Parameter)

auditAttributes - Map of attributes that need to be audited. (Required Parameter)

Throws:

ICRException - - If no module is registered by moduleName Or if no action is defined by actionName in audit module configuration