Package org.apache.commons.vfs2.provider.webdav4

Class Webdav4FileName

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileName

org.apache.commons.vfs2.provider.GenericFileName

org.apache.commons.vfs2.provider.GenericURLFileName

org.apache.commons.vfs2.provider.webdav4.Webdav4FileName

All Implemented Interfaces:

Comparable<org.apache.commons.vfs2.FileName>, org.apache.commons.vfs2.FileName

public class Webdav4FileName
extends org.apache.commons.vfs2.provider.GenericURLFileName

WebDAV 4 file name that represents a URL.

Since:

2.10.0

Field Summary

Fields inherited from interface org.apache.commons.vfs2.FileName

EMPTY_ARRAY, ROOT_PATH, SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
Webdav4FileName(String scheme, String hostName, int port, int defaultPort, String userName, String password, String path, org.apache.commons.vfs2.FileType type, String queryString)	Constructs a new instance.
Webdav4FileName(String scheme, String hostName, int port, int defaultPort, String userName, String password, String path, org.apache.commons.vfs2.FileType type, String queryString, boolean appendTrailingSlash)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
String	getPathQueryEncoded(String charset)	Gets the path encoded suitable for url like file system e.g.

Methods inherited from class org.apache.commons.vfs2.provider.GenericURLFileName

createName, createURI, getPathQuery, getQueryString, getURIEncoded

Methods inherited from class org.apache.commons.vfs2.provider.GenericFileName

appendCredentials, appendRootUri, getDefaultPort, getHostName, getPassword, getPort, getUserName

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileName

checkName, compareTo, equals, getBaseName, getDepth, getExtension, getFriendlyURI, getParent, getPath, getPathDecoded, getRelativeName, getRoot, getRootURI, getScheme, getType, getURI, getUriTrailer, hashCode, isAncestor, isDescendent, isDescendent, isFile, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Webdav4FileName

public Webdav4FileName(String scheme,
 String hostName,
 int port,
 int defaultPort,
 String userName,
 String password,
 String path,
 org.apache.commons.vfs2.FileType type,
 String queryString)

Constructs a new instance.

Parameters:

scheme - Host scheme.

hostName - Host name or IP address.

port - Host port.

defaultPort - Default host port.

userName - user name.

password - user password.

path - Path on the host.

type - File type on the host.

queryString - Query string for the path.

Webdav4FileName

public Webdav4FileName(String scheme,
 String hostName,
 int port,
 int defaultPort,
 String userName,
 String password,
 String path,
 org.apache.commons.vfs2.FileType type,
 String queryString,
 boolean appendTrailingSlash)

Constructs a new instance.

Parameters:

scheme - Host scheme.

hostName - Host name or IP address.

port - Host port.

defaultPort - Default host port.

userName - user name.

password - user password.

path - Path on the host.

type - File type on the host.

queryString - Query string for the path.

appendTrailingSlash - Append trailing slash to path.

Method Details

getPathQueryEncoded

public String getPathQueryEncoded(String charset)
                           throws org.apache.commons.vfs2.FileSystemException

Gets the path encoded suitable for url like file system e.g. (http, webdav). Reappend the trailing slash ( / ) if this FileName is a directory and not ROOT because many WEBDav-Servers require the trailing slash if the request access a directory

Overrides:

getPathQueryEncoded in class org.apache.commons.vfs2.provider.GenericURLFileName

Parameters:

charset - the charset used for the path encoding

Returns:

The encoded path.

Throws:

org.apache.commons.vfs2.FileSystemException - If some other error occurs.