Package com.logicaldoc.importfolder

Class ImportFolderCrawler

java.lang.Object

com.logicaldoc.core.task.Task

com.logicaldoc.importfolder.ImportFolderCrawler

All Implemented Interfaces:

Runnable

public class ImportFolderCrawler
extends com.logicaldoc.core.task.Task

This component crawls all remote import folders importing found files in the dms.

Since:

2.1

Author:

Marco Meschieri- LogicalDOC

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COUNTER_SEQUENCE
static final String	NAME

Fields inherited from class com.logicaldoc.core.task.Task

STATUS_IDLE, STATUS_RUNNING, STATUS_STOPPING

Constructor Summary

Constructors

Constructor	Description
ImportFolderCrawler()

Method Summary

Modifier and Type	Method	Description
void	afterDocumentImported(ImportFolder importFolder, com.logicaldoc.core.document.Document document, String originalPath, boolean newFile)	To be invoked after a file has been imported
static void	beforeDocumentImported(ImportFolder importFolder, com.logicaldoc.core.document.AbstractDocument document, String originalPath, com.logicaldoc.core.document.DocumentHistory transaction)	To be invoked before a file gets imported
void	crawlImportFolders()	Downloads all new files from all import folders.
void	following()
ImportFolderCacheManager	getCacheManager()
String	getDefaultOwner()
com.logicaldoc.core.document.DocumentDAO	getDocumentDao()
long	getErrors()
long	getImported()
ImportFolderDAO	getImportFolderDao()
int	getLocalCount()
org.slf4j.Logger	getLog()
int	getRemoteCount()
long	getUpdated()
boolean	isConcurrent()
boolean	isIndeterminate()
void	onError(ImportFolder importFolder, com.logicaldoc.core.document.Document document, String originalPath, Throwable error)	To be invoked after an error has been detected
void	setCacheManager(ImportFolderCacheManager cacheManager)
void	setDefaultOwner(String defaultOwner)
void	setDocumentDao(com.logicaldoc.core.document.DocumentDAO documentDao)
void	setImportFolderDao(ImportFolderDAO importFolderDao)
void	setImportFolderHistoryDao(ImportFolderHistoryDAO importFolderHistoryDao)
void	setSequenceDao(com.logicaldoc.core.sequence.SequenceDAO sequenceDao)

Methods inherited from class com.logicaldoc.core.task.Task

addTaskListener, getCompletionPercentage, getConfig, getName, getProgress, getReportRecipients, getScheduling, getSize, getStatus, interrupt, isInterrupted, isInterruptRequested, isRunning, isSendActivityReport, notifyReport, removeTaskListener, run, save, saveWork, setConfig, setLockManager, setReportRecipients, setSendActivityReport, setSender, setSize, setSystemLoadMonitor, setUserDao

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

COUNTER_SEQUENCE

public static final String COUNTER_SEQUENCE

See Also:

• Constant Field Values

Constructor Details

ImportFolderCrawler

public ImportFolderCrawler()

Method Details

getCacheManager

public ImportFolderCacheManager getCacheManager()

setCacheManager

public void setCacheManager(ImportFolderCacheManager cacheManager)

getDocumentDao

public com.logicaldoc.core.document.DocumentDAO getDocumentDao()

setDocumentDao

public void setDocumentDao(com.logicaldoc.core.document.DocumentDAO documentDao)

crawlImportFolders

public void crawlImportFolders()

Downloads all new files from all import folders. The stored document will be owned by the specified default owner

beforeDocumentImported

public static void beforeDocumentImported(ImportFolder importFolder,
 com.logicaldoc.core.document.AbstractDocument document,
 String originalPath,
 com.logicaldoc.core.document.DocumentHistory transaction)

To be invoked before a file gets imported

Parameters:

importFolder - the used import folder

document - the target created / updated document

originalPath - the original path of the file

transaction - the current event

afterDocumentImported

public void afterDocumentImported(ImportFolder importFolder,
 com.logicaldoc.core.document.Document document,
 String originalPath,
 boolean newFile)

To be invoked after a file has been imported

Parameters:

importFolder - the used import folder

document - the target created / updated document

originalPath - the original path of the file

newFile - if this is a new import or an update

onError

public void onError(ImportFolder importFolder,
 com.logicaldoc.core.document.Document document,
 String originalPath,
 Throwable error)

To be invoked after an error has been detected

Parameters:

importFolder - the used import folder

document - the target document

originalPath - the original path of the file

error - the exception generated by the error

isIndeterminate

public boolean isIndeterminate()

Specified by:

isIndeterminate in class com.logicaldoc.core.task.Task

isConcurrent

public boolean isConcurrent()

Specified by:

isConcurrent in class com.logicaldoc.core.task.Task

setDefaultOwner

public void setDefaultOwner(String defaultOwner)

getRemoteCount

public int getRemoteCount()

getLocalCount

public int getLocalCount()

getImported

public long getImported()

getUpdated

public long getUpdated()

getErrors

public long getErrors()

getDefaultOwner

public String getDefaultOwner()

following

public void following()

getLog

public org.slf4j.Logger getLog()

getImportFolderDao

public ImportFolderDAO getImportFolderDao()

setImportFolderDao

public void setImportFolderDao(ImportFolderDAO importFolderDao)

setSequenceDao

public void setSequenceDao(com.logicaldoc.core.sequence.SequenceDAO sequenceDao)

setImportFolderHistoryDao

public void setImportFolderHistoryDao(ImportFolderHistoryDAO importFolderHistoryDao)