com.sap.cds.repackaged.audit.api.TransactionalAuditLogMessage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cds-feature-auditlog-v2 Show documentation

Handler to send auditlog messages to AuditLog Service V2

There is a newer version: 3.2.0

Show newest version

package com.sap.cds.repackaged.audit.api;

import com.sap.cds.repackaged.audit.api.exception.AuditLogNotAvailableException;
import com.sap.cds.repackaged.audit.api.exception.AuditLogWriteException;

/**
 * This interface provides some transactional logic to the ConfigurationChangeAuditMessage.
 * It allows to clearly indicate whether the audit log event initiated in a previous step has been successful or not.
 */
public interface TransactionalAuditLogMessage extends AuditLogMessage {
	
	/**
	 * Indicates that the audit event is about to happen.
	 * 
	 * @throws AuditLogWriteException If the persistence of the audit event preparation message was unsuccessful
	 * @throws AuditLogNotAvailableException If the audit log server is not available.
	 */
	void logPrepare() throws AuditLogNotAvailableException, AuditLogWriteException;
	
	/**
	 * Indicates that the audit event has been successful.
	 * 
	 * @throws AuditLogWriteException If the persistence of the audit event success message was unsuccessful.
	 * @throws AuditLogNotAvailableException If the audit log server is not available.
	 */
	void logSuccess() throws AuditLogNotAvailableException, AuditLogWriteException;
	
	/**
	 * Indicates that the audit event has failed.
	 * 
	 * @throws AuditLogWriteException If the persistence of the audit event failure message was unsuccessful
	 * @throws AuditLogNotAvailableException If the audit log server is not available.
	 */
	void logFailure() throws AuditLogNotAvailableException, AuditLogWriteException;
}