Package io.ebean.event.changelog

Class ChangeSet

java.lang.Object

io.ebean.event.changelog.ChangeSet

public class ChangeSet
extends Object

Holds a set of changes.

Constructor Summary

Constructors

Constructor	Description
ChangeSet()	Default constructor for JSON tools.
ChangeSet(String txnId, long txnBatch)	Construct with a txnId.

Method Summary

Modifier and Type	Method	Description
void	addBeanChange(BeanChange beanChange)	Add a bean change to the change set.
List<BeanChange>	getChanges()	Return the bean changes.
String	getSource()	Return a code that identifies the source of the change (like the name of the application).
long	getTxnBatch()	Returns the batch id.
String	getTxnId()	Return the txnId.
TxnState	getTxnState()	Return the transaction state.
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	setChanges(List<BeanChange> changes)	Set the bean changes (used by JSON tools).
void	setSource(String source)	Set the source of the change (like the name of the application).
void	setTxnBatch(long txnBatch)	Sets the batch id (used by JSON tools).
void	setTxnId(String txnId)	Set the txnId (used by JSON tools).
void	setTxnState(TxnState txnState)	Set the state (used by JSON tools).
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.
int	size()	Return the number of changes in the change set.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeSet

public ChangeSet(String txnId,
                 long txnBatch)

Construct with a txnId.

ChangeSet

public ChangeSet()

Default constructor for JSON tools.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Return the number of changes in the change set.

addBeanChange

public void addBeanChange(BeanChange beanChange)

Add a bean change to the change set.

getTxnId

public String getTxnId()

Return the txnId.

setTxnId

public void setTxnId(String txnId)

Set the txnId (used by JSON tools).

getTxnBatch

public long getTxnBatch()

Returns the batch id.

setTxnBatch

public void setTxnBatch(long txnBatch)

Sets the batch id (used by JSON tools).

getTxnState

public TxnState getTxnState()

Return the transaction state. This will be IN_PROGRESS for many changeSets in large transactions as the changeSets are sent in batches before the transaction has completed.

setTxnState

public void setTxnState(TxnState txnState)

Set the state (used by JSON tools).

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.

getChanges

public List<BeanChange> getChanges()

Return the bean changes.

setChanges

public void setChanges(List<BeanChange> changes)

Set the bean changes (used by JSON tools).