Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.httpclient.params

Class HostParams

Implemented Interfaces:
Cloneable, HttpParams, Serializable
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.

Version:
$Revision: 155418 $

Author:
Oleg Kalnichevski

Since:
3.0

Field Summary

static String
DEFAULT_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 getDefaultParams() as a parent.
HostParams(HttpParams defaults)
Creates a new collection of parameters with the given parent.

Method Summary

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

Methods inherited from class org.apache.commons.httpclient.params.DefaultHttpParams

clear, clone, getBooleanParameter, getDefaultParams, getDefaults, getDoubleParameter, getIntParameter, getLongParameter, getParameter, isParameterFalse, isParameterSet, isParameterSetLocally, isParameterTrue, setBooleanParameter, setDefaults, setDoubleParameter, setHttpParamsFactory, setIntParameter, setLongParameter, setParameter, setParameters

Field Details

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 Details

HostParams

public HostParams()
Creates a new collection of parameters with the collection returned by getDefaultParams() 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:
getDefaultParams()

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:
getDefaultParams()

Method Details

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

Overview Package Tree Index Deprecated About
Copyright (c) 1999-2005 - Apache Software Foundation