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 Http4FileSystemConfigBuilder

Configuration options for WebDav based on HTTP4.

Since:

2.5.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	KEY_APPEND_TRAILING_SLASH	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(FileSystemOptions opts)	Gets whether a trailing slash ( / ) should be appended to the path.
protected Class<? extends FileSystem>	getConfigClass()
String	getCreatorName(FileSystemOptions opts)	Gets the user name to be associated with changes to the file.
boolean	getFollowRedirect(FileSystemOptions opts)	Gets whether to follow redirects for the connection.
static Webdav4FileSystemConfigBuilder	getInstance()	Gets the singleton builder.
boolean	isVersioning(FileSystemOptions opts)	The cookies to add to the request.
void	setAppendTrailingSlash(FileSystemOptions opts, boolean appendTrailingSlash)	Sets whether a trailing slash ( / ) should be appended to the path.
void	setCreatorName(FileSystemOptions opts, String creatorName)	The user name to be associated with changes to the file.
void	setVersioning(FileSystemOptions opts, boolean versioning)	Sets 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, getCharset, getCharset, 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

KEY_APPEND_TRAILING_SLASH

protected static final String KEY_APPEND_TRAILING_SLASH

Defines whether a trailing slash ( / ) should be appended to the path.

This parameter expects a value of type Boolean.

Since:

2.10.0

See Also:

• Constant Field Values

Method Details

getInstance

public static Webdav4FileSystemConfigBuilder getInstance()

Gets the singleton builder.

Returns:

the singleton builder.

getAppendTrailingSlash

public boolean getAppendTrailingSlash(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:

• setAppendTrailingSlash(org.apache.commons.vfs2.FileSystemOptions, boolean)

getConfigClass

protected Class<? extends FileSystem> getConfigClass()

Overrides:

getConfigClass in class Http4FileSystemConfigBuilder

Returns:

The Webdav FileSystem Class object.

getCreatorName

public String getCreatorName(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(FileSystemOptions opts)

Gets whether to follow redirects for the connection.

Overrides:

getFollowRedirect in class 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(FileSystemOptions opts)

The cookies to add to the request.

Parameters:

opts - The FileSystem options.

Returns:

true if versioning is enabled.

setAppendTrailingSlash

public void setAppendTrailingSlash(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(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(FileSystemOptions opts,
 boolean versioning)

Sets whether to use versioning.

Parameters:

opts - The FileSystem options.

versioning - true if versioning should be enabled.