Package de.xima.fc.audit.internal

Class AuditServiceImpl

java.lang.Object

de.xima.fc.audit.internal.AuditServiceImpl

All Implemented Interfaces:

AuditService

@ApplicationScoped
public class AuditServiceImpl
extends Object
implements AuditService

Default implementation of the AuditService. Runs on both the master and the frontend server and delegates every record overload to the correspondingly named method of the RPC handler, which executes it on the master.

Since:

8.5.6

Author:

Norman Lorenz

Method Summary

Modifier and Type	Method	Description
AuditEntryHandle	record(FormRecordAuditEntry entry, User user)	Writes an informational form-record protocol entry.
AuditEntryHandle	record(FormVersionAuditEntry entry, User user)	Writes a tenant-scoped protocol entry tied to a form version.
AuditEntryHandle	record(SystemAuditEntry entry, User user)	Writes a system protocol entry.
AuditEntryHandle	record(TenantAuditEntry entry, User user)	Writes a tenant-scoped protocol entry.

Methods inherited from class java.lang.Object

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

Method Detail

record

public AuditEntryHandle record(SystemAuditEntry entry,
                               User user)
                        throws FcAuditException

Description copied from interface: AuditService

Writes a system protocol entry.

Specified by:

record in interface AuditService

Parameters:

entry - the entry to write. Must not be null and must carry a non-blank message.

user - the acting user the entry is attributed to. Must not be null.

Returns:

a handle to the created entry.

Throws:

FcAuditException - if persistence fails.

record

public AuditEntryHandle record(TenantAuditEntry entry,
                               User user)
                        throws FcAuditException

Description copied from interface: AuditService

Writes a tenant-scoped protocol entry.

Specified by:

record in interface AuditService

Parameters:

entry - the entry to write. Must not be null and must carry a tenant UUID and a non-blank message.

user - the acting user the entry is attributed to. Must not be null.

Returns:

a handle to the created entry.

Throws:

FcAuditException - if the tenant does not exist (AuditErrorType.NOT_FOUND) or persistence fails.

record

public AuditEntryHandle record(FormVersionAuditEntry entry,
                               User user)
                        throws FcAuditException

Description copied from interface: AuditService

Writes a tenant-scoped protocol entry tied to a form version. The owning tenant is resolved from the form version.

Specified by:

record in interface AuditService

Parameters:

entry - the entry to write. Must not be null and must carry a non-blank message.

user - the acting user the entry is attributed to. Must not be null.

Returns:

a handle to the created entry.

Throws:

FcAuditException - if the form version does not exist (AuditErrorType.NOT_FOUND) or persistence fails.

record

public AuditEntryHandle record(FormRecordAuditEntry entry,
                               User user)
                        throws FcAuditException

Description copied from interface: AuditService

Writes an informational form-record protocol entry. The form record, its project and owning tenant are resolved from the entry's process id.

Specified by:

record in interface AuditService

Parameters:

entry - the entry to write. Must not be null and must carry a non-blank process id and message.

user - the acting user the entry is attributed to. Must not be null.

Returns:

a handle to the created entry.

Throws:

FcAuditException - if no form record exists for the process id (AuditErrorType.NOT_FOUND) or persistence fails.