Package org.apache.commons.httpclient.params

Class HostParams

java.lang.Object

org.apache.commons.httpclient.params.DefaultHttpParams

org.apache.commons.httpclient.params.HostParams

All Implemented Interfaces:

Serializable, Cloneable, HttpParams

@Deprecated
public class HostParams
extends DefaultHttpParams

Deprecated.

Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_HEADERS	Deprecated. Defines the request headers to be sent per default with each request.

Constructor Summary

Constructors

Constructor	Description
HostParams()	Deprecated. Creates a new collection of parameters with the collection returned by DefaultHttpParams.getDefaultParams() as a parent.
HostParams(HttpParams defaults)	Deprecated. Creates a new collection of parameters with the given parent.

Method Summary

Modifier and Type	Method	Description
String	getVirtualHost()	Deprecated. Returns the virtual host name.
void	setVirtualHost(String hostname)	Deprecated. 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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_HEADERS

public static final String DEFAULT_HEADERS

Deprecated.

Defines the request headers to be sent per default with each request.

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

See Also:

Constant Field Values

Constructor Detail

HostParams

public HostParams()

Deprecated.

Creates a new collection of parameters with the collection returned by DefaultHttpParams.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:

DefaultHttpParams.getDefaultParams()

HostParams

public HostParams(HttpParams defaults)

Deprecated.

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:

DefaultHttpParams.getDefaultParams()

Method Detail

setVirtualHost

public void setVirtualHost(String hostname)

Deprecated.

Sets the virtual host name.

Parameters:

hostname - The host name

getVirtualHost

public String getVirtualHost()

Deprecated.

Returns the virtual host name.

Returns:

The virtual host name