raccoon.core.file.endpoint.poller
Class FilePoller

java.lang.Object
  raccoon.core.types.AbsComponent
      raccoon.core.types.AbsLoadable
          raccoon.core.types.AbsConfigurableLoadable
              raccoon.core.file.endpoint.poller.FilePoller

All Implemented Interfaces:

IBaseComponent, IConfigurable, ILoadable, ILogable

public class FilePoller
extends AbsConfigurableLoadable

The Default File Poller for the Raccoon Framework.

Since:

Raccoon v1.0

Version:

$Id:$

Author:

Cedric ROUVRAIS

Field Summary

Fields inherited from class raccoon.core.types.AbsConfigurableLoadable

mConfigurableManager

Fields inherited from class raccoon.core.types.AbsLoadable

mIsLoaded

Fields inherited from class raccoon.core.types.AbsComponent

mIsInError

Constructor Summary

FilePoller()

Method Summary

void	configureParameters() Configures the various parameters for this component.
java.lang.String	getDoneFolder()
java.lang.String	getErrorFolder()
IEventHandler	getEventHandler()
java.lang.String	getInputFolder()
int	getNbDispatchers()
int	getPollingInterval()
java.lang.String	getRegexPattern()
java.lang.String	getWorkingFolder()
void	load() Loads or initializes the component.
void	setDoneFolder(java.lang.String pDoneFolder)
void	setErrorFolder(java.lang.String pErrorFolder)
void	setEventHandler(IEventHandler pEventHandler)
void	setInputFolder(java.lang.String pInputFolder)
void	setNbDispatchers(int pNbDispatchers)
void	setPollingInterval(int pPollingInterval)
void	setRegexPattern(java.lang.String pRegexPattern)
void	setWorkingFolder(java.lang.String pWorkingFolder)
void	unload() Unloads or deactivates the component.

Methods inherited from class raccoon.core.types.AbsConfigurableLoadable

isStable, setConfigurableManager, setLogger

Methods inherited from class raccoon.core.types.AbsLoadable

getLog, isInError, isInitialised, isRunning

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePoller

public FilePoller()

Method Detail

configureParameters

public void configureParameters()

Configures the various parameters for this component. This method should configure the instance of IConfigurableManager provided during the invocation of AbsConfigurableLoadable.setConfigurableManager(IConfigurableManager).

Specified by:

configureParameters in interface IConfigurable

Overrides:

configureParameters in class AbsConfigurableLoadable

load

public void load()
          throws java.lang.IllegalStateException,
                 LoadableException

Loads or initializes the component.

Specified by:

load in interface ILoadable

Overrides:

load in class AbsConfigurableLoadable

Throws:

LoadableException - if the component couldn't load itself.

java.lang.IllegalStateException - if the component isn't in a state to load itself. for example it is already loaded.

unload

public void unload()
            throws java.lang.IllegalStateException,
                   LoadableException

Unloads or deactivates the component. The invocation of this method should be used to clean up, if necessary, all used resources.

Specified by:

unload in interface ILoadable

Overrides:

unload in class AbsLoadable

Throws:

LoadableException - if the component couldn't unload itself.

java.lang.IllegalStateException - if this component isn't in a state to unload itself.

getInputFolder

public java.lang.String getInputFolder()

setInputFolder

public void setInputFolder(java.lang.String pInputFolder)
                    throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getWorkingFolder

public java.lang.String getWorkingFolder()

setWorkingFolder

public void setWorkingFolder(java.lang.String pWorkingFolder)
                      throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getDoneFolder

public java.lang.String getDoneFolder()

setDoneFolder

public void setDoneFolder(java.lang.String pDoneFolder)
                   throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getErrorFolder

public java.lang.String getErrorFolder()

setErrorFolder

public void setErrorFolder(java.lang.String pErrorFolder)
                    throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getNbDispatchers

public int getNbDispatchers()

setNbDispatchers

public void setNbDispatchers(int pNbDispatchers)
                      throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getPollingInterval

public int getPollingInterval()

setPollingInterval

public void setPollingInterval(int pPollingInterval)
                        throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getEventHandler

public IEventHandler getEventHandler()

setEventHandler

public void setEventHandler(IEventHandler pEventHandler)
                     throws ResourceNotFoundException

Throws:

ResourceNotFoundException

getRegexPattern

public java.lang.String getRegexPattern()

setRegexPattern

public void setRegexPattern(java.lang.String pRegexPattern)