org.apache.commons.vfs.provider.http
Class HttpFileSystemConfigBuilder

java.lang.Object
  extended by org.apache.commons.vfs.FileSystemConfigBuilder
      extended by org.apache.commons.vfs.provider.http.HttpFileSystemConfigBuilder
Direct Known Subclasses:
WebdavFileSystemConfigBuilder

public class HttpFileSystemConfigBuilder
extends FileSystemConfigBuilder

Configuration options for HTTP

Version:
$Revision: 764356 $ $Date: 2009-04-13 06:06:01 +0200(lun, 13 apr 2009) $
Author:
Mario Ivankovits

Constructor Summary
protected HttpFileSystemConfigBuilder(String prefix)
           
 
Method Summary
protected  Class getConfigClass()
           
 org.apache.commons.httpclient.Cookie[] getCookies(FileSystemOptions opts)
          The cookies to add to the reqest
static HttpFileSystemConfigBuilder getInstance()
           
 int getMaxConnectionsPerHost(FileSystemOptions opts)
          Retrieve the maximum number of connections allowed per host.
 int getMaxTotalConnections(FileSystemOptions opts)
          Retrieve the maximum number of connections allowed.
 UserAuthenticator getProxyAuthenticator(FileSystemOptions opts)
          Get the proxy authenticator where the system should get the credentials from
 String getProxyHost(FileSystemOptions opts)
          Get the proxy to use for http connection You have to set the ProxyPort too if you would like to have the proxy relly used.
 int getProxyPort(FileSystemOptions opts)
          Get the proxy-port to use for http the connection You have to set the ProxyHost too if you would like to have the proxy relly used.
 String getUrlCharset(FileSystemOptions opts)
          Set the charset used for url encoding
 void setCookies(FileSystemOptions opts, org.apache.commons.httpclient.Cookie[] cookies)
          The cookies to add to the reqest
 void setMaxConnectionsPerHost(FileSystemOptions opts, int maxHostConnections)
          The maximum number of connections allowed to any host
 void setMaxTotalConnections(FileSystemOptions opts, int maxTotalConnections)
          The maximum number of connections allowed
 void setProxyAuthenticator(FileSystemOptions opts, UserAuthenticator authenticator)
          Set the proxy authenticator where the system should get the credentials from
 void setProxyHost(FileSystemOptions opts, String proxyHost)
          Set the proxy to use for http connection.
You have to set the ProxyPort too if you would like to have the proxy relly used.
 void setProxyPort(FileSystemOptions opts, int proxyPort)
          Set the proxy-port to use for http connection You have to set the ProxyHost too if you would like to have the proxy relly used.
 void setUrlCharset(FileSystemOptions opts, String chaset)
          Set the charset used for url encoding
 
Methods inherited from class org.apache.commons.vfs.FileSystemConfigBuilder
getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setRootURI
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HttpFileSystemConfigBuilder

protected HttpFileSystemConfigBuilder(String prefix)
Method Detail

getInstance

public static HttpFileSystemConfigBuilder getInstance()

setUrlCharset

public void setUrlCharset(FileSystemOptions opts,
                          String chaset)
Set the charset used for url encoding

Parameters:
chaset - the chaset

getUrlCharset

public String getUrlCharset(FileSystemOptions opts)
Set the charset used for url encoding

Returns:
the chaset

setProxyHost

public void setProxyHost(FileSystemOptions opts,
                         String proxyHost)
Set the proxy to use for http connection.
You have to set the ProxyPort too if you would like to have the proxy relly used.

Parameters:
proxyHost - the host
See Also:
setProxyPort(org.apache.commons.vfs.FileSystemOptions, int)

setProxyPort

public void setProxyPort(FileSystemOptions opts,
                         int proxyPort)
Set the proxy-port to use for http connection You have to set the ProxyHost too if you would like to have the proxy relly used.

Parameters:
proxyPort - the port
See Also:
setProxyHost(org.apache.commons.vfs.FileSystemOptions, java.lang.String)

getProxyHost

public String getProxyHost(FileSystemOptions opts)
Get the proxy to use for http connection You have to set the ProxyPort too if you would like to have the proxy relly used.

Returns:
proxyHost
See Also:
setProxyPort(org.apache.commons.vfs.FileSystemOptions, int)

getProxyPort

public int getProxyPort(FileSystemOptions opts)
Get the proxy-port to use for http the connection You have to set the ProxyHost too if you would like to have the proxy relly used.

Returns:
proxyPort: the port number or 0 if it is not set
See Also:
setProxyHost(org.apache.commons.vfs.FileSystemOptions, java.lang.String)

setProxyAuthenticator

public void setProxyAuthenticator(FileSystemOptions opts,
                                  UserAuthenticator authenticator)
Set the proxy authenticator where the system should get the credentials from


getProxyAuthenticator

public UserAuthenticator getProxyAuthenticator(FileSystemOptions opts)
Get the proxy authenticator where the system should get the credentials from


setCookies

public void setCookies(FileSystemOptions opts,
                       org.apache.commons.httpclient.Cookie[] cookies)
The cookies to add to the reqest


getCookies

public org.apache.commons.httpclient.Cookie[] getCookies(FileSystemOptions opts)
The cookies to add to the reqest


setMaxTotalConnections

public void setMaxTotalConnections(FileSystemOptions opts,
                                   int maxTotalConnections)
The maximum number of connections allowed


getMaxTotalConnections

public int getMaxTotalConnections(FileSystemOptions opts)
Retrieve the maximum number of connections allowed.

Parameters:
opts - The FileSystemOptions.
Returns:
The maximum number of connections allowed.

setMaxConnectionsPerHost

public void setMaxConnectionsPerHost(FileSystemOptions opts,
                                     int maxHostConnections)
The maximum number of connections allowed to any host


getMaxConnectionsPerHost

public int getMaxConnectionsPerHost(FileSystemOptions opts)
Retrieve the maximum number of connections allowed per host.

Parameters:
opts - The FileSystemOptions.
Returns:
The maximum number of connections allowed per host.

getConfigClass

protected Class getConfigClass()
Specified by:
getConfigClass in class FileSystemConfigBuilder


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.