|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mule.providers.AbstractConnector
org.mule.providers.file.FileConnector
public class FileConnector
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 | |
---|---|
static long |
DEFAULT_POLLING_FREQUENCY
|
FilenameParser |
filenameParser
|
static String |
PROPERTY_DELETE_ON_READ
|
static String |
PROPERTY_DIRECTORY
|
static String |
PROPERTY_FILE_AGE
|
static String |
PROPERTY_FILE_SIZE
|
static String |
PROPERTY_FILENAME
|
static String |
PROPERTY_MOVE_TO_DIRECTORY
|
static String |
PROPERTY_MOVE_TO_PATTERN
|
static String |
PROPERTY_ORIGINAL_FILENAME
|
static String |
PROPERTY_OUTPUT_PATTERN
|
static String |
PROPERTY_POLLING_FREQUENCY
|
static String |
PROPERTY_SERVICE_OVERRIDE
|
static String |
PROPERTY_WRITE_TO_DIRECTORY
|
Fields inherited from interface org.mule.umo.provider.UMOConnector |
---|
INT_VALUE_NOT_SET |
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 |
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(UMOImmutableEndpoint endpoint,
UMOMessage message)
Well get the output stream (if any) for this type of transport. |
long |
getPollingFrequency()
|
String |
getProtocol()
|
protected Object |
getReceiverKey(UMOComponent component,
UMOEndpoint endpoint)
The method determines the key used to store the receiver against. |
String |
getWriteToDirectory()
|
boolean |
isAutoDelete()
|
boolean |
isOutputAppend()
|
boolean |
isSerialiseObjects()
|
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 |
setSerialiseObjects(boolean serialiseObjects)
|
void |
setWriteToDirectory(String dir)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String PROPERTY_POLLING_FREQUENCY
public static final String PROPERTY_FILE_AGE
public static final String PROPERTY_FILENAME
public static final String PROPERTY_ORIGINAL_FILENAME
public static final String PROPERTY_OUTPUT_PATTERN
public static final String PROPERTY_MOVE_TO_PATTERN
public static final String PROPERTY_MOVE_TO_DIRECTORY
public static final String PROPERTY_DELETE_ON_READ
public static final String PROPERTY_DIRECTORY
public static final String PROPERTY_SERVICE_OVERRIDE
public static final String PROPERTY_WRITE_TO_DIRECTORY
public static final String PROPERTY_FILE_SIZE
public static final long DEFAULT_POLLING_FREQUENCY
public FilenameParser filenameParser
Constructor Detail |
---|
public FileConnector()
Method Detail |
---|
public void setMaxDispatchersActive(int value)
AbstractConnector
setMaxDispatchersActive
in class AbstractConnector
value
- max. number of active dispatchersprotected Object getReceiverKey(UMOComponent component, UMOEndpoint endpoint)
AbstractConnector
getReceiverKey
in class AbstractConnector
component
- the component for which the endpoint is being registeredendpoint
- the endpoint being registered for the component
public UMOMessageReceiver createReceiver(UMOComponent component, UMOEndpoint endpoint) throws Exception
createReceiver
in class AbstractConnector
component
- the component that will receive events from this receiver,
the listenerendpoint
- the endpoint that defies this inbound communication
TransportServiceDescriptor
initialised using the component 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 UMOException
AbstractConnector
doStart
in class AbstractConnector
UMOException
- if the method failsprotected void doStop() throws UMOException
AbstractConnector
doStop
in class AbstractConnector
UMOException
- if the method failspublic String getMoveToDirectory()
public void setMoveToDirectory(String dir)
dir
- The moveToDirectoryName to set.public boolean isOutputAppend()
public void setOutputAppend(boolean outputAppend)
outputAppend
- The outputAppend to set.public String getOutputPattern()
public void setOutputPattern(String outputPattern)
outputPattern
- The outputPattern to set.public FileOutputStream getOutputStream()
public void setOutputStream(FileOutputStream outputStream)
outputStream
- The outputStream to set.public long getPollingFrequency()
public void setPollingFrequency(long pollingFrequency)
pollingFrequency
- The pollingFrequency to set.public long getFileAge()
public boolean getCheckFileAge()
public void setFileAge(long fileAge)
fileAge
- The fileAge in milliseconds to set.public String getWriteToDirectory()
public void setWriteToDirectory(String dir) throws IOException
dir
- The writeToDirectory to set.
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(UMOImmutableEndpoint endpoint, UMOMessage message) throws UMOException
getOutputStream
in interface UMOConnector
getOutputStream
in class AbstractConnector
endpoint
- the endpoint that releates to this Dispatchermessage
- the current message being processed
UMOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |