jPOS 1.6.1 API Documentation

org.jpos.util
Class DirPoll

java.lang.Object
  extended by org.jpos.util.SimpleLogSource
      extended by org.jpos.util.DirPoll
All Implemented Interfaces:
java.io.FilenameFilter, java.lang.Runnable, Configurable, ReConfigurable, Destroyable, LogSource

public class DirPoll
extends SimpleLogSource
implements java.lang.Runnable, java.io.FilenameFilter, ReConfigurable, Destroyable

DirPoll operates on a set of directories which defaults to

scanning for incoming requests (of varying priorities) on the request directory and processing them by means of DirPoll.Processor or DirPoll.FileProcessor

Since:
jPOS 1.2.7
Version:
$Revision: 2594 $ $Date: 2008-01-22 08:41:31 -0800 (Tue, 22 Jan 2008) $
Author:
Alejandro P. Revilla, Matthew Milliss

Nested Class Summary
static class DirPoll.DirPollException
           
static interface DirPoll.FileProcessor
           
static interface DirPoll.Processor
           
 class DirPoll.ProcessorRunner
           
 
Constructor Summary
DirPoll()
           
 
Method Summary
 boolean accept(java.io.File dir, java.lang.String name)
           
 void addPriority(java.lang.String fileExtension)
           
 void createDirs()
           
 void destroy()
           
 java.lang.String getPath()
           
 long getPollInterval()
           
 boolean isPaused()
           
 void pause()
           
 void run()
           
 void setArchiveDateFormat(java.lang.String dateFormat)
           
 void setArchiveDir(java.lang.String dir)
           
 void setBadDir(java.lang.String dir)
           
 void setConfiguration(Configuration cfg)
          DirPool is not really Configurable, it uses QSPConfig instead but anyway it receives Configuration and ReConfiguration requests and pass along them to the underlying processor.
 void setPath(java.lang.String base)
           
 void setPollInterval(long pollInterval)
           
 void setPriorities(java.lang.String priorities)
           
 void setProcessor(java.lang.Object processor)
           
 void setRequestDir(java.lang.String dir)
           
 void setResponseDir(java.lang.String dir)
           
 void setResponseSuffix(java.lang.String suffix)
           
 void setRunDir(java.lang.String dir)
           
 void setShouldArchive(boolean shouldArchive)
           
 void setShouldTimestampArchive(boolean shouldTimestampArchive)
           
 void setThreadPool(ThreadPool pool)
           
 void setTmpDir(java.lang.String dir)
           
 void unpause()
           
 
Methods inherited from class org.jpos.util.SimpleLogSource
error, error, getLogger, getRealm, info, info, setLogger, setRealm, warning, warning
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirPoll

public DirPoll()
Parameters:
basePath - base path of DirPoll tree
pool - ThreadPoll (may be null)
Method Detail

setPath

public void setPath(java.lang.String base)

setShouldTimestampArchive

public void setShouldTimestampArchive(boolean shouldTimestampArchive)

setArchiveDateFormat

public void setArchiveDateFormat(java.lang.String dateFormat)

setShouldArchive

public void setShouldArchive(boolean shouldArchive)

getPath

public java.lang.String getPath()

setRequestDir

public void setRequestDir(java.lang.String dir)

setResponseDir

public void setResponseDir(java.lang.String dir)

setTmpDir

public void setTmpDir(java.lang.String dir)

setBadDir

public void setBadDir(java.lang.String dir)

setRunDir

public void setRunDir(java.lang.String dir)

setArchiveDir

public void setArchiveDir(java.lang.String dir)

setPollInterval

public void setPollInterval(long pollInterval)

setResponseSuffix

public void setResponseSuffix(java.lang.String suffix)

getPollInterval

public long getPollInterval()

setProcessor

public void setProcessor(java.lang.Object processor)

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException
DirPool is not really Configurable, it uses QSPConfig instead but anyway it receives Configuration and ReConfiguration requests and pass along them to the underlying processor.

Specified by:
setConfiguration in interface Configurable
Parameters:
cfg - Configuration object
Throws:
ConfigurationException

setPriorities

public void setPriorities(java.lang.String priorities)
Parameters:
priorities - blank separated list of extensions

setThreadPool

public void setThreadPool(ThreadPool pool)

accept

public boolean accept(java.io.File dir,
                      java.lang.String name)
Specified by:
accept in interface java.io.FilenameFilter

run

public void run()
Specified by:
run in interface java.lang.Runnable

destroy

public void destroy()
Specified by:
destroy in interface Destroyable

createDirs

public void createDirs()

addPriority

public void addPriority(java.lang.String fileExtension)

pause

public void pause()

unpause

public void unpause()

isPaused

public boolean isPaused()

jPOS.org