Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INT-1552 added File filtering sections to FTP/SFTP

Browse Source
This commit is contained in:
Oleg Zhurakousky
2010-11-19 05:19:34 -05:00
parent 5257ee4daf
commit cd80bb96a4
3 changed files with 62 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
buildSrc

Submodule buildSrc updated: 9e53f9909d...2e7df56522

30
docs/src/reference/docbook/ftp.xml
View File

@@ -124,6 +124,36 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/ftps
Once the file has been transferred a Message with <classname>java.io.File</classname> being a payload will be generated and sent to the channel
identified with <code>channel</code> attribute.
</para>
<para>
<emphasis>File Filtering and Large Files</emphasis>
</para>
<para>
Some times the file that just appeared in the monitored (remote) directory is not complete. Typically such file
will be written with some temporary extension (e.g., foo.txt.writing) and then renamed after the writing process finished.
As a user in most cases you are only interested in files that are complete and would like to filter only files that are complete.
To handle these scenarios Spring Integration FTP support allows you to configure custom filters that will filter out only
the files that you need. The filter is based on <classname>org.springframework.integration.file.filters.FileListFilter</classname> interface.
We also provide a convenient Regex-based implementation <classname>org.springframework.integration.ftp.filters.FtpPatternMatchingFileListFilter</classname>.
Once configured all you need is include such filter in your adapter via 'filter' attribute.
<programlisting language="xml"><![CDATA[<int-ftp:inbound-channel-adapter
channel="ftpChannel"
client-factory="ftpClientFactory"
filter="fileNameFilter"
local-working-directory="file:/my_transfers">
<int:poller fixed-rate="1000"/>
</int-ftp:inbound-channel-adapter>
<bean id="fileNameFilter"
class="org.springframework.integration.ftp.filters.FtpPatternMatchingFileListFilt"">
<constructor-arg value=".*\.txt$"/>
</bean>]]></programlisting>
As an added convenience you may also use <code>filename-pattern</code> attribute instead of the explicit filter
configuration where you'll provide the filtering expression (Regex)
<programlisting language="xml"><![CDATA[filename-pattern=".*\.txt$"]]></programlisting>
</para>
</section>
<section id="ftp-outbound">

33
docs/src/reference/docbook/sftp.xml
View File

@@ -82,8 +82,37 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/sftp
It is also important to understand that <emphasis>SFTP Inbound Channel Adapter</emphasis> is a polling consumer and therefore
you must configure a poller (global or local)
Once the file has been transferred to a local directory a Message with <classname>java.io.File</classname> being a
payload will be generated and sent to the channel identified with <code>channel</code> attribute.
payload will be generated and sent to the channel identified with <code>channel</code> attribute.
</para>
<para>
<emphasis>File Filtering and Large Files</emphasis>
</para>
<para>
Some times the file that just appeared in the monitored (remote) directory is not complete. Typically such file
will be written with some temporary extension (e.g., foo.txt.writing) and then renamed after the writing process finished.
As a user in most cases you are only interested in files that are complete and would like to filter only files that are complete.
To handle these scenarios Spring Integration SFTP support allows you to configure custom filters that will filter out only
the files that you need. The filter is based on <classname>org.springframework.integration.file.filters.FileListFilter</classname> interface.
We also provide a convenient Regex-based implementation <classname>org.springframework.integration.sftp.filters.SftpPatternMatchingFileListFilter</classname>.
Once configured all you need is include such filter in your adapter via 'filter' attribute.
<programlisting language="xml"><![CDATA[<int-sftp:inbound-channel-adapter id="sftpInbondAdapter"
channel="receiveChannel"
session-factory="sftpSessionFactory"
local-directory="file:/local-test-dir"
remote-directory="/remote-test-dir">
<int:poller fixed-rate="1000" max-messages-per-poll="10" task-executor="executor"/>
</int-sftp:inbound-channel-adapter>
<bean id="fileNameFilter"
class="org.springframework.integration.ftp.filters.FtpPatternMatchingFileListFilt"">
<constructor-arg value=".*\.txt$"/>
</bean>]]></programlisting>
As an added convenience you may also use <code>filename-pattern</code> attribute instead of the explicit filter
configuration where you'll provide the filtering expression (Regex)
<programlisting language="xml"><![CDATA[filename-pattern=".*\.txt$"]]></programlisting>
</para>
</section>