{"id":10074,"date":"2013-04-04T15:26:42","date_gmt":"2013-04-04T09:56:42","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=10074"},"modified":"2013-07-13T11:34:24","modified_gmt":"2013-07-13T06:04:24","slug":"using-ftp-with-grails","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/using-ftp-with-grails\/","title":{"rendered":"Using Ftp with Grails"},"content":{"rendered":"

In one of my Grails project I need to drop files over ftp server. Using\u00a0JSch<\/a>\u00a0one can easily transfer files over sftp. Just follow the below steps.
\n1. Add the below dependency to Grails project “grails-app\/conf\/BuildConfig.groovy”<\/em> file<\/p>\n

[sourcecode language=”groovy”]
\ndependencies {
\n compile ‘com.jcraft:jsch:0.1.49’
\n }
\n[\/sourcecode]<\/p>\n

2. Create a class for adding ftp credentials information. e.g. “FtpCredentail”<\/p>\n

[sourcecode language=”groovy”]
\nclass FtpCredential {<\/p>\n

String server
\n String username
\n String password
\n String remoteBaseDir
\n Integer port
\n}
\n[\/sourcecode]<\/p>\n

3. Create a service named “FtpService” and add the following code into it<\/p>\n

[sourcecode language=”groovy”]
\nimport com.jcraft.jsch.Channel
\nimport com.jcraft.jsch.ChannelSftp
\nimport com.jcraft.jsch.JSch
\nimport com.jcraft.jsch.Session<\/p>\n

class FtpService {
\n def grailsApplication<\/p>\n

static transactional = true<\/p>\n

def save(InputStream inputStream, String fileName, FtpCredential ftpCredential) {
\n connect(ftpCredential) { ChannelSftp sftp ->
\n sftp.put inputStream, fileName
\n }
\n }<\/p>\n

def load(String fileName, FtpCredential ftpCredential) {
\n connect(ftpCredential, { ChannelSftp sftp ->
\n File outputFile = File.createTempFile(fileName,”)
\n outputFile?.newOutputStream() << sftp.get(fileName)
\n outputFile
\n }, false)
\n }<\/p>\n

def delete(String fileName, FtpCredential ftpCredential) throws Throwable {
\n connect(ftpCredential) { ChannelSftp sftp ->
\n sftp.rm fileName
\n }
\n }<\/p>\n

def makeDir(String directoryName, FtpCredential ftpCredential) {
\n connect(ftpCredential) { ChannelSftp sftp ->
\n sftp.mkdir directoryName
\n }
\n }<\/p>\n

private def connect(FtpCredential ftpCredential, Closure c, boolean disconnectOnFinish = true) {
\n Session session = null
\n ChannelSftp sftp = null
\n try {
\n JSch jSch = new JSch()
\n session = jSch.getSession username, ftpCredential?.server, ftpCredential?.port
\n session.setConfig "StrictHostKeyChecking", "no"
\n File keyFile = new File("${grailsApplication.config.pathToKeyFile}")
\n if (ftpCredential?.password) {
\n session.password = ftpCredential?.password
\n } else {
\n jSch.addIdentity(keyFile?.absolutePath)
\n }
\n session.connect()
\n Channel sFtpChannel = session.openChannel "sftp"
\n sFtpChannel.connect()
\n sftp = sFtpChannel as ChannelSftp
\n sftp.cd ftpCredential?.remoteBaseDir
\n c.call sftp
\n } catch (Exception ex) {
\n ex.printStackTrace()
\n } finally {
\n if (disconnectOnFinish) {
\n sftp?.exit()
\n session?.disconnect()
\n }
\n }
\n }
\n}
\n[\/sourcecode]
\nNote:<\/strong> In the above code at line number 44<\/em>.
\n[sourcecode language=”groovy”]
\nFile keyFile = new File("${grailsApplication.config.pathToKeyFile}")
\n[\/sourcecode]
\nThe code looks for private key provided by ftp server for password-less log in. One should define the property named “pathToKeyFile<\/em>” in “grails-app\/conf\/Config.groovy<\/em>” with value equals to the path of key file.
\n
\nNow you are ready to use the newly created FtpService service methods. Such as:<\/p>\n

    \n
  1. save(inputStream, fileName, ftpCredential)<\/em> for saving file over ftp.<\/li>\n
  2. load(fileName, ftpCredential)<\/em> for getting file from ftp.<\/li>\n
  3. delete(fileName, ftpCredential)<\/em> for deleting file over ftp.<\/li>\n
  4. makeDir(directoryName, ftpCredential)<\/em> for creating directory over ftp.<\/li>\n<\/ol>\n

    Example<\/h2>\n

    For saving file over ftp one can use FtpService save<\/strong> method as shown below
    \n[sourcecode language=”groovy”]
    \n File file = File.createTempFile("temp","txt")
    \n FtpCredential ftpCredential = new FtpCredential(server: <server>, username: <username>, password: <password>, port: <server_port>, remoteBaseDir: <remote_base_directory>)
    \n InputStream inputStream = new BufferedInputStream(new FileInputStream(file))
    \n ftpService.save(inputStream, "fileNameToBeSavedOverFTPServer", ftpCredential)
    \n[\/sourcecode]
    \n
    \nPlease share your feedback and suggestions.<\/em><\/p>\n

    \n

    Click here to read more JSch<\/em> examples \u00bb<\/a><\/em><\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"

    In one of my Grails project I need to drop files over ftp server. Using\u00a0JSch\u00a0one can easily transfer files over sftp. Just follow the below steps. 1. Add the below dependency to Grails project “grails-app\/conf\/BuildConfig.groovy” file [sourcecode language=”groovy”] dependencies { compile ‘com.jcraft:jsch:0.1.49’ } [\/sourcecode] 2. Create a class for adding ftp credentials information. e.g. “FtpCredentail” […]<\/p>\n","protected":false},"author":57,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":14},"categories":[7],"tags":[815,4840,9,1154,1153,1152,553],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/10074"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/57"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=10074"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/10074\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=10074"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=10074"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=10074"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}