public class FileConnector extends 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.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 |
createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, dispatcherFactory, dispatcherPoolFactory, dispatchers, initialStateStopped, lifecycleManager, muleContext, muleMessageFactory, name, numberOfConcurrentTransactedReceivers, PROPERTY_POLLING_FREQUENCY, receivers, requesterFactory, requesters, serviceDescriptor, serviceOverrides, sessionHandler, startOnConnect
INT_VALUE_NOT_SET
PHASE_NAME
Constructor and Description |
---|
FileConnector(MuleContext context) |
Modifier and Type | Method and Description |
---|---|
protected void |
configureDispatcherPool() |
MuleMessageFactory |
createMuleMessageFactory()
Create a
MuleMessageFactory from this connector's configuration,
typically through the transport descriptor. |
MessageReceiver |
createReceiver(FlowConstruct flowConstruct,
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()
Template method where any connections should be made for the connector
|
protected void |
doDisconnect()
Template method where any connected resources used by the connector should be
disconnected
|
protected void |
doDispose()
Template method to perform any work when destroying the connectoe
|
protected void |
doInitialise() |
protected void |
doStart()
Template method to perform any work when starting the connectoe
|
protected void |
doStop()
Template method to perform any work when stopping the connectoe
|
boolean |
getCheckFileAge() |
long |
getFileAge() |
FilenameParser |
getFilenameParser() |
String |
getMoveToDirectory() |
String |
getMoveToPattern() |
String |
getOutputPattern() |
FileOutputStream |
getOutputStream() |
OutputStream |
getOutputStream(OutboundEndpoint endpoint,
MuleEvent event)
Well get the output stream (if any) for this type of transport.
|
long |
getPollingFrequency() |
String |
getProtocol() |
String |
getReadFromDirectory() |
protected Object |
getReceiverKey(FlowConstruct flowConstruct,
InboundEndpoint endpoint)
The method determines the key used to store the receiver against.
|
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)
Configures the maximum number of dispatchers that can be concurrently active
per endpoint
|
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) |
borrowDispatcher, clearDispatchers, clearRequesters, connect, createDefaultRedeliveryPolicy, createDispatcherMessageProcessor, createOperationResource, createScheduler, destroyReceiver, disconnect, dispose, disposeReceivers, disposeWorkManagers, doUnregisterListener, 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, 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
public static final String FILE
public static final String PROPERTY_FILE_AGE
public static final String PROPERTY_MOVE_TO_PATTERN
public static final String PROPERTY_MOVE_TO_DIRECTORY
public static final String PROPERTY_READ_FROM_DIRECTORY
public static final String PROPERTY_OUTPUT_PATTERN
public static final String PROPERTY_FILENAME
public static final String PROPERTY_ORIGINAL_FILENAME
public static final String PROPERTY_ORIGINAL_DIRECTORY
public static final String PROPERTY_DIRECTORY
public static final String PROPERTY_SOURCE_FILENAME
public static final String PROPERTY_SOURCE_DIRECTORY
public static final String PROPERTY_WRITE_TO_DIRECTORY
public static final String PROPERTY_FILE_SIZE
public static final String PROPERTY_FILE_TIMESTAMP
public static final long DEFAULT_POLLING_FREQUENCY
public FilenameParser filenameParser
public FileConnector(MuleContext context)
protected void configureDispatcherPool()
configureDispatcherPool
in class AbstractConnector
public void setMaxDispatchersActive(int value)
AbstractConnector
setMaxDispatchersActive
in class AbstractConnector
value
- max. number of active dispatchersprotected Object getReceiverKey(FlowConstruct flowConstruct, InboundEndpoint endpoint)
AbstractConnector
getReceiverKey
in class AbstractConnector
flowConstruct
- the service for which the endpoint is being registeredendpoint
- the endpoint being registered for the servicepublic MessageReceiver createReceiver(FlowConstruct flowConstruct, InboundEndpoint endpoint) throws Exception
createReceiver
in class AbstractConnector
flowConstruct
- the service that will receive events from this receiver, the
listenerendpoint
- the endpoint that defies this inbound communicationTransportServiceDescriptor
initialised using the service and endpoint.Exception
- if there is a problem creating the receiver. This exception
really depends on the underlying transport, thus any exception
could be thrownpublic String getProtocol()
public FilenameParser getFilenameParser()
public void setFilenameParser(FilenameParser filenameParser)
protected void doDispose()
AbstractConnector
doDispose
in class AbstractConnector
protected void doInitialise() throws InitialisationException
doInitialise
in class AbstractConnector
InitialisationException
protected void doConnect() throws Exception
AbstractConnector
doConnect
in class AbstractConnector
Exception
protected void doDisconnect() throws Exception
AbstractConnector
doDisconnect
in class AbstractConnector
Exception
protected void doStart() throws MuleException
AbstractConnector
doStart
in class AbstractConnector
MuleException
- if the method failsprotected void doStop() throws MuleException
AbstractConnector
doStop
in class AbstractConnector
MuleException
- if the method failspublic String getMoveToDirectory()
public void setMoveToDirectory(String dir)
public void setWorkDirectory(String workDirectoryName) throws IOException
IOException
public String getWorkDirectory()
public void setWorkFileNamePattern(String workFileNamePattern)
public String getWorkFileNamePattern()
public boolean isOutputAppend()
public void setOutputAppend(boolean outputAppend)
public String getOutputPattern()
public void setOutputPattern(String outputPattern)
public FileOutputStream getOutputStream()
public void setOutputStream(FileOutputStream outputStream)
public long getPollingFrequency()
public void setPollingFrequency(long pollingFrequency)
public long getFileAge()
public boolean getCheckFileAge()
public void setFileAge(long fileAge)
public String getWriteToDirectory()
public void setWriteToDirectory(String dir) throws IOException
IOException
public String getReadFromDirectory()
public void setReadFromDirectory(String dir) throws IOException
IOException
public boolean isSerialiseObjects()
public void setSerialiseObjects(boolean serialiseObjects)
public boolean isAutoDelete()
public void setAutoDelete(boolean autoDelete)
public String getMoveToPattern()
public void setMoveToPattern(String moveToPattern)
public OutputStream getOutputStream(OutboundEndpoint endpoint, MuleEvent event) throws MuleException
getOutputStream
in interface Connector
getOutputStream
in class AbstractConnector
endpoint
- the endpoint that releates to this Dispatcherevent
- the current event being processedMuleException
protected void move(File sourceFile, File destinationFile) throws DefaultMuleException
DefaultMuleException
public boolean isStreaming()
public void setStreaming(boolean streaming)
public MuleMessageFactory createMuleMessageFactory() throws CreateException
AbstractConnector
Create a MuleMessageFactory
from this connector's configuration,
typically through the transport descriptor.
MuleMessage
instances.createMuleMessageFactory
in interface Connector
createMuleMessageFactory
in class AbstractConnector
CreateException
MessageReceiver.createMuleMessage(Object)
,
MessageReceiver.createMuleMessage(Object, String)
public boolean isRecursive()
public void setRecursive(boolean recursive)
Copyright © 2003–2015 MuleSoft, Inc.. All rights reserved.