Class WebdavFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

org.apache.commons.vfs2.provider.http.HttpFileSystemConfigBuilder

org.apache.commons.vfs2.provider.webdav.WebdavFileSystemConfigBuilder

public final class WebdavFileSystemConfigBuilder
extends HttpFileSystemConfigBuilder

Configuration options for WebDav.

Since:

2.0

Field Summary

Fields inherited from class org.apache.commons.vfs2.provider.http.HttpFileSystemConfigBuilder

KEY_FOLLOW_REDIRECT, KEY_USER_AGENT

Method Summary

Modifier and Type	Method	Description
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 HttpFileSystemConfigBuilder	getInstance()	Gets the singleton builder.
boolean	isVersioning(FileSystemOptions opts)	The cookies to add to the request.
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.http.HttpFileSystemConfigBuilder

getConnectionTimeout, getConnectionTimeoutDuration, getCookies, getMaxConnectionsPerHost, getMaxTotalConnections, getProxyAuthenticator, getProxyHost, getProxyPort, getSoTimeout, getSoTimeoutDuration, getUrlCharset, getUserAgent, isPreemptiveAuth, setConnectionTimeout, setConnectionTimeout, setCookies, setFollowRedirect, setMaxConnectionsPerHost, setMaxTotalConnections, setPreemptiveAuth, setProxyAuthenticator, setProxyHost, setProxyPort, 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

Method Details

getInstance

public static HttpFileSystemConfigBuilder getInstance()

Gets the singleton builder.

Returns:

the singleton builder.

getConfigClass

protected Class<? extends FileSystem> getConfigClass()

Overrides:

getConfigClass in class HttpFileSystemConfigBuilder

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 HttpFileSystemConfigBuilder

Parameters:

opts - The FileSystem options.

Returns:

true to follow redirects, false not to.

Since:

2.1

See Also:

• HttpFileSystemConfigBuilder.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.

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.