org.jboss.soa.esb.listeners.gateway
Class AbstractFileGateway

java.lang.Object
  org.jboss.soa.esb.listeners.lifecycle.AbstractManagedLifecycle
      org.jboss.soa.esb.listeners.lifecycle.AbstractScheduledManagedLifecycle
          org.jboss.soa.esb.listeners.gateway.AbstractFileGateway

All Implemented Interfaces:

ManagedLifecycle

Direct Known Subclasses:

FileGatewayListener

public abstract class AbstractFileGateway
extends AbstractScheduledManagedLifecycle

Base class for all file gateways: local filesystem, ftp, sftp and ftps.

Implementations for file manipulation (getFileList, getFileContents, renameFile and deleteFile) must be provided by factory

Since:

Version 4.0

Author:

schifest@heuristica.com.ar

Field Summary

protected boolean	_deleteAfterOK
protected java.io.File	_errorDirectory
protected java.lang.String	_errorSuffix
protected java.io.File	_inputDirectory
protected java.lang.String	_inputSuffix
protected static org.apache.log4j.Logger	_logger
protected long	_maxMillisForResponse
protected java.io.File	_postProcessDirectory
protected java.lang.String	_postProcessSuffix
protected boolean	_renameAfterOK
protected java.lang.String	_workingSuffix
protected ConfigTree	config
protected MessageComposer	messageComposer
protected ServiceInvoker	serviceInvoker
protected Service	targetService

Fields inherited from class org.jboss.soa.esb.listeners.lifecycle.AbstractManagedLifecycle

PARAM_TERMINATION_PERIOD

Constructor Summary

protected

AbstractFileGateway(ConfigTree config)

Method Summary

protected void	checkInputSuffix()
protected void	doInitialise() Handle the initialisation of the managed instance.
static java.io.File	getFileInputDirectory(ConfigTree config)
protected java.io.File	getWorkFileName(java.io.File fileIn, java.lang.String suffix)
void	onSchedule() Execute on trigger from the scheduler.
protected java.io.File	setFileWorking(java.io.File file)

Methods inherited from class org.jboss.soa.esb.listeners.lifecycle.AbstractScheduledManagedLifecycle

doDestroy, doScheduledDestroy, doStart, doStop

Methods inherited from class org.jboss.soa.esb.listeners.lifecycle.AbstractManagedLifecycle

addManagedLifecycleEventListener, changeState, destroy, getConfig, getLifecycleController, getState, getTerminationPeriod, initialise, removeManagedLifecycleEventListener, start, stop, waitUntilDestroyed, waitUntilDestroyed, waitUntilNotState, waitUntilState

Methods inherited from class java.lang.Object

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

Field Detail

_logger

protected static final org.apache.log4j.Logger _logger

config

protected ConfigTree config

_maxMillisForResponse

protected long _maxMillisForResponse

targetService

protected Service targetService

serviceInvoker

protected ServiceInvoker serviceInvoker

messageComposer

protected MessageComposer messageComposer

_deleteAfterOK

protected boolean _deleteAfterOK

_renameAfterOK

protected boolean _renameAfterOK

_inputDirectory

protected java.io.File _inputDirectory

_errorDirectory

protected java.io.File _errorDirectory

_postProcessDirectory

protected java.io.File _postProcessDirectory

_inputSuffix

protected java.lang.String _inputSuffix

_postProcessSuffix

protected java.lang.String _postProcessSuffix

_workingSuffix

protected java.lang.String _workingSuffix

_errorSuffix

protected java.lang.String _errorSuffix

Constructor Detail

AbstractFileGateway

protected AbstractFileGateway(ConfigTree config)
                       throws ConfigurationException,
                              RegistryException,
                              GatewayException

Throws:

ConfigurationException

RegistryException

GatewayException

Method Detail

doInitialise

protected void doInitialise()
                     throws ManagedLifecycleException

Handle the initialisation of the managed instance.

Overrides:

doInitialise in class AbstractScheduledManagedLifecycle

Throws:

ManagedLifecycleException - for errors while initialisation.

onSchedule

public void onSchedule()
                throws SchedulingException

Execute on trigger from the scheduler.

Specified by:

onSchedule in class AbstractScheduledManagedLifecycle

Throws:

SchedulingException

setFileWorking

protected java.io.File setFileWorking(java.io.File file)

getWorkFileName

protected java.io.File getWorkFileName(java.io.File fileIn,
                                       java.lang.String suffix)

checkInputSuffix

protected void checkInputSuffix()
                         throws ConfigurationException

Throws:

ConfigurationException

getFileInputDirectory

public static java.io.File getFileInputDirectory(ConfigTree config)
                                          throws ConfigurationException

Throws:

ConfigurationException