org.mule.extension.ftp.internal.source

Class FtpDirectoryListener

java.lang.Object

org.mule.runtime.extension.api.runtime.source.Source<T,A>

org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,FtpFileAttributes>

org.mule.extension.ftp.internal.source.FtpDirectoryListener

@MediaType(value="*/*",
           strict=false)
 @DisplayName(value="On New or Updated File")
 @Summary(value="Triggers when a new file is created in a directory")
 @Alias(value="listener")
public class FtpDirectoryListener
extends org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,FtpFileAttributes>

Polls a directory looking for files that have been created on it. One message will be generated for each file that is found.

The key part of this functionality is how to determine that a file is actually new. There're three strategies for that:

• Set the autoDelete parameter to true: This will delete each processed file after it has been processed, causing all files obtained in the next poll to be necessarily new
• Set moveToDirectory parameter: This will move each processed file to a different directory after it has been processed, achieving the same effect as autoDelete but without loosing the file
• Use the watermarkEnabled parameter to only pick files that have been created or updated after the last poll was executed.

A matcher can also be used for additional filtering of files.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
FtpDirectoryListener()

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
void	onError(PostActionGroup postAction, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext ctx)
void	onRejectedItem(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FtpFileAttributes> result, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)
void	onSuccess(PostActionGroup postAction, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext ctx)
void	onTerminate(org.mule.runtime.extension.api.runtime.source.SourceCallbackContext ctx)
void	poll(org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,FtpFileAttributes> pollContext)

Methods inherited from class org.mule.runtime.extension.api.runtime.source.PollingSource

onStart, onStop

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpDirectoryListener

public FtpDirectoryListener()

Method Detail

doStart

protected void doStart()

Specified by:

doStart in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,FtpFileAttributes>

doStop

protected void doStop()

Specified by:

doStop in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,FtpFileAttributes>

onSuccess

@OnSuccess
public void onSuccess(@ParameterGroup(name="Post processing action")
                                 PostActionGroup postAction,
                                 org.mule.runtime.extension.api.runtime.source.SourceCallbackContext ctx)

onError

@OnError
public void onError(@ParameterGroup(name="Post processing action")
                             PostActionGroup postAction,
                             org.mule.runtime.extension.api.runtime.source.SourceCallbackContext ctx)

onTerminate

@OnTerminate
public void onTerminate(org.mule.runtime.extension.api.runtime.source.SourceCallbackContext ctx)

poll

public void poll(org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,FtpFileAttributes> pollContext)

Specified by:

poll in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,FtpFileAttributes>

onRejectedItem

public void onRejectedItem(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FtpFileAttributes> result,
                           org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)

Specified by:

onRejectedItem in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,FtpFileAttributes>