com.haulmont.cuba.security.app

Interface EntityLogAPI

All Known Implementing Classes:

EntityLog

public interface EntityLogAPI

Allows to log entity lifecycle events: create, modify, delete.
Configured by LoggedEntity and LoggedAttribute entities. See also EntityLogConfig configuration interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	flush() Flush records accumulated by invocations of registerCreate(Entity) and other registration methods to the database.
void	invalidateCache() Invalidates configuration cache.
boolean	isEnabled()
boolean	isLoggingForCurrentThread()
void	processLoggingForCurrentThread(boolean enabled) Disables/enables entity logging for current thread.
void	registerCreate(Entity entity) Logs creation of an entity which is configured for manual logging (LoggedEntity.auto == false).
void	registerCreate(Entity entity, boolean auto) Logs creation of an entity which is configured for auto or manual logging (depending on the auto parameter).
void	registerDelete(Entity entity) Logs deletion of an entity which is configured for manual logging (LoggedEntity.auto == false).
void	registerDelete(Entity entity, boolean auto) Logs deletion of an entity which is configured for auto or manual logging (depending on the auto parameter).
void	registerModify(Entity entity) Logs modification of an entity which is configured for manual logging (LoggedEntity.auto == false).
void	registerModify(Entity entity, boolean auto) Logs modification of an entity which is configured for auto or manual logging (depending on the auto parameter).
void	registerModify(Entity entity, boolean auto, EntityAttributeChanges changes) Logs modification of an entity which is configured for auto or manual logging (depending on the auto parameter).
void	setEnabled(boolean enabled)

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)

registerCreate

void registerCreate(Entity entity)

Logs creation of an entity which is configured for manual logging (LoggedEntity.auto == false).

registerCreate

void registerCreate(Entity entity,
                    boolean auto)

Logs creation of an entity which is configured for auto or manual logging (depending on the auto parameter).

registerModify

void registerModify(Entity entity)

Logs modification of an entity which is configured for manual logging (LoggedEntity.auto == false).

registerModify

void registerModify(Entity entity,
                    boolean auto)

Logs modification of an entity which is configured for auto or manual logging (depending on the auto parameter).

registerModify

void registerModify(Entity entity,
                    boolean auto,
                    @Nullable
                    EntityAttributeChanges changes)

Logs modification of an entity which is configured for auto or manual logging (depending on the auto parameter).

Parameters:

changes - attribute changes provided by caller

registerDelete

void registerDelete(Entity entity)

Logs deletion of an entity which is configured for manual logging (LoggedEntity.auto == false).

registerDelete

void registerDelete(Entity entity,
                    boolean auto)

Logs deletion of an entity which is configured for auto or manual logging (depending on the auto parameter).

invalidateCache

void invalidateCache()

Invalidates configuration cache. The configuration will be recreated from the database on next lifecycle event.

processLoggingForCurrentThread

void processLoggingForCurrentThread(boolean enabled)

Disables/enables entity logging for current thread. Enabled by default.

Parameters:

enabled - entity logging disabled if false, enabled otherwise.

isLoggingForCurrentThread

boolean isLoggingForCurrentThread()

Returns:

whether logging for the current thread is enabled

See Also:

processLoggingForCurrentThread(boolean)

flush

void flush()

Flush records accumulated by invocations of registerCreate(Entity) and other registration methods to the database.