Class Webdav4FileSystemConfigBuilder

java.lang.Object
org.apache.commons.vfs2.FileSystemConfigBuilder
org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder
org.apache.commons.vfs2.provider.webdav4.Webdav4FileSystemConfigBuilder

public final class Webdav4FileSystemConfigBuilder extends org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder
Configuration options for WebDav based on HTTP4.
Since:
2.5.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    Defines whether a trailing slash ( / ) should be appended to the path.

    Fields inherited from class org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder

    KEY_FOLLOW_REDIRECT
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAppendTrailingSlash(org.apache.commons.vfs2.FileSystemOptions opts)
    Gets whether a trailing slash ( / ) should be appended to the path.
    protected Class<? extends org.apache.commons.vfs2.FileSystem>
     
    getCreatorName(org.apache.commons.vfs2.FileSystemOptions opts)
    Gets the user name to be associated with changes to the file.
    boolean
    getFollowRedirect(org.apache.commons.vfs2.FileSystemOptions opts)
    Gets whether to follow redirects for the connection.
    Gets the singleton builder.
    boolean
    isVersioning(org.apache.commons.vfs2.FileSystemOptions opts)
    The cookies to add to the request.
    void
    setAppendTrailingSlash(org.apache.commons.vfs2.FileSystemOptions opts, boolean appendTrailingSlash)
    Sets whether a trailing slash ( / ) should be appended to the path.
    void
    setCreatorName(org.apache.commons.vfs2.FileSystemOptions opts, String creatorName)
    The user name to be associated with changes to the file.
    void
    setVersioning(org.apache.commons.vfs2.FileSystemOptions opts, boolean versioning)
    Whether to use versioning.

    Methods inherited from class org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder

    getConnectionTimeout, getConnectionTimeoutDuration, getCookies, getKeyStoreFile, getKeyStoreType, getMaxConnectionsPerHost, getMaxTotalConnections, getProxyAuthenticator, getProxyHost, getProxyPort, getProxyScheme, getSoTimeout, getSoTimeoutDuration, getUrlCharset, getUserAgent, isHostnameVerificationEnabled, isKeepAlive, isPreemptiveAuth, setConnectionTimeout, setConnectionTimeout, setCookies, setFollowRedirect, setHostnameVerificationEnabled, setKeepAlive, setKeyStoreFile, setKeyStorePass, setKeyStoreType, setMaxConnectionsPerHost, setMaxTotalConnections, setPreemptiveAuth, setProxyAuthenticator, setProxyHost, setProxyPort, setProxyScheme, setSoTimeout, setSoTimeout, setUrlCharset, setUserAgent

    Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuilder

    getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getDuration, getDuration, getDurationInteger, getDurationInteger, getEnum, getEnum, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getParamOrDefault, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setParam, setRootURI, toBooleanObject

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Method Details

    • getInstance

      Gets the singleton builder.
      Returns:
      the singleton builder.
    • getAppendTrailingSlash

      public boolean getAppendTrailingSlash(org.apache.commons.vfs2.FileSystemOptions opts)
      Gets whether a trailing slash ( / ) should be appended to the path.
      Parameters:
      opts - The FileSystem options.
      Returns:
      true to follow redirects, false not to.
      Since:
      2.10.0
      See Also:
    • getConfigClass

      protected Class<? extends org.apache.commons.vfs2.FileSystem> getConfigClass()
      Overrides:
      getConfigClass in class org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder
      Returns:
      The Webdav FileSystem Class object.
    • getCreatorName

      public String getCreatorName(org.apache.commons.vfs2.FileSystemOptions opts)
      Gets the user name to be associated with changes to the file.
      Parameters:
      opts - The FileSystem options
      Returns:
      The creatorName.
    • getFollowRedirect

      public boolean getFollowRedirect(org.apache.commons.vfs2.FileSystemOptions opts)
      Gets whether to follow redirects for the connection.
      Overrides:
      getFollowRedirect in class org.apache.commons.vfs2.provider.http4.Http4FileSystemConfigBuilder
      Parameters:
      opts - The FileSystem options.
      Returns:
      true to follow redirects, false not to.
      See Also:
      • Http4FileSystemConfigBuilder.setFollowRedirect(org.apache.commons.vfs2.FileSystemOptions, boolean)
    • isVersioning

      public boolean isVersioning(org.apache.commons.vfs2.FileSystemOptions opts)
      The cookies to add to the request.
      Parameters:
      opts - The FileSystem options.
      Returns:
      true if versioning is enabled.
    • setAppendTrailingSlash

      public void setAppendTrailingSlash(org.apache.commons.vfs2.FileSystemOptions opts, boolean appendTrailingSlash)
      Sets whether a trailing slash ( / ) should be appended to the path.
      Parameters:
      opts - The FileSystem options.
      appendTrailingSlash - true to append slash, false not to.
      Since:
      2.10.0
    • setCreatorName

      public void setCreatorName(org.apache.commons.vfs2.FileSystemOptions opts, String creatorName)
      The user name to be associated with changes to the file.
      Parameters:
      opts - The FileSystem options
      creatorName - The creator name to be associated with the file.
    • setVersioning

      public void setVersioning(org.apache.commons.vfs2.FileSystemOptions opts, boolean versioning)
      Whether to use versioning.
      Parameters:
      opts - The FileSystem options.
      versioning - true if versioning should be enabled.