org.mule.transport.file

Class FileConnector

java.lang.Object

org.mule.AbstractAnnotatedObject

org.mule.transport.AbstractConnector

org.mule.transport.file.FileConnector

All Implemented Interfaces:

EventListener, javax.resource.spi.work.WorkListener, org.mule.api.AnnotatedObject, org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Lifecycle, org.mule.api.lifecycle.LifecycleStateEnabled, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.NameableObject, org.mule.api.NamedObject, org.mule.api.transport.Connectable, org.mule.api.transport.Connector

public class FileConnector
extends org.mule.transport.AbstractConnector

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.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_POLLING_FREQUENCY
static String	FILE
FilenameParser	filenameParser
static String	PROPERTY_DIRECTORY
static String	PROPERTY_FILE_AGE
static String	PROPERTY_FILE_SIZE
static String	PROPERTY_FILE_TIMESTAMP
static String	PROPERTY_FILENAME
static String	PROPERTY_MOVE_TO_DIRECTORY
static String	PROPERTY_MOVE_TO_PATTERN
static String	PROPERTY_ORIGINAL_DIRECTORY
static String	PROPERTY_ORIGINAL_FILENAME
static String	PROPERTY_OUTPUT_PATTERN
static String	PROPERTY_READ_FROM_DIRECTORY
static String	PROPERTY_SOURCE_DIRECTORY
static String	PROPERTY_SOURCE_FILENAME
static String	PROPERTY_WRITE_TO_DIRECTORY

Fields inherited from class org.mule.transport.AbstractConnector

connecting, createMultipleTransactedReceivers, DEFAULT_CONTEXT_START_TIMEOUT, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatcherPoolFactory, dispatchers, initialStateStopped, lifecycleManager, MULE_CONTEXT_START_TIMEOUT_SYSTEM_PROPERTY, muleContext, muleMessageFactory, name, numberOfConcurrentTransactedReceivers, PROPERTY_POLLING_FREQUENCY, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, startOnConnect

Fields inherited from interface org.mule.api.transport.Connector

INT_VALUE_NOT_SET

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
FileConnector(org.mule.api.MuleContext context)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureDispatcherPool()
org.mule.api.transport.MuleMessageFactory	createMuleMessageFactory()
org.mule.api.transport.MessageReceiver	createReceiver(org.mule.api.construct.FlowConstruct flowConstruct, org.mule.api.endpoint.InboundEndpoint endpoint) Registers a listener for a particular directory The following properties can be overriden in the endpoint declaration moveToDirectory filterPatterns filterClass pollingFrequency
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispose()
protected void	doInitialise()
protected void	doStart()
protected void	doStop()
boolean	getCheckFileAge()
long	getFileAge()
FilenameParser	getFilenameParser()
String	getMoveToDirectory()
String	getMoveToPattern()
String	getOutputPattern()
FileOutputStream	getOutputStream()
OutputStream	getOutputStream(org.mule.api.endpoint.OutboundEndpoint endpoint, org.mule.api.MuleEvent event) Well get the output stream (if any) for this type of transport.
long	getPollingFrequency()
String	getProtocol()
String	getReadFromDirectory()
protected Object	getReceiverKey(org.mule.api.construct.FlowConstruct flowConstruct, org.mule.api.endpoint.InboundEndpoint endpoint)
String	getWorkDirectory()
String	getWorkFileNamePattern()
String	getWriteToDirectory()
boolean	isAutoDelete()
boolean	isOutputAppend()
boolean	isRecursive()
boolean	isSerialiseObjects()
boolean	isStreaming()
protected void	move(File sourceFile, File destinationFile)
void	setAutoDelete(boolean autoDelete)
void	setFileAge(long fileAge)
void	setFilenameParser(FilenameParser filenameParser)
void	setMaxDispatchersActive(int value)
void	setMoveToDirectory(String dir)
void	setMoveToPattern(String moveToPattern)
void	setOutputAppend(boolean outputAppend)
void	setOutputPattern(String outputPattern)
void	setOutputStream(FileOutputStream outputStream)
void	setPollingFrequency(long pollingFrequency)
void	setReadFromDirectory(String dir)
void	setRecursive(boolean recursive)
void	setSerialiseObjects(boolean serialiseObjects)
void	setStreaming(boolean streaming)
void	setWorkDirectory(String workDirectoryName)
void	setWorkFileNamePattern(String workFileNamePattern)
void	setWriteToDirectory(String dir)

Methods inherited from class org.mule.transport.AbstractConnector

borrowDispatcher, clearDispatchers, clearRequesters, connect, connectConnectorAndReceivers, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createOperationResource, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, fireNotification, fireNotification, getCanonicalURI, getConnectEventId, getConnectionDescription, getDefaultExchangePattern, getDefaultInboundTransformers, getDefaultOutboundTransformers, getDefaultResponseTransformers, getDispatcherFactory, getDispatcherPoolFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getInboundExchangePatterns, getLifecycleState, getMaxDispatchersActive, getMaxRequestersActive, getMaxTotalDispatchers, getMuleContext, getMuleMessageFactory, getName, getNumberOfConcurrentTransactedReceivers, getOperationResourceFactory, getOutboundExchangePatterns, getReceiver, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getRequesterFactory, getRequesterThreadingProfile, getRequesterWorkManager, getRetryPolicyTemplate, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getSupportedProtocols, getTransactionalResource, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, initWorkManagers, isConnected, isConnecting, isCreateMultipleTransactedReceivers, isDisposed, isEnableMessageEvents, isEnableMessageEvents, isInitialised, isInitialStateStopped, isResponseEnabled, isStarted, isStarting, isStopped, isStopping, isValidateConnections, lookupReceiver, registerListener, registerSupportedMetaProtocol, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, request, request, returnDispatcher, setConnected, setConnecting, setCreateMultipleTransactedReceivers, setDispatcherFactory, setDispatcherPoolFactory, setDispatcherPoolMaxWait, setDispatcherPoolWhenExhaustedAction, setDispatcherThreadingProfile, setDynamicNotification, setInitialStateStopped, setMaxRequestersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setRequesterFactory, setRequesterPoolMaxWait, setRequesterPoolWhenExhaustedAction, setRequesterThreadingProfile, setRetryPolicyTemplate, setServiceOverrides, setSessionHandler, setSupportedProtocols, setupDispatchReturn, setupRequestReturn, setValidateConnections, shutdownScheduler, start, startAfterConnect, stop, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, updateCachedNotificationHandler, validateConnection, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class org.mule.AbstractAnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Field Detail

FILE

public static final String FILE

See Also:

Constant Field Values

PROPERTY_FILE_AGE

public static final String PROPERTY_FILE_AGE

See Also:

Constant Field Values

PROPERTY_MOVE_TO_PATTERN

public static final String PROPERTY_MOVE_TO_PATTERN

See Also:

Constant Field Values

PROPERTY_MOVE_TO_DIRECTORY

public static final String PROPERTY_MOVE_TO_DIRECTORY

See Also:

Constant Field Values

PROPERTY_READ_FROM_DIRECTORY

public static final String PROPERTY_READ_FROM_DIRECTORY

See Also:

Constant Field Values

PROPERTY_OUTPUT_PATTERN

public static final String PROPERTY_OUTPUT_PATTERN

See Also:

Constant Field Values

PROPERTY_FILENAME

public static final String PROPERTY_FILENAME

See Also:

Constant Field Values

PROPERTY_ORIGINAL_FILENAME

public static final String PROPERTY_ORIGINAL_FILENAME

See Also:

Constant Field Values

PROPERTY_ORIGINAL_DIRECTORY

public static final String PROPERTY_ORIGINAL_DIRECTORY

See Also:

Constant Field Values

PROPERTY_DIRECTORY

public static final String PROPERTY_DIRECTORY

See Also:

Constant Field Values

PROPERTY_SOURCE_FILENAME

public static final String PROPERTY_SOURCE_FILENAME

See Also:

Constant Field Values

PROPERTY_SOURCE_DIRECTORY

public static final String PROPERTY_SOURCE_DIRECTORY

See Also:

Constant Field Values

PROPERTY_WRITE_TO_DIRECTORY

public static final String PROPERTY_WRITE_TO_DIRECTORY

See Also:

Constant Field Values

PROPERTY_FILE_SIZE

public static final String PROPERTY_FILE_SIZE

See Also:

Constant Field Values

PROPERTY_FILE_TIMESTAMP

public static final String PROPERTY_FILE_TIMESTAMP

See Also:

Constant Field Values

DEFAULT_POLLING_FREQUENCY

public static final long DEFAULT_POLLING_FREQUENCY

See Also:

Constant Field Values

filenameParser

public FilenameParser filenameParser

Constructor Detail

FileConnector

public FileConnector(org.mule.api.MuleContext context)

Method Detail

configureDispatcherPool

protected void configureDispatcherPool()

Overrides:

configureDispatcherPool in class org.mule.transport.AbstractConnector

setMaxDispatchersActive

public void setMaxDispatchersActive(int value)

Overrides:

setMaxDispatchersActive in class org.mule.transport.AbstractConnector

getReceiverKey

protected Object getReceiverKey(org.mule.api.construct.FlowConstruct flowConstruct,
                    org.mule.api.endpoint.InboundEndpoint endpoint)

Overrides:

getReceiverKey in class org.mule.transport.AbstractConnector

createReceiver

public org.mule.api.transport.MessageReceiver createReceiver(org.mule.api.construct.FlowConstruct flowConstruct,
                                                    org.mule.api.endpoint.InboundEndpoint endpoint)
                                                      throws Exception

Registers a listener for a particular directory The following properties can be overriden in the endpoint declaration

• moveToDirectory
• filterPatterns
• filterClass
• pollingFrequency

Overrides:

createReceiver in class org.mule.transport.AbstractConnector

Throws:

Exception

getProtocol

public String getProtocol()

getFilenameParser

public FilenameParser getFilenameParser()

setFilenameParser

public void setFilenameParser(FilenameParser filenameParser)

doDispose

protected void doDispose()

Specified by:

doDispose in class org.mule.transport.AbstractConnector

doInitialise

protected void doInitialise()
                     throws org.mule.api.lifecycle.InitialisationException

Specified by:

doInitialise in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.lifecycle.InitialisationException

doConnect

protected void doConnect()
                  throws Exception

Specified by:

doConnect in class org.mule.transport.AbstractConnector

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class org.mule.transport.AbstractConnector

Throws:

Exception

doStart

protected void doStart()
                throws org.mule.api.MuleException

Specified by:

doStart in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.MuleException

doStop

protected void doStop()
               throws org.mule.api.MuleException

Specified by:

doStop in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.MuleException

getMoveToDirectory

public String getMoveToDirectory()

setMoveToDirectory

public void setMoveToDirectory(String dir)

setWorkDirectory

public void setWorkDirectory(String workDirectoryName)
                      throws IOException

Throws:

IOException

getWorkDirectory

public String getWorkDirectory()

setWorkFileNamePattern

public void setWorkFileNamePattern(String workFileNamePattern)

getWorkFileNamePattern

public String getWorkFileNamePattern()

isOutputAppend

public boolean isOutputAppend()

setOutputAppend

public void setOutputAppend(boolean outputAppend)

getOutputPattern

public String getOutputPattern()

setOutputPattern

public void setOutputPattern(String outputPattern)

getOutputStream

public FileOutputStream getOutputStream()

setOutputStream

public void setOutputStream(FileOutputStream outputStream)

getPollingFrequency

public long getPollingFrequency()

setPollingFrequency

public void setPollingFrequency(long pollingFrequency)

getFileAge

public long getFileAge()

getCheckFileAge

public boolean getCheckFileAge()

setFileAge

public void setFileAge(long fileAge)

getWriteToDirectory

public String getWriteToDirectory()

setWriteToDirectory

public void setWriteToDirectory(String dir)
                         throws IOException

Throws:

IOException

getReadFromDirectory

public String getReadFromDirectory()

setReadFromDirectory

public void setReadFromDirectory(String dir)
                          throws IOException

Throws:

IOException

isSerialiseObjects

public boolean isSerialiseObjects()

setSerialiseObjects

public void setSerialiseObjects(boolean serialiseObjects)

isAutoDelete

public boolean isAutoDelete()

setAutoDelete

public void setAutoDelete(boolean autoDelete)

getMoveToPattern

public String getMoveToPattern()

setMoveToPattern

public void setMoveToPattern(String moveToPattern)

getOutputStream

public OutputStream getOutputStream(org.mule.api.endpoint.OutboundEndpoint endpoint,
                           org.mule.api.MuleEvent event)
                             throws org.mule.api.MuleException

Well get the output stream (if any) for this type of transport. Typically this will be called only when Streaming is being used on an outbound endpoint

Specified by:

getOutputStream in interface org.mule.api.transport.Connector

Overrides:

getOutputStream in class org.mule.transport.AbstractConnector

Parameters:

endpoint - the endpoint that releates to this Dispatcher

event - the current event being processed

Returns:

the output stream to use for this request or null if the transport does not support streaming

Throws:

org.mule.api.MuleException

move

protected void move(File sourceFile,
        File destinationFile)
             throws org.mule.api.DefaultMuleException

Throws:

org.mule.api.DefaultMuleException

isStreaming

public boolean isStreaming()

setStreaming

public void setStreaming(boolean streaming)

createMuleMessageFactory

public org.mule.api.transport.MuleMessageFactory createMuleMessageFactory()
                                                                   throws org.mule.api.lifecycle.CreateException

Specified by:

createMuleMessageFactory in interface org.mule.api.transport.Connector

Overrides:

createMuleMessageFactory in class org.mule.transport.AbstractConnector

Throws:

org.mule.api.lifecycle.CreateException

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)