org.apache.commons.httpclient.params

Class HostParams

public class HostParams extends DefaultHttpParams

This class represents a collection of HTTP protocol parameters applicable to instances of HostConfiguration. Protocol parameters may be linked together to form a hierarchy. If a particular parameter value has not been explicitly defined in the collection itself, its value will be drawn from the parent collection of parameters.

Since: 3.0

Version: $Revision: 224451 $

Author: Oleg Kalnichevski

Field Summary
static StringDEFAULT_HEADERS
Defines the request headers to be sent per default with each request.
Constructor Summary
HostParams()
Creates a new collection of parameters with the collection returned by HostParams as a parent.
HostParams(HttpParams defaults)
Creates a new collection of parameters with the given parent.
Method Summary
StringgetVirtualHost()
Returns the virtual host name.
voidsetVirtualHost(String hostname)
Sets the virtual host name.

Field Detail

DEFAULT_HEADERS

public static final String DEFAULT_HEADERS
Defines the request headers to be sent per default with each request.

This parameter expects a value of type java.util.Collection. The collection is expected to contain Headers.

Constructor Detail

HostParams

public HostParams()
Creates a new collection of parameters with the collection returned by HostParams as a parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.

See Also: HostParams

HostParams

public HostParams(HttpParams defaults)
Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.

Parameters: defaults the parent collection to defer to, if a parameter is not explictly set in the collection itself.

See Also: HostParams

Method Detail

getVirtualHost

public String getVirtualHost()
Returns the virtual host name.

Returns: The virtual host name

setVirtualHost

public void setVirtualHost(String hostname)
Sets the virtual host name.

Parameters: hostname The host name

Copyright (c) 1999-2005 - Apache Software Foundation