StreamAuditEventListener (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.ecm.platform.audit.listener.StreamAuditEventListener

All Implemented Interfaces:

javax.transaction.Synchronization, EventListener
```
public class StreamAuditEventListener
extends Object
implements EventListener, javax.transaction.Synchronization
```
An events collector that write log entries as json record into a stream.

Since:

9.3

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_LOG_CONFIG`	Deprecated.
`protected static ThreadLocal<List<LogEntry>>`	`entries`
`protected static ThreadLocal<Boolean>`	`isEnlisted`
`static String`	`STREAM_AUDIT_ENABLED_PROP`
`static String`	`STREAM_NAME`

Constructor Summary

Constructors
Constructor Description

StreamAuditEventListener()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`afterCompletion(int status)`
`protected String`	`asJson(LogEntry entry)`
`void`	`beforeCompletion()`
`protected StreamManager`	`getStreamManager()`
`protected long`	`getTimestampForEntry(LogEntry entry)`
`void`	`handleEvent(Event event)`	Handle the given event.
`protected Record`	`recordOf(LogEntry entry)`
`protected boolean`	`registerSynchronization(javax.transaction.Synchronization sync)`
`protected void`	`writeEntries()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isEnlisted

protected static final ThreadLocal<Boolean> isEnlisted

entries

protected static final ThreadLocal<List<LogEntry>> entries

STREAM_AUDIT_ENABLED_PROP

public static final String STREAM_AUDIT_ENABLED_PROP

See Also:: Constant Field Values

STREAM_NAME
```
public static final String STREAM_NAME
```
See Also:

Constant Field Values

DEFAULT_LOG_CONFIG

@Deprecated
public static final String DEFAULT_LOG_CONFIG

Deprecated.

See Also:: Constant Field Values

Constructor Detail
- StreamAuditEventListener
```
public StreamAuditEventListener()
```

Method Detail
- handleEvent
```
public void handleEvent(Event event)
```
  Description copied from interface: EventListener
  
  Handle the given event. The listener can cancel the event by calling Event.cancel()
  
  Specified by:
  
  handleEvent in interface EventListener
  
  Parameters:
  
  event - the event
- beforeCompletion
```
public void beforeCompletion()
```
  Specified by:
  
  beforeCompletion in interface javax.transaction.Synchronization
- afterCompletion
```
public void afterCompletion(int status)
```
  Specified by:
  
  afterCompletion in interface javax.transaction.Synchronization
- writeEntries
```
protected void writeEntries()
```
- recordOf
```
protected Record recordOf(LogEntry entry)
```
- getTimestampForEntry
```
protected long getTimestampForEntry(LogEntry entry)
```
- asJson
```
protected String asJson(LogEntry entry)
```
- registerSynchronization
```
protected boolean registerSynchronization(javax.transaction.Synchronization sync)
```
- getStreamManager
```
protected StreamManager getStreamManager()
```