FileMonitor (Waarp Common 3.3.4 API Reference)

java.lang.Object
- org.waarp.common.filemonitor.FileMonitor

```
public class FileMonitor
extends Object
```
This package would like to propose a JSE 6 compatible way to scan a directory for new, deleted and changed files, in order to allow some functions like pooling a directory before actions.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileMonitor.FileItem` One element in the directory
`static class`	`FileMonitor.FileMonitorInformation` Used by Waarp Business information
`protected class`	`FileMonitor.FileMonitorTimerInformationTask` Class to run Waarp Business information in fixed delay rather than after each check
`protected static class`	`FileMonitor.FileMonitorTimerTask` Timer task
`static class`	`FileMonitor.Status`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`checkDelay`
`protected File`	`checkFile`
`protected FileMonitorCommandRunnableFuture`	`commandCheckIteration`
`protected FileMonitorCommandRunnableFuture`	`commandRemovedFile`
`protected FileMonitorCommandRunnableFuture`	`commandValidFile`
`protected FileMonitorCommandFactory`	`commandValidFileFactory`
`protected static long`	`DEFAULT_CHECK_DELAY`
`protected static long`	`DEFAULT_DELAY`
`protected static FilesystemBasedDigest.DigestAlgo`	`defaultDigestAlgo`
`protected FilesystemBasedDigest.DigestAlgo`	`digest`
`protected List<File>`	`directories`
`protected long`	`elapseTime`
`protected long`	`elapseWaarpTime`
`protected ExecutorService`	`executor`
`protected ConcurrentHashMap<String,FileMonitor.FileItem>`	`fileItems`
`protected FileFilter`	`filter`
`protected int`	`fixedThreadPool`
`protected WaarpFuture`	`future`
`protected AtomicLong`	`globalerror`
`protected AtomicLong`	`globalok`
`protected boolean`	`ignoreAlreadyUsed`
`protected boolean`	`initialized`
`protected WaarpFuture`	`internalfuture`
`protected ConcurrentHashMap<String,FileMonitor.FileItem>`	`lastFileItems`
`protected static WaarpLogger`	`logger` Internal Logger
`protected static long`	`MINIMAL_DELAY`
`protected String`	`name`
`protected Date`	`nextDay`
`protected ConcurrentLinkedQueue<Future<?>>`	`results`
`protected boolean`	`scanSubDir`
`protected File`	`statusFile`
`protected File`	`stopFile`
`protected boolean`	`stopped`
`protected io.netty.util.Timer`	`timer`
`protected io.netty.util.Timer`	`timerWaarp`
`protected AtomicLong`	`todayerror`
`protected AtomicLong`	`todayok`
`protected ConcurrentLinkedQueue<FileMonitor.FileItem>`	`toUse`

Constructor Summary

Constructors
Constructor and Description
`FileMonitor(String name, File statusFile, File stopFile, File directory, FilesystemBasedDigest.DigestAlgo digest, long elapseTime, FileFilter filter, boolean scanSubdir, FileMonitorCommandRunnableFuture commandValidFile, FileMonitorCommandRunnableFuture commandRemovedFile, FileMonitorCommandRunnableFuture commandCheckIteration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDirectory(File directory)` Add a directory to scan
`protected boolean`	`checkFiles()` Check Files
`protected boolean`	`checkOneDir(boolean fileItemsChanged, File directory)`
`long`	`getCurrentHistoryNb()`
`long`	`getElapseTime()`
`long`	`getElapseWaarpTime()`
`String`	`getStatus()`
`boolean`	`initialized()`
`boolean`	`isIgnoreAlreadyUsed()`
`static void`	`main(String[] args)`
`File`	`peek()`
`File`	`poll()`
`protected void`	`reloadStatus()`
`void`	`removeDirectory(File directory)` Add a directory to scan
`protected void`	`saveStatus()`
`void`	`setCheckDelay(long checkDelay)`
`void`	`setCommandCheckIteration(FileMonitorCommandRunnableFuture commandCheckIteration)`
`void`	`setCommandValidFileFactory(FileMonitorCommandFactory factory, int fixedPool)`
`void`	`setElapseTime(long elapseTime)`
`void`	`setElapseWaarpTime(long elapseWaarpTime)` if set greater than 1000 ms, will be parallel, else will be sequential after each check and ignoring this timer
`void`	`setFilter(FileFilter filter)`
`void`	`setIgnoreAlreadyUsed(boolean ignoreAlreadyUsed)`
`void`	`setNextAsFullStatus()` Reset such that next status will be full (not partial)
`protected void`	`setNextDay()`
`protected void`	`setThreadName()`
`void`	`start()`
`void`	`stop()`
`void`	`waitForStopFile()` Wait until the Stop file is created

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static volatile WaarpLogger logger

Internal Logger

defaultDigestAlgo

protected static final FilesystemBasedDigest.DigestAlgo defaultDigestAlgo

MINIMAL_DELAY
```
protected static final long MINIMAL_DELAY
```
See Also:

Constant Field Values

DEFAULT_DELAY
```
protected static final long DEFAULT_DELAY
```
See Also:

Constant Field Values

DEFAULT_CHECK_DELAY
```
protected static final long DEFAULT_CHECK_DELAY
```
See Also:

Constant Field Values

future
```
protected WaarpFuture future
```

internalfuture
```
protected WaarpFuture internalfuture
```

stopped
```
protected boolean stopped
```

name
```
protected final String name
```

statusFile
```
protected final File statusFile
```

stopFile
```
protected final File stopFile
```

directories
```
protected final List<File> directories
```

digest

protected final FilesystemBasedDigest.DigestAlgo digest

elapseTime
```
protected long elapseTime
```

elapseWaarpTime
```
protected long elapseWaarpTime
```

checkDelay
```
protected long checkDelay
```

timer
```
protected io.netty.util.Timer timer
```

timerWaarp

protected io.netty.util.Timer timerWaarp

scanSubDir
```
protected final boolean scanSubDir
```

ignoreAlreadyUsed
```
protected boolean ignoreAlreadyUsed
```

initialized
```
protected boolean initialized
```

checkFile
```
protected File checkFile
```

fileItems

protected final ConcurrentHashMap<String,FileMonitor.FileItem> fileItems

lastFileItems

protected final ConcurrentHashMap<String,FileMonitor.FileItem> lastFileItems

filter
```
protected FileFilter filter
```

commandValidFile

protected final FileMonitorCommandRunnableFuture commandValidFile

commandValidFileFactory

protected FileMonitorCommandFactory commandValidFileFactory

executor
```
protected ExecutorService executor
```

fixedThreadPool
```
protected int fixedThreadPool
```

commandRemovedFile

protected final FileMonitorCommandRunnableFuture commandRemovedFile

commandCheckIteration

protected FileMonitorCommandRunnableFuture commandCheckIteration

toUse

protected final ConcurrentLinkedQueue<FileMonitor.FileItem> toUse

results

protected final ConcurrentLinkedQueue<Future<?>> results

globalok
```
protected final AtomicLong globalok
```

globalerror
```
protected final AtomicLong globalerror
```

todayok
```
protected final AtomicLong todayok
```

todayerror
```
protected final AtomicLong todayerror
```

nextDay
```
protected Date nextDay
```

Constructor Detail
- FileMonitor
```
public FileMonitor(String name,
                   File statusFile,
                   File stopFile,
                   File directory,
                   FilesystemBasedDigest.DigestAlgo digest,
                   long elapseTime,
                   FileFilter filter,
                   boolean scanSubdir,
                   FileMonitorCommandRunnableFuture commandValidFile,
                   FileMonitorCommandRunnableFuture commandRemovedFile,
                   FileMonitorCommandRunnableFuture commandCheckIteration)
```
  Parameters:
  
  name - name of this daemon
  
  statusFile - the file where the current status is saved (current files)
  
  stopFile - the file when created (.exists()) will stop the daemon
  
  directory - the directory where files will be monitored
  
  digest - the digest to use (default if null is MD5)
  
  elapseTime - the time to wait in ms for between 2 checks (default is 1000ms, minimum is 100ms)
  
  filter - the filter to be applied on selected files (default is isFile())
  
  commandValidFile - the commandValidFile to run (may be null, which means poll() commandValidFile has to be used)
  
  commandRemovedFile - the commandRemovedFile to run (may be null)
  
  commandCheckIteration - the commandCheckIteration to run (may be null), runs after each check (elapseTime)

Method Detail
- setNextDay
```
protected void setNextDay()
```
- setCommandCheckIteration
```
public void setCommandCheckIteration(FileMonitorCommandRunnableFuture commandCheckIteration)
```
  Parameters:
  
  commandCheckIteration - the commandCheckIteration to run (may be null), runs after each check (elapseTime)
- setCommandValidFileFactory
```
public void setCommandValidFileFactory(FileMonitorCommandFactory factory,
                                       int fixedPool)
```
  Parameters:
  
  factory - the factory to used instead of simple instance (enables parallelism)
  
  fixedPool - if > 0, set the number of parallel threads allowed
- getElapseWaarpTime
```
public long getElapseWaarpTime()
```
  Returns:
  
  the elapseWaarpTime
- setElapseWaarpTime
```
public void setElapseWaarpTime(long elapseWaarpTime)
```
  if set greater than 1000 ms, will be parallel, else will be sequential after each check and ignoring this timer
  
  Parameters:
  
  elapseWaarpTime - the elapseWaarpTime to set
- isIgnoreAlreadyUsed
```
public boolean isIgnoreAlreadyUsed()
```
  Returns:
  
  True if Already used files will be ignored
- setIgnoreAlreadyUsed
```
public void setIgnoreAlreadyUsed(boolean ignoreAlreadyUsed)
```
  Parameters:
  
  ignoreAlreadyUsed - if True, already used files will be ignored. Else if False, if an already used file is modified, then it will be reused.
- setCheckDelay
```
public void setCheckDelay(long checkDelay)
```
  Parameters:
  
  checkDelay - the delay before checking if action was correctly taken
- addDirectory
```
public void addDirectory(File directory)
```
  Add a directory to scan
  
  Parameters:
  
  directory -
- removeDirectory
```
public void removeDirectory(File directory)
```
  Add a directory to scan
  
  Parameters:
  
  directory -
- setThreadName
```
protected void setThreadName()
```
- reloadStatus
```
protected void reloadStatus()
```
- initialized
```
public boolean initialized()
```
  Returns:
  
  True if the FileMonitor is correctly initialized
- saveStatus
```
protected void saveStatus()
```
- getCurrentHistoryNb
```
public long getCurrentHistoryNb()
```
  Returns:
  
  the number of fileItems in the current history (active, in error or past)
- setNextAsFullStatus
```
public void setNextAsFullStatus()
```
  Reset such that next status will be full (not partial)
- getStatus
```
public String getStatus()
```
  Returns:
  
  the status (updated only) in JSON format
- getElapseTime
```
public long getElapseTime()
```
  Returns:
  
  the elapseTime
- setElapseTime
```
public void setElapseTime(long elapseTime)
```
  Parameters:
  
  elapseTime - the elapseTime to set
- setFilter
```
public void setFilter(FileFilter filter)
```
  Parameters:
  
  filter - the filter to set
- start
```
public void start()
```
- stop
```
public void stop()
```
- peek
```
public File peek()
```
  Returns:
  
  the head of the File queue but does not remove it
- poll
```
public File poll()
```
  Returns:
  
  the head of the File queue and removes it
- waitForStopFile
```
public void waitForStopFile()
```
  Wait until the Stop file is created
- checkFiles
```
protected boolean checkFiles()
```
  Check Files
  
  Returns:
  
  False to stop
- checkOneDir
```
protected boolean checkOneDir(boolean fileItemsChanged,
                              File directory)
```
  Parameters:
  
  fileItemsChanged -
  
  directory -
  
  Returns:
  
  True if one file at least has changed
- main
```
public static void main(String[] args)
```

Class FileMonitor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

defaultDigestAlgo

MINIMAL_DELAY

DEFAULT_DELAY

DEFAULT_CHECK_DELAY

future

internalfuture

stopped

name

statusFile

stopFile

directories

digest

elapseTime

elapseWaarpTime

checkDelay

timer

timerWaarp

scanSubDir

ignoreAlreadyUsed

initialized

checkFile

fileItems

lastFileItems

filter

commandValidFile

commandValidFileFactory

executor

fixedThreadPool

commandRemovedFile

commandCheckIteration

toUse

results

globalok

globalerror

todayok

todayerror

nextDay

Constructor Detail

FileMonitor

Method Detail

setNextDay

setCommandCheckIteration

setCommandValidFileFactory

getElapseWaarpTime

setElapseWaarpTime

isIgnoreAlreadyUsed

setIgnoreAlreadyUsed

setCheckDelay

addDirectory

removeDirectory

setThreadName

reloadStatus

initialized

saveStatus

getCurrentHistoryNb

setNextAsFullStatus

getStatus

getElapseTime

setElapseTime

setFilter

start

stop

peek

poll

waitForStopFile

checkFiles

checkOneDir

main