com.dpslink.flash.db.util

Class SyncUsersTask

java.lang.Object

com.dpslink.flash.db.util.DBUTask

com.dpslink.flash.db.util.SyncUsersTask

All Implemented Interfaces:

DBUInterface, java.io.Serializable, java.lang.Runnable

public class SyncUsersTask
extends DBUTask

Handles the synchronization of user information with the backend ERP system. Allows for all users to be synchronized in a background thread or a single user to be synchronized in the current thread (a mini-sync).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncUsersTask.SyncLogWriter An inner class for persisting events to a log file and for sending alert email messages when a configured severity level occurs.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.Thread	cvThread The thread running the user synchronization task.
private IUserMaintenance	ivUserMaint A reference to the User Maintenance Interface object.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.db.util.DBUTask

ivContext

Constructor Summary

Constructors

Constructor and Description
SyncUsersTask() Constructs a new instance of the user synchronization task with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
static boolean	isRunning() Answers if the task is currently running.
void	miniSync(User flashUser) Performs mini-sync for the given Flash user if mini-sync is configured and user has not already been mini-synced.
void	run() Runs the user synchronization task.
protected int[]	synchronize(User flashUser, boolean miniSync) Updates the given Flash user with information from the backend ERP system.

Methods inherited from class com.dpslink.flash.db.util.DBUTask

getContext, setContext

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvThread

private static java.lang.Thread cvThread

The thread running the user synchronization task.

ivUserMaint

private IUserMaintenance ivUserMaint

A reference to the User Maintenance Interface object.

Constructor Detail

SyncUsersTask

public SyncUsersTask()

Constructs a new instance of the user synchronization task with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

run

public void run()

Runs the user synchronization task. Invoked by the Runnable interface.

isRunning

public static boolean isRunning()

Answers if the task is currently running.

Returns:

boolean - true if the task is currently running, otherwise false.

miniSync

public void miniSync(User flashUser)

Performs mini-sync for the given Flash user if mini-sync is configured and user has not already been mini-synced.

Parameters:

flashUser - (User) The Flash user to process.

synchronize

protected int[] synchronize(User flashUser,
                            boolean miniSync)

Updates the given Flash user with information from the backend ERP system.

Parameters:

flashUser - (User) The Flash user to update.

miniSync - (boolean) true if invoking in mini-sync mode, otherwise false.

Returns:

int[] - The results of the update where if [0] > 0 user was inactivated and if [1] > 0 user was updated.