Package com.aquima.interactions.foundation.logging.audit.impl

Class DocumentAuditMessage

java.lang.Object

com.aquima.interactions.foundation.logging.audit.impl.AuditMessage

com.aquima.interactions.foundation.logging.audit.impl.DocumentAuditMessage

All Implemented Interfaces:

IAuditMessage, Serializable

public final class DocumentAuditMessage
extends AuditMessage

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.aquima.interactions.foundation.logging.audit.impl.AuditMessage

AuditMessage.EventType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_AUTHORIZED
static final String	PROPERTY_CONNECTION_NAME
static final String	PROPERTY_FILE_ID
static final String	PROPERTY_FILE_IDS
static final String	PROPERTY_FILE_NAME
static final String	PROPERTY_NEW_CONNECTION_NAME
static final String	PROPERTY_NEW_FILE_ID
static final String	PROPERTY_SUCCESSFUL

Method Summary

Modifier and Type	Method	Description
static DocumentAuditMessage	forDelete(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String caseId, String connectionName, String fileId, boolean unauthorized)	This method returns a new DocumentAuditMessage when the AQ_File_Delete service is called.
static DocumentAuditMessage	forDownload(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String connectionName, String fileId, boolean authorized)	This method returns a new DocumentAuditMessage when the AQ_File_Download container is called.
static IAuditMessage	forDownloadRender(DcmAuditProperties dcmAuditProperties, String sourceId, String fileName)	This method returns a new DocumentAuditMessage when the DocumentService renderDocument service is called.
static IAuditMessage	forGenerate(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String caseId, String connectionName, String fileId)	This method returns a new DocumentAuditMessage when the AQ_Document_Generate service is called.
static DocumentAuditMessage	forMetaDataRead(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String caseId, String connectionName, String fileId, boolean unauthorized)	This method returns a new DocumentAuditMessage when the AQ_File_GetMetaData service is called.
static DocumentAuditMessage	forMetaDataUpdate(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String caseId, String connectionName, String fileId, boolean unauthorized)	This method returns a new DocumentAuditMessage when the AQ_File_UpdateMetaData service is called.
static DocumentAuditMessage	forMove(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String caseId, String connectionName, String newConnectionName, String fileId, String newFileId, boolean unauthorized)	This method returns a new DocumentAuditMessage when the AQ_File_Move service is called.
static IAuditMessage	forRenderer(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String fileName)	This method returns a new DocumentAuditMessage when the AQ_Document_Renderer service is called.
static DocumentAuditMessage	forUpload(DcmAuditProperties dcmAuditProperties, String sourceType, String sourceId, String caseId, String connectionName, List<String> fileIds, boolean uploadAuthorized, boolean uploadSuccessful)	This method returns a new DocumentAuditMessage when the AQ_File_Upload container is called.

Methods inherited from class com.aquima.interactions.foundation.logging.audit.impl.AuditMessage

addContext, getCaseId, getContext, getEventType, getProcessName, getSourceId, getSourceType, getTaskId, getTaskName, setCaseId, setContext, setEventType, setProcessName, setSourceId, setSourceType, setTaskId, setTaskName

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_CONNECTION_NAME

public static final String PROPERTY_CONNECTION_NAME

See Also:

• Constant Field Values

PROPERTY_NEW_CONNECTION_NAME

public static final String PROPERTY_NEW_CONNECTION_NAME

See Also:

• Constant Field Values

PROPERTY_FILE_ID

public static final String PROPERTY_FILE_ID

See Also:

• Constant Field Values

PROPERTY_FILE_NAME

public static final String PROPERTY_FILE_NAME

See Also:

• Constant Field Values

PROPERTY_NEW_FILE_ID

public static final String PROPERTY_NEW_FILE_ID

See Also:

• Constant Field Values

PROPERTY_FILE_IDS

public static final String PROPERTY_FILE_IDS

See Also:

• Constant Field Values

PROPERTY_AUTHORIZED

public static final String PROPERTY_AUTHORIZED

See Also:

• Constant Field Values

PROPERTY_SUCCESSFUL

public static final String PROPERTY_SUCCESSFUL

See Also:

• Constant Field Values

Method Details

forDownload

public static DocumentAuditMessage forDownload(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String connectionName,
 String fileId,
 boolean authorized)

This method returns a new DocumentAuditMessage when the AQ_File_Download container is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_File_Download.

sourceId - SourceId. e.g. DownloadCaseDocument.

connectionName - Name of the used connection.

fileId - ID of the file.

authorized - download was authorized.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forUpload

public static DocumentAuditMessage forUpload(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String caseId,
 String connectionName,
 List<String> fileIds,
 boolean uploadAuthorized,
 boolean uploadSuccessful)

This method returns a new DocumentAuditMessage when the AQ_File_Upload container is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_File_Upload.

sourceId - SourceId. e.g. UploadCaseDocument.

caseId - ID of the case.

connectionName - Name of the used connection.

fileIds - Ids of the uploaded files.

uploadAuthorized - upload was authorized.

uploadSuccessful - upload was successful.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forMetaDataUpdate

public static DocumentAuditMessage forMetaDataUpdate(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String caseId,
 String connectionName,
 String fileId,
 boolean unauthorized)

This method returns a new DocumentAuditMessage when the AQ_File_UpdateMetaData service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_File_UpdateMetaData.

sourceId - SourceId. e.g. updateDocumentMetadata.

caseId - ID of the case.

connectionName - Name of the used connection.

fileId - ID of the file.

unauthorized - updating metadata was authorized.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forMetaDataRead

public static DocumentAuditMessage forMetaDataRead(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String caseId,
 String connectionName,
 String fileId,
 boolean unauthorized)

This method returns a new DocumentAuditMessage when the AQ_File_GetMetaData service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_File_GetMetaData.

sourceId - SourceId. e.g. getDocumentMetadata.

caseId - ID of the case.

connectionName - Name of the used connection.

fileId - ID of the file.

unauthorized - reading metadata was authorized.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forDelete

public static DocumentAuditMessage forDelete(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String caseId,
 String connectionName,
 String fileId,
 boolean unauthorized)

This method returns a new DocumentAuditMessage when the AQ_File_Delete service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_File_Delete.

sourceId - SourceId. e.g. deleteDocument.

caseId - ID of the case.

connectionName - Name of the used connection.

fileId - ID of the file.

unauthorized - deletion was authorized.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forMove

public static DocumentAuditMessage forMove(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String caseId,
 String connectionName,
 String newConnectionName,
 String fileId,
 String newFileId,
 boolean unauthorized)

This method returns a new DocumentAuditMessage when the AQ_File_Move service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_File_Move.

sourceId - SourceId. e.g. moveDocument.

caseId - ID of the case.

connectionName - Name of the used connection.

newConnectionName - Name of the connection where the file is moved to.

fileId - ID of the file.

newFileId - ID of the moved file.

unauthorized - deletion was authorized.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forGenerate

public static IAuditMessage forGenerate(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String caseId,
 String connectionName,
 String fileId)

This method returns a new DocumentAuditMessage when the AQ_Document_Generate service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_Document_Generate.

sourceId - SourceId. e.g. generateDocument.

caseId - ID of the case.

connectionName - Name of the used connection.

fileId - ID of the file.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forRenderer

public static IAuditMessage forRenderer(DcmAuditProperties dcmAuditProperties,
 String sourceType,
 String sourceId,
 String fileName)

This method returns a new DocumentAuditMessage when the AQ_Document_Renderer service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceType - SourceType, e.g. AQ_Document_Renderer.

sourceId - SourceId. e.g. renderDocument.

fileName - Name of the rendered File.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.

forDownloadRender

public static IAuditMessage forDownloadRender(DcmAuditProperties dcmAuditProperties,
 String sourceId,
 String fileName)

This method returns a new DocumentAuditMessage when the DocumentService renderDocument service is called.

Parameters:

dcmAuditProperties - Dcm Audit properties which contains caseid, taskid, taskname and processname.

sourceId - SourceId. e.g. page, document.

fileName - Name of the rendered File.

Returns:

DocumentAuditMessage object which contains all the information for audit logging.