miner.ftp — com.velisco/clj-ftp 1.2.0

as-uri clj

(as-uri url)

client-all-names clj

(client-all-names client)

client-cd clj

(client-cd client dir)

client-complete-pending-command clj

(client-complete-pending-command client)

Complete the previous command and check the reply code. Throw an exception if reply code is not a positive completion

client-delete clj

(client-delete client fname)

client-directory-names clj

(client-directory-names client)

client-file-names clj

(client-file-names client)

client-FTPFile-directories clj

(client-FTPFile-directories client)

client-FTPFiles clj

(client-FTPFiles client)

client-FTPFiles-all clj

(client-FTPFiles-all client)

client-get clj

(client-get client fname)

(client-get client fname local-name)

Get a file and write to local file-system (must be within a with-ftp)

client-get-stream clj

(client-get-stream client fname)

Get a file and return InputStream (must be within a with-ftp). Note that it's necessary to complete this command with a call to client-complete-pending-command after using the stream.

client-mkdir clj

(client-mkdir client subdir)

client-mkdirs clj

(client-mkdirs client subpath)

client-put clj

(client-put client fname)

(client-put client fname remote)

Put a file (must be within a with-ftp)

client-put-stream clj

(client-put-stream client instream remote)

Put an InputStream (must be within a with-ftp)

client-pwd clj

(client-pwd client)

client-rename clj

(client-rename client from to)

client-send-site-command clj

(client-send-site-command client sitecmd)

client-set-file-type clj

(client-set-file-type client filetype)

encrypt-channel clj

(encrypt-channel client)

guess-file-type clj

(guess-file-type file-name)

list-all clj

(list-all url)

list-directories clj

(list-directories url)

list-files clj

(list-files url)

login* clj

(login* client url username password)

open clj

(open url)

(open url control-encoding)

(open url
      control-encoding
      {:keys [strict-reply-parsing security-mode data-timeout-ms
              connect-timeout-ms default-timeout-ms
              control-keep-alive-timeout-sec
              control-keep-alive-reply-timeout-ms]
       :or {strict-reply-parsing true
            security-mode :explicit
            data-timeout-ms -1
            connect-timeout-ms 30000
            control-keep-alive-timeout-sec 300
            control-keep-alive-reply-timeout-ms 1000}})

rename-file clj

(rename-file url from to)

retrieve-file clj

(retrieve-file url fname)

(retrieve-file url fname local-file)

user-info clj

(user-info url control-encoding)

Decode the user info part of a URL to extract the username and password.

Note that URI#getUserInfo() isn't used because if the result of that method contains more than one ':' character, we can't determine which ':' is the separator. At the same time, we can't easily use URLDecoder, because it converts '+' into spaces. So we have to do the percent-decoding ourselves.

with-ftp clj macro

(with-ftp [client url &
           {:keys [local-data-connection-mode file-type control-encoding
                   username password]
            :as params
            :or {control-encoding "UTF-8"}}]
          &
          body)

Establish an FTP connection, bound to client, for the FTP url, and execute the body with access to that client connection. Closes connection at end of body. Keyword options can follow the url in the binding vector. By default, uses a passive local data connection mode and ASCII file type. Use [client url :local-data-connection-mode :active :file-type :binary :security-mode :explicit] to override.

Allows to override the following timeouts:

• connect-timeout-ms - The timeout used when opening a socket. Default 30000
• data-timeout-ms - the underlying socket timeout. Default - infinite (< 1).
• control-keep-alive-timeout-sec - control channel keep alive message timeout. Default 300 seconds.
• control-keep-alive-reply-timeout-ms - how long to wait for the control channel keep alive replies. Default 1000 ms.
• control-encoding - The new character encoding for the control connection. Default - UTF-8
• username - FTP username (if not supplying credentials via the URL)
• password - FTP password (if not supplying credentials via the URL)