Package ubic.gemma.persistence.service.common.auditAndSecurity

Interface AuditTrailService

All Superinterfaces:

BaseImmutableService<AuditTrail>, BaseReadOnlyService<AuditTrail>

All Known Implementing Classes:

AuditTrailServiceImpl

public interface AuditTrailService
extends BaseImmutableService<AuditTrail>

Create and manipulate audit trails.

This service is mainly intended to create audit events manually. Part of the auditing is done automatically using aspects via AuditAdvice.

Author:

kelsey

Method Summary

Modifier and Type	Method	Description
AuditEvent	addUpdateEvent(Auditable auditable, Class<? extends AuditEventType> type, String note)
AuditEvent	addUpdateEvent(Auditable auditable, Class<? extends AuditEventType> type, String note, String detail)
AuditEvent	addUpdateEvent(Auditable auditable, Class<? extends AuditEventType> type, String note, String detail, Date performedDate)	Add an update audit event of a specific type to the passed auditable entity.
AuditEvent	addUpdateEvent(Auditable auditable, Class<? extends AuditEventType> type, String note, Throwable throwable)	Add an update audit event with an exception.
AuditEvent	addUpdateEvent(Auditable auditable, String note)	Add an update event defined by the given parameters, to the given auditable.
AuditTrail	create(AuditTrail auditTrail)	Creates the given entity in the persistent storage.

Methods inherited from interface ubic.gemma.persistence.service.BaseImmutableService

create, findOrCreate, remove, remove, remove

Methods inherited from interface ubic.gemma.persistence.service.BaseReadOnlyService

countAll, find, findOrFail, getElementClass, load, load, loadAll, loadOrFail, loadOrFail, loadOrFail, loadOrFail

Method Detail

addUpdateEvent

@Secured("GROUP_AGENT")
AuditEvent addUpdateEvent(Auditable auditable,
                          String note)

Add an update event defined by the given parameters, to the given auditable. Returns the generated event.

Parameters:

auditable - the entity

note - a short note (optional)

Returns:

the newly created event, which will be somewhere in the auditable's AuditTrail.getEvents() collection.

addUpdateEvent

@Secured("GROUP_AGENT")
AuditEvent addUpdateEvent(Auditable auditable,
                          Class<? extends AuditEventType> type,
                          String note)

See Also:

addUpdateEvent(Auditable, Class, String, String, Date)

addUpdateEvent

@Secured("GROUP_AGENT")
AuditEvent addUpdateEvent(Auditable auditable,
                          Class<? extends AuditEventType> type,
                          @Nullable
                          String note,
                          String detail)

See Also:

addUpdateEvent(Auditable, Class, String, String, Date)

addUpdateEvent

@Secured("GROUP_AGENT")
AuditEvent addUpdateEvent(Auditable auditable,
                          Class<? extends AuditEventType> type,
                          @Nullable
                          String note,
                          Throwable throwable)

Add an update audit event with an exception.

Unlike addUpdateEvent(Auditable, Class, String, String, Date), the audit event produced by this method cannot be rolled back, so you may freely raise the exception. This is achieved by using Propagation.REQUIRES_NEW.

See Also:

addUpdateEvent(Auditable, Class, String, String, Date)

addUpdateEvent

@Secured("GROUP_AGENT")
AuditEvent addUpdateEvent(Auditable auditable,
                          Class<? extends AuditEventType> type,
                          @Nullable
                          String note,
                          @Nullable
                          String detail,
                          Date performedDate)

Add an update audit event of a specific type to the passed auditable entity.

Parameters:

auditable - the entity being audited

type - the audit event type

note - a short note (optional)

detail - full details for that event

performedDate - the moment the audit was performed (must not be in the future!)

Returns:

the newly created event, which will be somewhere in the auditable's AuditTrail.getEvents() collection.

create

@Secured("GROUP_USER")
AuditTrail create(AuditTrail auditTrail)

Description copied from interface: BaseImmutableService

Creates the given entity in the persistent storage.

Specified by:

create in interface BaseImmutableService<AuditTrail>

Parameters:

auditTrail - the entity to be created.

Returns:

object referencing the persistent instance of the given entity.