diff --git a/buildSrc b/buildSrc index f32ad3ee38..2e7df56522 160000 --- a/buildSrc +++ b/buildSrc @@ -1 +1 @@ -Subproject commit f32ad3ee381df740f0fa7fa02f358fc9c8fe7bd1 +Subproject commit 2e7df565220081896699549b48ebe102b4ac164e diff --git a/docs/src/reference/docbook/ftp.xml b/docs/src/reference/docbook/ftp.xml index 1937d696a7..c8d18d6425 100644 --- a/docs/src/reference/docbook/ftp.xml +++ b/docs/src/reference/docbook/ftp.xml @@ -3,7 +3,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> FTP/FTPS Adapters - Spring Integration provides support for FTP and FTPS + Spring Integration provides support for file transfer operations via FTP and FTPS
Introduction @@ -17,10 +17,10 @@ to send and/or receive copies of files. - + Spring Integration supports sending and receiving files over FTP/FTPS by providing two types of clients - - Inbound Channel Adapters and Outbound Channel Adapters as well as convenient namespace configuration to define these - clients. + Inbound Channel Adapters and Outbound Channel Adapters as well as convenient + namespace configuration to define these clients. FTP @@ -58,7 +58,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/ftps ]]> As you can see form the configuration above you can configure FTP Inbound Channel Adapter via inbound-channel-adapter - element while also providing values for various attributes such as user and password to connect to an FTP server, + element while also providing values for various attributes such as username and password to connect to an FTP server, as well as other attributes. Please refer to the schema for more details on these attributes. @@ -112,7 +112,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/integration/ftps client-mode="passive-local-data-connection-mode"/>]]> As you can see form the configuration above you can configure FTP Outbound Channel Adapter via - outbound-channel-adapter element while also providing values for various attributes such as user + outbound-channel-adapter element while also providing values for various attributes such as username and password to connect to an FTP server, as well as other attributes. Please refer to the schema for more details on these attributes. diff --git a/docs/src/reference/docbook/sftp.xml b/docs/src/reference/docbook/sftp.xml index 8c859c117b..3aef592811 100644 --- a/docs/src/reference/docbook/sftp.xml +++ b/docs/src/reference/docbook/sftp.xml @@ -1,14 +1,109 @@ - SFTP Adapter + SFTP Adapters - Spring Integration provides support for SFTP + Spring Integration provides support for file transfer operations via FTP and FTPS
Introduction - TODO + Secure File Transfer Protocol (SFTP) is a network protocol which allows you to transfer + files between two computers on the Internet over any reliable stream. + + + + Similar to FTP, SFTP requires two actors - client and server. The protocol also requires + secure channel, such as SSH, as well as visibility to client's identity throughout SFTP session. + + + + Spring Integration supports sending and receiving files over SFTP by providing two types of clients - + Inbound Channel Adapters and Outbound Channel Adapters as well as convenient + namespace configuration to define these clients. + +
+ +
+ SFTP Inbound Channel Adapter + + SFTP Inbound Channel Adapter is a special listener that will connect to the FTP server and will listen for + the remote directory events (e.g., new file created) at which point it will initiate a file transfer. + + + +]]> + + As you can see form the configuration above you can configure SFTP Inbound Channel Adapter via + inbound-channel-adapter element while also providing values for various attributes such as username and + password to connect to an FTP server, key-file attributes as well as other attributes. + Please refer to the schema for more details on these attributes. + + + + It is also important to understand that SFTP Inbound Channel Adapter is a polling consumer and therefore + you must configure a poller (global or local) + Once the file has been transferred a Message with java.io.File being a payload will be generated and sent to the channel + identified with channel attribute. + + +
+ +
+ SFTP Outbound Channel Adapter + + + SFTP Outbound Channel Adapter is a special MessageHandler that will connect to the + FTP server and will initiate an FTP transfer for every file it will receive as a payload of the Message. + It also supports several representation of the File so you are not limited to the File object. + Similar to FTP outbound adapter SFTP Outbound Channel Adapter supports the following payloads: + 1) java.io.File - the actual file object; 2) byte[] - byte array that represents + the file contents; 3) java.lang.String - represents the file path. + + ]]> + + As you can see form the configuration above you can configure SFTP Outbound Channel Adapter via + outbound-channel-adapter element while also providing values for various attributes such as username and + password to connect to an FTP server, key-file attributes as well as other attributes. + Please refer to the schema for more details on these attributes. + +
+ + + + A more practical way to configure these types of adapters would be via Spring's property + placeholder (http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/beans.html#beans-factory-placeholderconfigurer) + +