Class AuditMessage
java.lang.Object
com.aquima.interactions.foundation.logging.audit.impl.AuditMessage
- All Implemented Interfaces:
IAuditMessage
,Serializable
- Direct Known Subclasses:
DocumentAuditMessage
,MailAuditMessage
,TaskExecutionAuditMessage
,WebServiceAuditMessage
- See Also:
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionAuditMessage
(AuditMessage.EventType eventType, DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addContext
(String key, String value) addQuotesToValues
(Set<String> auditValues) Returns the id of the case in which the audit message occurs, when the message was not created in a case context the case id can be null.Returns context for this audit message, e.g. properties, parameters, response code, web service URL, aggregate version, etc.Returns the event type for which the audit message was registered, e.g.Returns the source id which can be used to identify the source with, e.g. name of the used webservice.Returns the source type for which the audit message was registered, e.g.Returns the id of the task in which the audit message occurs, when the message was not created in a case context the task id can be null.Returns the task name in which the audit message occurs, when the message was not created in a task context the task name can be null.void
void
setContext
(Map<String, String> context) void
setEventType
(String eventType) void
setSourceId
(String sourceId) void
setSourceType
(String sourceType) void
void
setTaskName
(String taskName)
-
Constructor Details
-
AuditMessage
public AuditMessage() -
AuditMessage
public AuditMessage(AuditMessage.EventType eventType, DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId)
-
-
Method Details
-
getEventType
Description copied from interface:IAuditMessage
Returns the event type for which the audit message was registered, e.g. Create, Read, Update, Delete, Search. The implementer of this interface can define their own event types or use existing ones already defined on:AuditMessage.EventType
- Specified by:
getEventType
in interfaceIAuditMessage
- Returns:
- The event type, cannot be null.
-
setEventType
-
getCaseId
Description copied from interface:IAuditMessage
Returns the id of the case in which the audit message occurs, when the message was not created in a case context the case id can be null. The implementer of this interface is supposed to get the case id from the profile and set it on their implementation of this interface.- Specified by:
getCaseId
in interfaceIAuditMessage
- Returns:
- The case id, can be null.
-
setCaseId
-
getTaskName
Description copied from interface:IAuditMessage
Returns the task name in which the audit message occurs, when the message was not created in a task context the task name can be null. The implementer of this interface is supposed to get the task name from the profile and set it on their implementation of this interface.- Specified by:
getTaskName
in interfaceIAuditMessage
- Returns:
- The task name, can be null.
-
setTaskName
-
getTaskId
Description copied from interface:IAuditMessage
Returns the id of the task in which the audit message occurs, when the message was not created in a case context the task id can be null. The implementer of this interface is supposed to get the task id from the profile and set it on their implementation of this interface.- Specified by:
getTaskId
in interfaceIAuditMessage
- Returns:
- The task id, can be null.
-
setTaskId
-
getSourceType
Description copied from interface:IAuditMessage
Returns the source type for which the audit message was registered, e.g. Rest_Service_Call, DCM_TaskList. The source type can be anything the implementer wishes to be.- Specified by:
getSourceType
in interfaceIAuditMessage
- Returns:
- The source type, cannot be null.
-
setSourceType
-
getSourceId
Description copied from interface:IAuditMessage
Returns the source id which can be used to identify the source with, e.g. name of the used webservice.- Specified by:
getSourceId
in interfaceIAuditMessage
- Returns:
- The source id, cannot be null.
-
setSourceId
-
getContext
Description copied from interface:IAuditMessage
Returns context for this audit message, e.g. properties, parameters, response code, web service URL, aggregate version, etc. Any arbitrary string key on string value can be set here as extra context data.- Specified by:
getContext
in interfaceIAuditMessage
- Returns:
- The context, can be null.
-
setContext
-
addContext
-
addQuotesToValues
-