com.avaje.ebean.event.readaudit

Class ReadEvent

java.lang.Object

com.avaje.ebean.event.readaudit.ReadEvent

public class ReadEvent
extends Object

Read event sent to the ReadEventLogger.

This is a flattened in that it contains either a read bean or list of beans. It is flattened in this way to simplify logging and processing and simply means that it either contains an id or a list of ids.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	beanType The type of the bean(s) read.
protected String	bindLog The bind log when the query was executed.
protected long	eventTime The time the bean change was created.
protected Object	id The id of the bean read.
protected List<Object>	ids The ids of the beans read.
protected String	queryKey The query key (relative to the bean type).
protected String	source User defined 'source' such as the application name.
protected Map<String,String>	userContext Arbitrary user context information expected to be optionally populated by ChangeLogPrepare.
protected String	userId Application user id expected to be optionally populated by ChangeLogPrepare.
protected String	userIpAddress Application user ip address expected to be optionally populated by ChangeLogPrepare.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReadEvent() Constructor for JSON tools.
	ReadEvent(String beanType) Construct for many future list query.
protected	ReadEvent(String beanType, String queryKey, String bindLog) Common constructor for single bean and multi-bean read events.
	ReadEvent(String beanType, String queryKey, String bindLog, List<Object> ids) Construct for many beans read.
	ReadEvent(String beanType, String queryKey, String bindLog, Object id) Construct for a single bean read.

Method Summary

Modifier and Type	Method and Description
String	getBeanType() Return the type of bean read.
String	getBindLog() Return the bind log used when executing the query.
long	getEventTime() Return the event date time.
Object	getId() Return the id of the bean read.
List<Object>	getIds() Return the ids of the beans read.
String	getQueryKey() Return the query key (relative to the bean type).
String	getSource() Return a code that identifies the source of the change (like the name of the application).
Map<String,String>	getUserContext() Return a user context value - anything you set yourself in ChangeLogListener prepare().
String	getUserId() Return the application user Id.
String	getUserIpAddress() Return the application users ip address.
void	setBeanType(String beanType) Set the type of bean read.
void	setBindLog(String bindLog) Set the bind log used when executing the query.
void	setEventTime(long eventTime) Set the event date time.
void	setId(Object id) Set the id of the bean read.
void	setIds(List<Object> ids) Set the ids of the beans read.
void	setQueryKey(String queryKey) Set the query key (relative to the bean type).
void	setSource(String source) Set the source of the change (like the name of the application).
void	setUserContext(Map<String,String> userContext) Set a user context value (anything you like).
void	setUserId(String userId) Set the application user Id.
void	setUserIpAddress(String userIpAddress) Set the application users ip address.

Methods inherited from class java.lang.Object

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

Field Detail

source

protected String source

User defined 'source' such as the application name.

userId

protected String userId

Application user id expected to be optionally populated by ChangeLogPrepare.

userIpAddress

protected String userIpAddress

Application user ip address expected to be optionally populated by ChangeLogPrepare.

userContext

protected Map<String,String> userContext

Arbitrary user context information expected to be optionally populated by ChangeLogPrepare.

eventTime

protected long eventTime

The time the bean change was created.

beanType

protected String beanType

The type of the bean(s) read.

queryKey

protected String queryKey

The query key (relative to the bean type).

bindLog

protected String bindLog

The bind log when the query was executed.

id

protected Object id

The id of the bean read.

ids

protected List<Object> ids

The ids of the beans read.

Constructor Detail

ReadEvent

protected ReadEvent(String beanType,
                    String queryKey,
                    String bindLog)

Common constructor for single bean and multi-bean read events.

ReadEvent

public ReadEvent(String beanType,
                 String queryKey,
                 String bindLog,
                 Object id)

Construct for a single bean read.

ReadEvent

public ReadEvent(String beanType,
                 String queryKey,
                 String bindLog,
                 List<Object> ids)

Construct for many beans read.

ReadEvent

public ReadEvent(String beanType)

Construct for many future list query.

ReadEvent

public ReadEvent()

Constructor for JSON tools.

Method Detail

getSource

public String getSource()

Return a code that identifies the source of the change (like the name of the application).

setSource

public void setSource(String source)

Set the source of the change (like the name of the application).

getUserId

public String getUserId()

Return the application user Id.

setUserId

public void setUserId(String userId)

Set the application user Id.

This can be set by the ChangeLogListener in the prepare() method which is called in the foreground thread.

getUserIpAddress

public String getUserIpAddress()

Return the application users ip address.

setUserIpAddress

public void setUserIpAddress(String userIpAddress)

Set the application users ip address.

This can be set by the ChangeLogListener in the prepare() method which is called in the foreground thread.

getUserContext

public Map<String,String> getUserContext()

Return a user context value - anything you set yourself in ChangeLogListener prepare().

setUserContext

public void setUserContext(Map<String,String> userContext)

Set a user context value (anything you like).

This can be set by the ChangeLogListener in the prepare() method which is called in the foreground thread.

getBeanType

public String getBeanType()

Return the type of bean read.

setBeanType

public void setBeanType(String beanType)

Set the type of bean read.

getQueryKey

public String getQueryKey()

Return the query key (relative to the bean type).

setQueryKey

public void setQueryKey(String queryKey)

Set the query key (relative to the bean type).

getBindLog

public String getBindLog()

Return the bind log used when executing the query.

setBindLog

public void setBindLog(String bindLog)

Set the bind log used when executing the query.

getEventTime

public long getEventTime()

Return the event date time.

setEventTime

public void setEventTime(long eventTime)

Set the event date time.

getId

public Object getId()

Return the id of the bean read.

setId

public void setId(Object id)

Set the id of the bean read.

getIds

public List<Object> getIds()

Return the ids of the beans read.

setIds

public void setIds(List<Object> ids)

Set the ids of the beans read.