org.kuali.rice.kew.batch
Class XmlPollerServiceImpl

java.lang.Object
  org.kuali.rice.kew.batch.XmlPollerServiceImpl

All Implemented Interfaces:

Runnable, XmlPollerService

public class XmlPollerServiceImpl
extends Object
implements XmlPollerService

Utility class responsible for polling and ingesting XML data files containing various forms of workflow engine data (e.g. document types and rules). Loaded files and problem files are placed into a subdirectory of a configured 'loaded' and 'problem' directory, respectively. "Problem-ness" is determined by inspecting a 'processed' flag on each XmlDoc in each collection. If not all XmlDocs are marked 'processed' an error is assumed, and the collection file (e.g. for a Zip, the Zip file) is moved to the 'problem' directory. As such, it is the XmlIngesterService's responsibility to mark any unknown or otherwise innocuous non-failure non-processed files, as 'processed'. A different mechanism can be developed if this proves to be a problem, but for now it is simple enough for the XmlIngesterService to determine this.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

XmlPollerService, XmlIngesterServiceImpl

Field Summary

private static Format	DIR_FORMAT
private int	initialDelaySecs Specifies the initial delay the poller should wait before starting to poll
private static org.apache.log4j.Logger	LOG
private static String	NEW_LINE
private static String	PENDING_MOVE_FAILED_ARCHIVE_FILE
private int	pollIntervalSecs Specifies the polling interval that should be used with this task.
private String	xmlCompletedLocation Location in which to place successfully loaded XML files.
private String	xmlParentDirectory
private String	xmlPendingLocation Location in which to find XML files to load.
private String	xmlProblemLocation Location in which to place XML files which have failed to load.

Fields inherited from interface org.kuali.rice.kew.batch.XmlPollerService

XML_COMPLETED_LOC_PROP, XML_INIT_DELAY_SECS_PROP, XML_PENDING_LOC_PROP, XML_POLL_INTERVAL_PROP, XML_PROBLEM_LOC_PROP, XML_ROOT_LOC_PROP

Constructor Summary

XmlPollerServiceImpl()

Method Summary

int	getInitialDelaySecs() Gets the initial delay time in seconds
int	getPollIntervalSecs() Gets the polling interval time in seconds
private File	getXmlCompleteDir()
String	getXmlCompletedLocation()
String	getXmlParentDirectory()
private File	getXmlPendingDir()
String	getXmlPendingLocation()
private File	getXmlProblemDir()
String	getXmlProblemLocation()
private boolean	inPendingMoveFailedArchive(File xmlDataFile)
private boolean	moveFile(File toDirectory, File fileToMove)
private boolean	recordUnmovablePendingFile(File unMovablePendingFile, Date dateLoaded)
void	run()
void	setInitialDelaySecs(int seconds) Sets the initial delay time in seconds
void	setPollIntervalSecs(int seconds) Sets the polling interval time in seconds
void	setXmlCompletedLocation(String xmlCompletedLocation)
void	setXmlParentDirectory(String xmlDataParentDirectory)
void	setXmlPendingLocation(String xmlPendingLocation)
void	setXmlProblemLocation(String xmlProblemLocation)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

DIR_FORMAT

private static final Format DIR_FORMAT

pollIntervalSecs

private int pollIntervalSecs

Specifies the polling interval that should be used with this task.

initialDelaySecs

private int initialDelaySecs

Specifies the initial delay the poller should wait before starting to poll

xmlPendingLocation

private String xmlPendingLocation

Location in which to find XML files to load.

xmlCompletedLocation

private String xmlCompletedLocation

Location in which to place successfully loaded XML files.

xmlProblemLocation

private String xmlProblemLocation

Location in which to place XML files which have failed to load.

xmlParentDirectory

private String xmlParentDirectory

PENDING_MOVE_FAILED_ARCHIVE_FILE

private static final String PENDING_MOVE_FAILED_ARCHIVE_FILE

See Also:

Constant Field Values

NEW_LINE

private static final String NEW_LINE

See Also:

Constant Field Values

Constructor Detail

XmlPollerServiceImpl

public XmlPollerServiceImpl()

Method Detail

run

public void run()

Specified by:

run in interface Runnable

inPendingMoveFailedArchive

private boolean inPendingMoveFailedArchive(File xmlDataFile)

recordUnmovablePendingFile

private boolean recordUnmovablePendingFile(File unMovablePendingFile,
                                           Date dateLoaded)

moveFile

private boolean moveFile(File toDirectory,
                         File fileToMove)

getXmlPendingDir

private File getXmlPendingDir()

getXmlCompleteDir

private File getXmlCompleteDir()

getXmlProblemDir

private File getXmlProblemDir()

getXmlCompletedLocation

public String getXmlCompletedLocation()

setXmlCompletedLocation

public void setXmlCompletedLocation(String xmlCompletedLocation)

getXmlPendingLocation

public String getXmlPendingLocation()

setXmlPendingLocation

public void setXmlPendingLocation(String xmlPendingLocation)

getXmlProblemLocation

public String getXmlProblemLocation()

setXmlProblemLocation

public void setXmlProblemLocation(String xmlProblemLocation)

getXmlParentDirectory

public String getXmlParentDirectory()

setXmlParentDirectory

public void setXmlParentDirectory(String xmlDataParentDirectory)

setPollIntervalSecs

public void setPollIntervalSecs(int seconds)

Sets the polling interval time in seconds

Parameters:

seconds - the polling interval time in seconds

getPollIntervalSecs

public int getPollIntervalSecs()

Gets the polling interval time in seconds

Specified by:

getPollIntervalSecs in interface XmlPollerService

Returns:

the polling interval time in seconds

setInitialDelaySecs

public void setInitialDelaySecs(int seconds)

Sets the initial delay time in seconds

Parameters:

seconds - the initial delay time in seconds

getInitialDelaySecs

public int getInitialDelaySecs()

Gets the initial delay time in seconds

Specified by:

getInitialDelaySecs in interface XmlPollerService

Returns:

the initial delay time in seconds