Package org.apache.ofbiz.entityext.synchronization

Class EntitySyncContext

java.lang.Object

org.apache.ofbiz.entityext.synchronization.EntitySyncContext

public class EntitySyncContext
extends Object

Entity Engine Sync Services

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntitySyncContext.SyncAbortException	This class signifies an abort condition, so the state and such of the EntitySync value in the datasource should not be changed
static class	EntitySyncContext.SyncDataErrorException	This class signifies an error condition, so the state of the EntitySync value and the EntitySyncHistory value in the datasource should be changed to reflect the error
static class	EntitySyncContext.SyncErrorException
static class	EntitySyncContext.SyncOtherErrorException	This class signifies an error condition, so the state of the EntitySync value and the EntitySyncHistory value in the datasource should be changed to reflect the error
static class	EntitySyncContext.SyncServiceErrorException	This class signifies an error condition, so the state of the EntitySync value and the EntitySyncHistory value in the datasource should be changed to reflect the error

Constructor Summary

Constructors

Constructor	Description
EntitySyncContext(DispatchContext dctx, Map<String,? extends Object> context)

Method Summary

Modifier and Type	Method	Description
void	advanceRunTimes()	Advance run times.
LinkedList<GenericEntity>	assembleKeysToRemove()	Assemble keys to remove linked list.
ArrayList<GenericValue>	assembleValuesToCreate()	Assemble values to create array list.
ArrayList<GenericValue>	assembleValuesToStore()	Assemble values to store array list.
void	createInitialHistory()	create history record, target service should run in own tx
Timestamp	getCurrentRunEndTime()	Gets current run end time.
Timestamp	getCurrentRunStartTime()	Gets current run start time.
protected static Timestamp	getCurrentRunStartTime(Timestamp lastSuccessfulSynchTime, List<ModelEntity> entityModelToUseList, Delegator delegator)
GenericValue	getEntitySync()	Gets entity sync.
String	getEntitySyncId()	Gets entity sync id.
static Set<String>	getEntitySyncModelNamesToUse(LocalDispatcher dispatcher, String entitySyncId)	Static method to obtain a list of entity names which will be synchronized
protected static long	getMaxRunningNoUpdateMillis(GenericValue entitySync)
protected Timestamp	getNextRunEndTime()	Gets next run end time.
protected static long	getOfflineSyncSplitMillis(GenericValue entitySync)
Timestamp	getStartDate()	Gets start date.
protected static long	getSyncEndBufferMillis(GenericValue entitySync)
protected static long	getSyncSplitMillis(GenericValue entitySync)
long	getTotalRowsPerSplit()	Gets total rows per split.
long	getTotalSplits()	Gets total splits.
boolean	hasMoreTimeToSync()	Has more time to sync boolean.
boolean	isEntitySyncRunning()	To see if it is running check: - in the running status - AND when the entitySync was last updated, and if it was more than maxRunningNoUpdateMillis ago, then don't consider it to be running
protected List<ModelEntity>	makeEntityModelToUseList()	prepare a list of all entities we want to synchronize: remove all view-entities and all entities that don't match the patterns attached to this EntitySync
Set<String>	makeEntityNameToUseSet()	Make entity name to use set set.
void	runOfflineStartRunning()	Run offline start running.
void	runPullStartOrRestoreSavedResults()	Run pull start or restore saved results.
void	runPushSendData(ArrayList<GenericValue> valuesToCreate, ArrayList<GenericValue> valuesToStore, List<GenericEntity> keysToRemove)	Run push send data.
void	runPushStartRunning()	Run push start running.
void	runSaveOfflineSyncInfo(long rowsInSplit)	Run save offline sync info.
void	saveFinalSyncResults()	Save final sync results.
void	saveResultsReportedFromDataStore()	Save results reported from data store.
void	saveSyncErrorInfo(String runStatusId, List<Object> errorMessages)	Save sync error info.
protected void	setCurrentRunEndTime()	Sets current run end time.
void	setSplitStartTime()	Sets split start time.
long	setTotalRowCounts(ArrayList<GenericValue> valuesToCreate, ArrayList<GenericValue> valuesToStore, List<GenericEntity> keysToRemove)	Sets total row counts.
void	setTotalSplits(long totalSplits)	Sets total splits.

Methods inherited from class java.lang.Object

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

Constructor Details

EntitySyncContext

public EntitySyncContext(DispatchContext dctx,
 Map<String,? extends Object> context)
                  throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncAbortException

Throws:

EntitySyncContext.SyncDataErrorException

EntitySyncContext.SyncAbortException

Method Details

getCurrentRunEndTime

public Timestamp getCurrentRunEndTime()

Gets current run end time.

Returns:

the current run end time

getStartDate

public Timestamp getStartDate()

Gets start date.

Returns:

the start date

getTotalRowsPerSplit

public long getTotalRowsPerSplit()

Gets total rows per split.

Returns:

the total rows per split

getCurrentRunStartTime

public Timestamp getCurrentRunStartTime()

Gets current run start time.

Returns:

the current run start time

getEntitySyncId

public String getEntitySyncId()

Gets entity sync id.

Returns:

the entity sync id

setTotalSplits

public void setTotalSplits(long totalSplits)

Sets total splits.

Parameters:

totalSplits - the total splits

getEntitySync

public GenericValue getEntitySync()

Gets entity sync.

Returns:

the entity sync

getTotalSplits

public long getTotalSplits()

Gets total splits.

Returns:

the total splits

isEntitySyncRunning

public boolean isEntitySyncRunning()

To see if it is running check: - in the running status - AND when the entitySync was last updated, and if it was more than maxRunningNoUpdateMillis ago, then don't consider it to be running

Returns:

boolean representing if the EntitySync should be considered running

hasMoreTimeToSync

public boolean hasMoreTimeToSync()

Has more time to sync boolean.

Returns:

the boolean

setCurrentRunEndTime

protected void setCurrentRunEndTime()

Sets current run end time.

getNextRunEndTime

protected Timestamp getNextRunEndTime()

Gets next run end time.

Returns:

the next run end time

advanceRunTimes

public void advanceRunTimes()

Advance run times.

setSplitStartTime

public void setSplitStartTime()

Sets split start time.

getSyncSplitMillis

protected static long getSyncSplitMillis(GenericValue entitySync)

getOfflineSyncSplitMillis

protected static long getOfflineSyncSplitMillis(GenericValue entitySync)

getSyncEndBufferMillis

protected static long getSyncEndBufferMillis(GenericValue entitySync)

getMaxRunningNoUpdateMillis

protected static long getMaxRunningNoUpdateMillis(GenericValue entitySync)

createInitialHistory

public void createInitialHistory()
                          throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException

create history record, target service should run in own tx

Throws:

EntitySyncContext.SyncDataErrorException

EntitySyncContext.SyncServiceErrorException

assembleValuesToCreate

public ArrayList<GenericValue> assembleValuesToCreate()
                                               throws EntitySyncContext.SyncDataErrorException

Assemble values to create array list.

Returns:

the array list

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

assembleValuesToStore

public ArrayList<GenericValue> assembleValuesToStore()
                                              throws EntitySyncContext.SyncDataErrorException

Assemble values to store array list.

Returns:

the array list

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

assembleKeysToRemove

public LinkedList<GenericEntity> assembleKeysToRemove()
                                               throws EntitySyncContext.SyncDataErrorException

Assemble keys to remove linked list.

Returns:

the linked list

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

saveResultsReportedFromDataStore

public void saveResultsReportedFromDataStore()
                                      throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException

Save results reported from data store.

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

saveFinalSyncResults

public void saveFinalSyncResults()
                          throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException

Save final sync results.

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

makeEntityNameToUseSet

public Set<String> makeEntityNameToUseSet()

Make entity name to use set set.

Returns:

the set

makeEntityModelToUseList

protected List<ModelEntity> makeEntityModelToUseList()
                                              throws GenericEntityException

prepare a list of all entities we want to synchronize: remove all view-entities and all entities that don't match the patterns attached to this EntitySync

Throws:

GenericEntityException

getCurrentRunStartTime

protected static Timestamp getCurrentRunStartTime(Timestamp lastSuccessfulSynchTime,
 List<ModelEntity> entityModelToUseList,
 Delegator delegator)
                                           throws GenericEntityException

Throws:

GenericEntityException

saveSyncErrorInfo

public void saveSyncErrorInfo(String runStatusId,
 List<Object> errorMessages)

Save sync error info.

Parameters:

runStatusId - the run status id

errorMessages - the error messages

runPushStartRunning

public void runPushStartRunning()
                         throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException,
EntitySyncContext.SyncAbortException

Run push start running.

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

EntitySyncContext.SyncAbortException - the sync abort exception

setTotalRowCounts

public long setTotalRowCounts(ArrayList<GenericValue> valuesToCreate,
 ArrayList<GenericValue> valuesToStore,
 List<GenericEntity> keysToRemove)

Sets total row counts.

Parameters:

valuesToCreate - the values to create

valuesToStore - the values to store

keysToRemove - the keys to remove

Returns:

the total row counts

runPushSendData

public void runPushSendData(ArrayList<GenericValue> valuesToCreate,
 ArrayList<GenericValue> valuesToStore,
 List<GenericEntity> keysToRemove)
                     throws EntitySyncContext.SyncOtherErrorException,
EntitySyncContext.SyncServiceErrorException

Run push send data.

Parameters:

valuesToCreate - the values to create

valuesToStore - the values to store

keysToRemove - the keys to remove

Throws:

EntitySyncContext.SyncOtherErrorException - the sync other error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

runPullStartOrRestoreSavedResults

public void runPullStartOrRestoreSavedResults()
                                       throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException,
EntitySyncContext.SyncAbortException

Run pull start or restore saved results.

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

EntitySyncContext.SyncAbortException - the sync abort exception

runOfflineStartRunning

public void runOfflineStartRunning()
                            throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException,
EntitySyncContext.SyncAbortException

Run offline start running.

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

EntitySyncContext.SyncAbortException - the sync abort exception

runSaveOfflineSyncInfo

public void runSaveOfflineSyncInfo(long rowsInSplit)
                            throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncServiceErrorException,
EntitySyncContext.SyncAbortException

Run save offline sync info.

Parameters:

rowsInSplit - the rows in split

Throws:

EntitySyncContext.SyncDataErrorException - the sync data error exception

EntitySyncContext.SyncServiceErrorException - the sync service error exception

EntitySyncContext.SyncAbortException - the sync abort exception

getEntitySyncModelNamesToUse

public static Set<String> getEntitySyncModelNamesToUse(LocalDispatcher dispatcher,
 String entitySyncId)
                                                throws EntitySyncContext.SyncDataErrorException,
EntitySyncContext.SyncAbortException

Static method to obtain a list of entity names which will be synchronized

Throws:

EntitySyncContext.SyncDataErrorException

EntitySyncContext.SyncAbortException