HTTPParameters (container-search 6.288.1 API)

java.lang.Object
- com.yahoo.search.federation.http.HTTPParameters

```
public final class HTTPParameters
extends Object
```
A set of parameters for talking to an http backend

Author:

bratseth

Field Summary

Fields
Modifier and Type Field and Description

static String RETRIES

Fields
Modifier and Type	Field and Description
`static String`	`RETRIES`

Constructor Summary

Constructors
Constructor and Description

HTTPParameters()

HTTPParameters(ProviderConfig providerConfig)

HTTPParameters(String path)

Constructors
Constructor and Description
`HTTPParameters()`
`HTTPParameters(ProviderConfig providerConfig)`
`HTTPParameters(String path)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`freeze()` Make this unmodifiable.
`int`	`getConnectionTimeout()` Returns the connection timeout in milliseconds.
`boolean`	`getEnableProxy()` Returns whether proxying should be enabled.
`boolean`	`getFollowRedirects()`
`String`	`getInputEncoding()` Returns the input encoding.
`int`	`getMaxConnectionsPerRoute()`
`int`	`getMaxTotalConnections()`
`String`	`getMethod()` Returns the http method to use.
`String`	`getOutputEncoding()` Returns the output encoding.
`String`	`getPath()` Returns the url path.
`boolean`	`getPersistentConnections()` Returns whether this should use persistent connections.
`ProviderConfig.PingOption.Enum`	`getPingOption()`
`String`	`getProxyHost()` Returns the proxy host to use (if enabled).
`int`	`getProxyPort()` Returns the proxy port to use (if enabled).
`String`	`getProxyType()` Returns the proxy type to use (if enabled).
`int`	`getReadTimeout()` Returns the read timeout in milliseconds.
`int`	`getRetries()`
`String`	`getSchema()` Returns the schema to use.
`int`	`getSocketBufferSizeBytes()`
`String`	`getYcaApplicationId()`
`int`	`getYcaPort()`
`String`	`getYcaProxy()`
`long`	`getYcaRetry()`
`long`	`getYcaTtl()`
`boolean`	`getYcaUseProxy()`
`void`	`setConnectionTimeout(int connectionTimeout)`
`void`	`setEnableProxy(boolean enableProxy)`
`void`	`setFollowRedirects(boolean followRedirects)`
`void`	`setInputEncoding(String inputEncoding)`
`void`	`setMaxConnectionsPerRoute(int maxConnectionsPerRoute)`
`void`	`setMaxTotalConnections(int maxTotalConnections)`
`void`	`setMethod(String method)`
`void`	`setOutputEncoding(String outputEncoding)`
`void`	`setPath(String path)` Set the url path to use in queries to this.
`void`	`setPersistentConnections(boolean persistentConnections)` Note: This is currently largely a noop: Connections are reused even when this is set to true.
`void`	`setPingOption(ProviderConfig.PingOption.Enum pingOption)`
`void`	`setProxyHost(String proxyHost)`
`void`	`setProxyPort(int proxyPort)`
`void`	`setReadTimeout(int readTimeout)`
`void`	`setRetries(int retries)`
`void`	`setSchema(String schema)`
`void`	`setSocketBufferSizeBytes(int socketBufferSizeBytes)`
`org.apache.http.params.HttpParams`	`toHttpParams()` Returns the eligible subset of this as a HttpParams snapshot AND configures the Apache HTTP library with the parameters of this
`org.apache.http.params.HttpParams`	`toHttpParams(int connectionTimeout, int readTimeout)` Returns the eligible subset of this as a HttpParams snapshot AND configures the Apache HTTP library with the parameters of this

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RETRIES
```
public static final String RETRIES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HTTPParameters
```
public HTTPParameters()
```
  - HTTPParameters
```
public HTTPParameters(String path)
```
  - HTTPParameters
```
public HTTPParameters(ProviderConfig providerConfig)
```
- Method Detail
  - setPath
```
public final void setPath(String path)
```
    Set the url path to use in queries to this. If the argument is null or empty the path is set to "/". If a leading "/" is missing, it is added automatically.
  - getPingOption
```
public ProviderConfig.PingOption.Enum getPingOption()
```
  - setPingOption
```
public void setPingOption(ProviderConfig.PingOption.Enum pingOption)
```
  - getPath
```
public String getPath()
```
    Returns the url path. Default is "/".
  - getFollowRedirects
```
public boolean getFollowRedirects()
```
  - setFollowRedirects
```
public void setFollowRedirects(boolean followRedirects)
```
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns the connection timeout in milliseconds. Default is 2000.
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
  - getReadTimeout
```
public int getReadTimeout()
```
    Returns the read timeout in milliseconds. Default is 5000.
  - setPersistentConnections
```
public void setPersistentConnections(boolean persistentConnections)
```
    Note: This is currently largely a noop: Connections are reused even when this is set to true. The setting will change from sharing connections between threads to only reusing it within a thread but it is still reused.
  - getPersistentConnections
```
public boolean getPersistentConnections()
```
    Returns whether this should use persistent connections. Default is true.
  - getEnableProxy
```
public boolean getEnableProxy()
```
    Returns whether proxying should be enabled. Default is false.
  - setEnableProxy
```
public void setEnableProxy(boolean enableProxy)
```
  - getProxyType
```
public String getProxyType()
```
    Returns the proxy type to use (if enabled). Default is "http".
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
  - getProxyHost
```
public String getProxyHost()
```
    Returns the proxy host to use (if enabled). Default is "localhost".
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
  - getProxyPort
```
public int getProxyPort()
```
    Returns the proxy port to use (if enabled). Default is 1080.
  - setMethod
```
public void setMethod(String method)
```
  - getMethod
```
public String getMethod()
```
    Returns the http method to use. Default is "GET".
  - setSchema
```
public void setSchema(String schema)
```
  - getSchema
```
public String getSchema()
```
    Returns the schema to use. Default is "http".
  - setInputEncoding
```
public void setInputEncoding(String inputEncoding)
```
  - getInputEncoding
```
public String getInputEncoding()
```
    Returns the input encoding. Default is "utf-8".
  - setOutputEncoding
```
public void setOutputEncoding(String outputEncoding)
```
  - getOutputEncoding
```
public String getOutputEncoding()
```
    Returns the output encoding. Default is "utf-8".
  - freeze
```
public void freeze()
```
    Make this unmodifiable. Note that any thread synchronization must be done outside this object.
  - toHttpParams
```
public org.apache.http.params.HttpParams toHttpParams()
```
    Returns the eligible subset of this as a HttpParams snapshot AND configures the Apache HTTP library with the parameters of this
  - toHttpParams
```
public org.apache.http.params.HttpParams toHttpParams(int connectionTimeout,
                                                      int readTimeout)
```
    Returns the eligible subset of this as a HttpParams snapshot AND configures the Apache HTTP library with the parameters of this
  - getMaxTotalConnections
```
public int getMaxTotalConnections()
```
  - setMaxTotalConnections
```
public void setMaxTotalConnections(int maxTotalConnections)
```
  - getMaxConnectionsPerRoute
```
public int getMaxConnectionsPerRoute()
```
  - setMaxConnectionsPerRoute
```
public void setMaxConnectionsPerRoute(int maxConnectionsPerRoute)
```
  - getSocketBufferSizeBytes
```
public int getSocketBufferSizeBytes()
```
  - setSocketBufferSizeBytes
```
public void setSocketBufferSizeBytes(int socketBufferSizeBytes)
```
  - getRetries
```
public int getRetries()
```
  - setRetries
```
public void setRetries(int retries)
```
  - getYcaProxy
```
public String getYcaProxy()
```
  - getYcaPort
```
public int getYcaPort()
```
  - getYcaApplicationId
```
public String getYcaApplicationId()
```
  - getYcaUseProxy
```
public boolean getYcaUseProxy()
```
  - getYcaTtl
```
public long getYcaTtl()
```
  - getYcaRetry
```
public long getYcaRetry()
```

Class HTTPParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RETRIES

Constructor Detail

HTTPParameters

HTTPParameters

HTTPParameters

Method Detail

setPath

getPingOption

setPingOption

getPath

getFollowRedirects

setFollowRedirects

setConnectionTimeout

getConnectionTimeout

setReadTimeout

getReadTimeout

setPersistentConnections

getPersistentConnections

getEnableProxy

setEnableProxy

getProxyType

setProxyHost

getProxyHost

setProxyPort

getProxyPort

setMethod

getMethod

setSchema

getSchema

setInputEncoding

getInputEncoding

setOutputEncoding

getOutputEncoding

freeze

toHttpParams

toHttpParams

getMaxTotalConnections

setMaxTotalConnections

getMaxConnectionsPerRoute

setMaxConnectionsPerRoute

getSocketBufferSizeBytes

setSocketBufferSizeBytes

getRetries

setRetries

getYcaProxy

getYcaPort

getYcaApplicationId

getYcaUseProxy

getYcaTtl

getYcaRetry