Package org.apache.commons.vfs2.provider.ftp

Class FtpFileSystemConfigBuilder

    • Constructor Detail

      • FtpFileSystemConfigBuilder

        protected FtpFileSystemConfigBuilder​(java.lang.String prefix)
        Create new config builder with specified prefix string.
        Parameters:
        prefix - prefix string to use for parameters of this config builder.
        Since:
        2.1

    • Method Detail

      • getSaneTransferAbortedOkReplyCodes

        public static java.util.List<java.lang.Integer> getSaneTransferAbortedOkReplyCodes()
        Gets special retry code. See VFS-674, its accompanying PR and https://github.com/apache/commons-vfs/pull/51 as to why 426 and 550 are here.
        Returns:
        special retry code.

      • getActivePortRange

        public org.apache.commons.lang3.Range<java.lang.Integer> getActivePortRange​(FileSystemOptions options)
        Gets the active port range.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        the Range of active ports
        Since:
        2.10.0

      • getAutodetectUtf8

        public java.lang.Boolean getAutodetectUtf8​(FileSystemOptions options)
        Gets whether to try to autodetect the server encoding (only UTF8 is supported).
        Parameters:
        options - The FileSystemOptions.
        Returns:
        True if autodetection should be done.
        Since:
        2.4

      • getConnectTimeoutDuration

        public java.time.Duration getConnectTimeoutDuration​(FileSystemOptions options)
        Gets the timeout in milliseconds to use for the socket connection.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        The timeout in milliseconds to use for the socket connection.
        Since:
        2.8.0

      • getControlEncoding

        public java.lang.String getControlEncoding​(FileSystemOptions options)
        Gets the control encoding.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        The control encoding.
        Since:
        2.0

      • getControlKeepAliveReplyTimeout

        public java.time.Duration getControlKeepAliveReplyTimeout​(FileSystemOptions options)
        Gets the controlKeepAliveReplyTimeout duration.
        Parameters:
        options - The FileSystem options
        Returns:
        The controlKeepAliveReplyTimeout duration.
        Since:
        2.8.0

      • getControlKeepAliveTimeout

        public java.time.Duration getControlKeepAliveTimeout​(FileSystemOptions options)
        Gets the controlKeepAliveTimeout duration.
        Parameters:
        options - The FileSystem options
        Returns:
        The controlKeepAliveTimeout duration.
        Since:
        2.8.0

      • getDefaultDateFormat

        public java.lang.String getDefaultDateFormat​(FileSystemOptions options)
        Gets the default date format used by the server. See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions
        Returns:
        The default date format.

      • getProxy

        public java.net.Proxy getProxy​(FileSystemOptions options)
        Gets the Proxy.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        the Proxy
        Since:
        2.1

      • getRecentDateFormat

        public java.lang.String getRecentDateFormat​(FileSystemOptions options)
        See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        The recent date format.

      • getRemoteVerification

        public java.lang.Boolean getRemoteVerification​(FileSystemOptions options)
        Gets whether to use remote verification.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        True if remote verification should be done.

      • getServerLanguageCode

        public java.lang.String getServerLanguageCode​(FileSystemOptions options)
        Gets the language code used by the server. See FTPClientConfig for details and examples.
        Parameters:
        options - The FilesystemOptions.
        Returns:
        The language code of the server.

      • getServerTimeZoneId

        public java.lang.String getServerTimeZoneId​(FileSystemOptions options)
        See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        The server timezone id.

      • getShortMonthNames

        public java.lang.String[] getShortMonthNames​(FileSystemOptions options)
        See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        Returns:
        An array of short month names.

      • getTransferAbortedOkReplyCodes

        public java.util.List<java.lang.Integer> getTransferAbortedOkReplyCodes​(FileSystemOptions options)
        Gets the list of reply codes (apart from 200) that are considered as OK when prematurely closing a stream.
        Parameters:
        options - The FileSystem options.
        Returns:
        The list of reply codes (apart from 200) that are considered as OK when prematurely closing a stream.
        Since:
        2.4

      • setActivePortRange

        public void setActivePortRange​(FileSystemOptions options,
                               org.apache.commons.lang3.Range<java.lang.Integer> portRange)
        Sets the active port range.
        Parameters:
        options - The FileSystemOptions.
        portRange - the Range of active ports
        Since:
        2.10.0

      • setAutodetectUtf8

        public void setAutodetectUtf8​(FileSystemOptions options,
                              java.lang.Boolean autodetectUTF8)
        Sets whether to try to autodetect the server encoding (only UTF8 is supported).
        Parameters:
        options - The FileSystemOptions.
        autodetectUTF8 - true if autodetection should be done.
        Since:
        2.4

      • setConnectTimeout

        public void setConnectTimeout​(FileSystemOptions options,
                              java.time.Duration duration)
        Sets the timeout for the initial control connection.

        If you set the connectTimeout to null no connectTimeout will be set.

        Parameters:
        options - The FileSystemOptions.
        duration - the timeout duration in milliseconds
        Since:
        2.8.0

      • setControlEncoding

        public void setControlEncoding​(FileSystemOptions options,
                               java.lang.String encoding)
        See FTP.setControlEncoding(java.lang.String) for details and examples.
        Parameters:
        options - The FileSystemOptions.
        encoding - the encoding to use
        Since:
        2.0

      • setControlKeepAliveReplyTimeout

        public void setControlKeepAliveReplyTimeout​(FileSystemOptions options,
                                            java.time.Duration duration)
        Sets the control keep alive reply timeout for the FTP client.
        Parameters:
        options - The FileSystem options.
        duration - timeout duration.
        Since:
        2.8.0

      • setControlKeepAliveTimeout

        public void setControlKeepAliveTimeout​(FileSystemOptions options,
                                       java.time.Duration duration)
        Sets the control keep alive timeout for the FTP client.

        Sets the controlKeepAliveTimeout to ensure the socket be alive after download huge file.

        Parameters:
        options - The FileSystem options.
        duration - The timeout duration.
        Since:
        2.8.0

      • setDataTimeout

        public void setDataTimeout​(FileSystemOptions options,
                           java.time.Duration duration)
        Sets the data timeout for the FTP client.

        If you set the dataTimeout to null, no dataTimeout will be set on the FTP client.

        Parameters:
        options - The FileSystemOptions.
        duration - The timeout duration.
        Since:
        2.8.0

      • setDataTimeout

        @Deprecated
public void setDataTimeout​(FileSystemOptions options,
                           java.lang.Integer duration)
        Deprecated.
        Use setDataTimeout(FileSystemOptions, Duration).
        Sets the data timeout for the FTP client.

        If you set the dataTimeout to null, no dataTimeout will be set on the FTP client.

        Parameters:
        options - The FileSystemOptions.
        duration - The timeout value.

      • setDefaultDateFormat

        public void setDefaultDateFormat​(FileSystemOptions options,
                                 java.lang.String defaultDateFormat)
        Sets the default date format used by the server. See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        defaultDateFormat - The default date format.

      • setEntryParserFactory

        public void setEntryParserFactory​(FileSystemOptions options,
                                  org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)
        FTPFileEntryParserFactory which will be used for ftp-entry parsing.
        Parameters:
        options - The FileSystemOptions.
        factory - instance of your factory

      • setFileType

        public void setFileType​(FileSystemOptions options,
                        FtpFileType ftpFileType)
        Sets the file type parameter.
        Parameters:
        options - The FileSystemOptions.
        ftpFileType - A FtpFileType
        Since:
        2.1

      • setPassiveMode

        public void setPassiveMode​(FileSystemOptions options,
                           boolean passiveMode)
        Enter into passive mode.
        Parameters:
        options - The FileSystemOptions.
        passiveMode - true if passive mode should be used.

      • setProxy

        public void setProxy​(FileSystemOptions options,
                     java.net.Proxy proxy)
        Sets the Proxy.

        You might need to make sure that passive mode is activated.

        Parameters:
        options - the FileSystem options.
        proxy - the Proxy
        Since:
        2.1

      • setRecentDateFormat

        public void setRecentDateFormat​(FileSystemOptions options,
                                java.lang.String recentDateFormat)
        See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        recentDateFormat - The recent date format.

      • setRemoteVerification

        public void setRemoteVerification​(FileSystemOptions options,
                                  boolean remoteVerification)
        Sets whether to use remote verification.
        Parameters:
        options - The FileSystemOptions.
        remoteVerification - True if verification should be done.

      • setServerLanguageCode

        public void setServerLanguageCode​(FileSystemOptions options,
                                  java.lang.String serverLanguageCode)
        Sets the language code used by the server. See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        serverLanguageCode - The servers language code.

      • setServerTimeZoneId

        public void setServerTimeZoneId​(FileSystemOptions options,
                                java.lang.String serverTimeZoneId)
        See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        serverTimeZoneId - The server timezone id.

      • setShortMonthNames

        public void setShortMonthNames​(FileSystemOptions options,
                               java.lang.String[] shortMonthNames)
        See FTPClientConfig for details and examples.
        Parameters:
        options - The FileSystemOptions.
        shortMonthNames - an array of short month name Strings.

      • setSoTimeout

        public void setSoTimeout​(FileSystemOptions options,
                         java.time.Duration timeout)
        Sets the socket timeout for the FTP client.

        If you set the soTimeout to null, no socket timeout will be set on the FTP client.

        Parameters:
        options - The FileSystem options.
        timeout - The timeout value in milliseconds.
        Since:
        2.8.0

      • setSoTimeout

        @Deprecated
public void setSoTimeout​(FileSystemOptions options,
                         java.lang.Integer timeout)
        Deprecated.
        Use setSoTimeout(FileSystemOptions, Duration).
        Sets the socket timeout for the FTP client.

        If you set the soTimeout to null, no socket timeout will be set on the FTP client.

        Parameters:
        options - The FileSystem options.
        timeout - The timeout value in milliseconds.
        Since:
        2.0

      • setTransferAbortedOkReplyCodes

        public void setTransferAbortedOkReplyCodes​(FileSystemOptions options,
                                           java.util.List<java.lang.Integer> replyCodes)
        Sets the list of reply codes that are considered as OK when prematurely closing a stream.

        If you set the replyCodes to an empty list, all reply codes besides 200 will be considered as an error.

        Parameters:
        options - The FileSystem options.
        replyCodes - The reply codes.
        Since:
        2.4

      • setUserDirIsRoot

        public void setUserDirIsRoot​(FileSystemOptions options,
                             boolean userDirIsRoot)
        Use user directory as root (do not change to fs root).
        Parameters:
        options - The FileSystemOptions.
        userDirIsRoot - true if the user directory should be treated as the root.