org.mule.providers.file
Class FileConnector

java.lang.Object
  extended byorg.mule.providers.AbstractConnector
      extended byorg.mule.providers.AbstractServiceEnabledConnector
          extended byorg.mule.providers.file.FileConnector
All Implemented Interfaces:
Disposable, java.beans.ExceptionListener, Initialisable, Startable, Stoppable, UMOConnector

public class FileConnector
extends AbstractServiceEnabledConnector

FileConnector is used for setting up listeners on a directory and for writing files to a directory. The connecotry provides support for defining file output patterns and filters for receiving files.

Version:
$Revision: 1.4 $
Author:
Ross Mason

Field Summary
 FilenameParser filenameParser
           
static java.lang.String PROPERTY_DELETE_ON_READ
           
static java.lang.String PROPERTY_DIRECTORY
           
static java.lang.String PROPERTY_FILENAME
           
static java.lang.String PROPERTY_MOVE_TO_DIRECTORY
           
static java.lang.String PROPERTY_MOVE_TO_PATTERN
           
static java.lang.String PROPERTY_ORIGINAL_FILENAME
           
static java.lang.String PROPERTY_OUTPUT_PATTERN
           
static java.lang.String PROPERTY_POLLING_FREQUENCY
           
 
Fields inherited from class org.mule.providers.AbstractServiceEnabledConnector
serviceDescriptor, serviceOverrides
 
Fields inherited from class org.mule.providers.AbstractConnector
DEFAULT_RETRY_COUNT, DEFAULT_RETRY_FREQUENCY, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, exceptionListener, initialised, name, receivers, started
 
Constructor Summary
FileConnector()
           
 
Method Summary
 UMOMessageReceiver createReceiver(UMOComponent component, UMOEndpoint endpoint)
          Registers a listener for a particular directory The following properties can be overriden in the endpoint declaration moveToDirectory filterPatterns filterClass pollingFrequency
protected  void disposeConnector()
          Template method to perform any work when destroying the connectoe
 FilenameParser getFilenameParser()
           
 java.lang.String getMoveToDirectory()
           
 java.lang.String getMoveToPattern()
           
 java.lang.String getOutputFilename()
           
 java.lang.String getOutputPattern()
           
 java.io.FileOutputStream getOutputStream()
           
 long getPollingFrequency()
           
 java.lang.String getProtocol()
           
 java.lang.String getWriteToDirectory()
           
 boolean isAutoDelete()
           
 boolean isOutputAppend()
           
 boolean isSerialiseObjects()
           
 void setAutoDelete(boolean autoDelete)
           
 void setFilenameParser(FilenameParser filenameParser)
           
 void setMoveToDirectory(java.lang.String dir)
           
 void setMoveToPattern(java.lang.String moveToPattern)
           
 void setOutputAppend(boolean outputAppend)
           
 void setOutputFilename(java.lang.String outputFilename)
           
 void setOutputPattern(java.lang.String outputPattern)
           
 void setOutputStream(java.io.FileOutputStream outputStream)
           
 void setPollingFrequency(long pollingFrequency)
           
 void setSerialiseObjects(boolean serialiseObjects)
           
 void setWriteToDirectory(java.lang.String dir)
           
protected  void stopConnector()
          Template method to perform any work when stopping the connectoe
 
Methods inherited from class org.mule.providers.AbstractServiceEnabledConnector
doInitialise, getMessageAdapter, getServiceDescriptor, getServiceOverrides, initFromServiceDescriptor, initialiseFromUrl, setServiceOverrides
 
Methods inherited from class org.mule.providers.AbstractConnector
checkDisposed, createDispatcher, destroyReceiver, dispose, exceptionThrown, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcher, getDispatcherFactory, getDispatchers, getDispatcherThreadingProfile, getExceptionListener, getName, getReceiverKey, getReceiverThreadingProfile, getReplyToHandler, getRetryCount, getRetryFrequency, handleException, initialise, isDisposed, isDisposeDispatcherOnCompletion, isStarted, registerListener, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setDisposeDispatcherOnCompletion, setExceptionListener, setName, setReceiverThreadingProfile, setRetryCount, setRetryFrequency, start, startConnector, stop, unregisterListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_POLLING_FREQUENCY

public static final java.lang.String PROPERTY_POLLING_FREQUENCY
See Also:
Constant Field Values

PROPERTY_FILENAME

public static final java.lang.String PROPERTY_FILENAME
See Also:
Constant Field Values

PROPERTY_ORIGINAL_FILENAME

public static final java.lang.String PROPERTY_ORIGINAL_FILENAME
See Also:
Constant Field Values

PROPERTY_OUTPUT_PATTERN

public static final java.lang.String PROPERTY_OUTPUT_PATTERN
See Also:
Constant Field Values

PROPERTY_MOVE_TO_PATTERN

public static final java.lang.String PROPERTY_MOVE_TO_PATTERN
See Also:
Constant Field Values

PROPERTY_MOVE_TO_DIRECTORY

public static final java.lang.String PROPERTY_MOVE_TO_DIRECTORY
See Also:
Constant Field Values

PROPERTY_DELETE_ON_READ

public static final java.lang.String PROPERTY_DELETE_ON_READ
See Also:
Constant Field Values

PROPERTY_DIRECTORY

public static final java.lang.String PROPERTY_DIRECTORY
See Also:
Constant Field Values

filenameParser

public FilenameParser filenameParser
Constructor Detail

FileConnector

public FileConnector()
Method Detail

createReceiver

public UMOMessageReceiver createReceiver(UMOComponent component,
                                         UMOEndpoint endpoint)
                                  throws java.lang.Exception
Registers a listener for a particular directory The following properties can be overriden in the endpoint declaration

Overrides:
createReceiver in class AbstractServiceEnabledConnector
Throws:
java.lang.Exception

stopConnector

protected void stopConnector()
                      throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when stopping the connectoe

Overrides:
stopConnector in class AbstractConnector
Throws:
UMOException - if the method fails

getProtocol

public java.lang.String getProtocol()
Specified by:
getProtocol in interface UMOConnector
Specified by:
getProtocol in class AbstractConnector

getFilenameParser

public FilenameParser getFilenameParser()

setFilenameParser

public void setFilenameParser(FilenameParser filenameParser)

disposeConnector

protected void disposeConnector()
Description copied from class: AbstractConnector
Template method to perform any work when destroying the connectoe

Overrides:
disposeConnector in class AbstractConnector

getMoveToDirectory

public java.lang.String getMoveToDirectory()
Returns:
Returns the moveToDirectoryName.

setMoveToDirectory

public void setMoveToDirectory(java.lang.String dir)
                        throws java.io.IOException
Parameters:
dir - The moveToDirectoryName to set.
Throws:
java.io.IOException

isOutputAppend

public boolean isOutputAppend()
Returns:
Returns the outputAppend.

setOutputAppend

public void setOutputAppend(boolean outputAppend)
Parameters:
outputAppend - The outputAppend to set.

getOutputFilename

public java.lang.String getOutputFilename()
Returns:
Returns the outputFilename.

setOutputFilename

public void setOutputFilename(java.lang.String outputFilename)
Parameters:
outputFilename - The outputFilename to set.

getOutputPattern

public java.lang.String getOutputPattern()
Returns:
Returns the outputPattern.

setOutputPattern

public void setOutputPattern(java.lang.String outputPattern)
Parameters:
outputPattern - The outputPattern to set.

getOutputStream

public java.io.FileOutputStream getOutputStream()
Returns:
Returns the outputStream.

setOutputStream

public void setOutputStream(java.io.FileOutputStream outputStream)
Parameters:
outputStream - The outputStream to set.

getPollingFrequency

public long getPollingFrequency()
Returns:
Returns the pollingFrequency.

setPollingFrequency

public void setPollingFrequency(long pollingFrequency)
Parameters:
pollingFrequency - The pollingFrequency to set.

getWriteToDirectory

public java.lang.String getWriteToDirectory()
Returns:
Returns the writeToDirectory.

setWriteToDirectory

public void setWriteToDirectory(java.lang.String dir)
                         throws java.io.IOException
Parameters:
dir - The writeToDirectory to set.
Throws:
java.io.IOException

isSerialiseObjects

public boolean isSerialiseObjects()

setSerialiseObjects

public void setSerialiseObjects(boolean serialiseObjects)

isAutoDelete

public boolean isAutoDelete()

setAutoDelete

public void setAutoDelete(boolean autoDelete)

getMoveToPattern

public java.lang.String getMoveToPattern()

setMoveToPattern

public void setMoveToPattern(java.lang.String moveToPattern)


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.