HttpClientBuilder (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- org.opensaml.ws.soap.client.http.HttpClientBuilder

```
@NotThreadSafe
public class HttpClientBuilder
extends Object
```
A builder for HttpClients. This builder will produce clients that employ the MultiThreadedHttpConnectionManager and as such users of the clients MUST be sure to invoke HttpMethod.releaseConnection() after they have finished with the method.

コンストラクタの概要

コンストラクタ
コンストラクタと説明

HttpClientBuilder()
Constructor.

コンストラクタ
コンストラクタと説明
`HttpClientBuilder()` Constructor.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`org.apache.commons.httpclient.HttpClient`	`buildClient()` Builds an HTTP client with the given settings.
`int`	`getConnectionRetryAttempts()` Gets the number of times a connection will be tried if a host is unreachable.
`int`	`getConnectionTimeout()` Gets the time, in milliseconds, to wait for connection establishments.
`String`	`getContentCharSet()` Gets the character set used for HTTP content.
`org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory`	`getHttpsProtocolSocketFactory()` Gets the protocol socket factory used for the https scheme.
`int`	`getMaxConnectionsPerHost()` Gets the maximum number of connections, per host, that the client will create.
`int`	`getMaxTotalConnections()` Gets the maximum number of total connections the client will create.
`String`	`getProxyHost()` Gets the host name of the HTTP proxy server through which connections will be made.
`String`	`getProxyPassword()` Gets the password used to connect to the HTTP proxy server.
`int`	`getProxyPort()` Gets the port of the HTTP proxy server through which connections will be made.
`String`	`getProxyUsername()` Gets the username used to connect to the HTTP proxy server.
`int`	`getReceiveBufferSize()` Gets the size of buffer, in bytes, used when receiving content.
`int`	`getSendBufferSize()` Gets the size of buffer, in bytes, used when sending content.
`boolean`	`isPreemptiveAuthentication()` Gets whether authentication is performed preemptively.
`boolean`	`isTcpNoDelay()` Gets whether to use TCP No Delay when sending data.
`void`	`resetDefaults()` Resets the builder to its default values.
`void`	`setConnectionRetryAttempts(int attempts)` Sets the number of times a connection will be tried if a host is unreachable.
`void`	`setConnectionTimeout(int timeout)` Sets the time, in milliseconds, to wait for connection establishments.
`void`	`setContentCharSet(String charSet)` Sets the character set used for HTTP content.
`void`	`setHttpsProtocolSocketFactory(org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory factory)` Sets the protocol socket factory used for the https scheme.
`void`	`setMaxConnectionsPerHost(int max)` Sets the maximum number of connections, per host, that the client will create.
`void`	`setMaxTotalConnections(int max)` Sets the maximum number of total connections the client will create.
`void`	`setPreemptiveAuthentication(boolean preemptive)` Sets whether authentication is performed preemptively.
`void`	`setProxyHost(String host)` Sets the host name of the HTTP proxy server through which connections will be made.
`void`	`setProxyPassword(String password)` Sets the password used to connect to the HTTP proxy server.
`void`	`setProxyPort(int port)` Sets the port of the HTTP proxy server through which connections will be made.
`void`	`setProxyUsername(String username)` Sets the username used to connect to the HTTP proxy server.
`void`	`setReceiveBufferSize(int size)` Sets the size of buffer, in bytes, used when sending content.
`void`	`setSendBufferSize(int size)` Sets the size of buffer, in bytes, used when sending content.
`void`	`setTcpNoDelay(boolean noDelay)` Sets whether to use TCP No Delay when sending data.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - HttpClientBuilder
```
public HttpClientBuilder()
```
    Constructor.
- メソッドの詳細
  - resetDefaults
```
public void resetDefaults()
```
    Resets the builder to its default values.
  - buildClient
```
public org.apache.commons.httpclient.HttpClient buildClient()
```
    Builds an HTTP client with the given settings. Settings are NOT reset to their default values after a client has been created.
    
    戻り値:
    the created client.
  - getProxyHost
```
public String getProxyHost()
```
    Gets the host name of the HTTP proxy server through which connections will be made.
    
    戻り値:
    host name of the HTTP proxy server through which connections will be made
  - setProxyHost
```
public void setProxyHost(String host)
```
    Sets the host name of the HTTP proxy server through which connections will be made.
    
    パラメータ:
    host - host name of the HTTP proxy server through which connections will be made
  - getProxyPort
```
public int getProxyPort()
```
    Gets the port of the HTTP proxy server through which connections will be made.
    
    戻り値:
    port of the HTTP proxy server through which connections will be made
  - setProxyPort
```
public void setProxyPort(int port)
```
    Sets the port of the HTTP proxy server through which connections will be made.
    
    パラメータ:
    port - port of the HTTP proxy server through which connections will be made
  - getProxyUsername
```
public String getProxyUsername()
```
    Gets the username used to connect to the HTTP proxy server.
    
    戻り値:
    username used to connect to the HTTP proxy server
  - setProxyUsername
```
public void setProxyUsername(String username)
```
    Sets the username used to connect to the HTTP proxy server.
    
    パラメータ:
    username - username used to connect to the HTTP proxy server
  - getProxyPassword
```
public String getProxyPassword()
```
    Gets the password used to connect to the HTTP proxy server.
    
    戻り値:
    password used to connect to the HTTP proxy server
  - setProxyPassword
```
public void setProxyPassword(String password)
```
    Sets the password used to connect to the HTTP proxy server.
    
    パラメータ:
    password - password used to connect to the HTTP proxy server
  - isPreemptiveAuthentication
```
public boolean isPreemptiveAuthentication()
```
    Gets whether authentication is performed preemptively. Default value is false.
    
    戻り値:
    whether authentication is performed preemptively
  - setPreemptiveAuthentication
```
public void setPreemptiveAuthentication(boolean preemptive)
```
    Sets whether authentication is performed preemptively.
    
    パラメータ:
    preemptive - whether authentication is performed preemptively
  - getContentCharSet
```
public String getContentCharSet()
```
    Gets the character set used for HTTP content. Default value is UTF-8.
    
    戻り値:
    character set used for HTTP content
  - setContentCharSet
```
public void setContentCharSet(String charSet)
```
    Sets the character set used for HTTP content.
    
    パラメータ:
    charSet - character set used for HTTP content
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Gets the time, in milliseconds, to wait for connection establishments. Default value is 5,000. A value of 0 indicates there is no timeout.
    
    戻り値:
    time, in milliseconds, to wait for connection establishments
  - setConnectionTimeout
```
public void setConnectionTimeout(int timeout)
```
    Sets the time, in milliseconds, to wait for connection establishments. A value of 0 indicates there is no timeout.
    
    パラメータ:
    timeout - time, in milliseconds, to wait for connection establishments
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Gets the size of buffer, in bytes, used when sending content. Default value is 4,096.
    
    戻り値:
    size of buffer, in bytes, used when sending content
  - setSendBufferSize
```
public void setSendBufferSize(int size)
```
    Sets the size of buffer, in bytes, used when sending content.
    
    パラメータ:
    size - size of buffer, in bytes, used when sending content
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Gets the size of buffer, in bytes, used when receiving content. Default value is 16,384.
    
    戻り値:
    size of buffer, in bytes, used when sending content
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int size)
```
    Sets the size of buffer, in bytes, used when sending content.
    
    パラメータ:
    size - size of buffer, in bytes, used when sending content
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
    Gets whether to use TCP No Delay when sending data. Default value is true.
    
    戻り値:
    whether to use TCP No Delay when sending data
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean noDelay)
```
    Sets whether to use TCP No Delay when sending data.
    
    パラメータ:
    noDelay - whether to use TCP No Delay when sending data
  - getMaxConnectionsPerHost
```
public int getMaxConnectionsPerHost()
```
    Gets the maximum number of connections, per host, that the client will create. Default value is 5. A value of 0 indicates there is no maximum.
    
    戻り値:
    maximum number of connections, per host, that the client will create
  - setMaxConnectionsPerHost
```
public void setMaxConnectionsPerHost(int max)
```
    Sets the maximum number of connections, per host, that the client will create. A value of 0 indicates there is no maximum.
    
    パラメータ:
    max - maximum number of connections, per host, that the client will create
  - getMaxTotalConnections
```
public int getMaxTotalConnections()
```
    Gets the maximum number of total connections the client will create. Default value is 20.
    
    戻り値:
    maximum number of total connections the client will create
  - setMaxTotalConnections
```
public void setMaxTotalConnections(int max)
```
    Sets the maximum number of total connections the client will create.
    
    パラメータ:
    max - maximum number of total connections the client will create, must be greater than zero
  - getConnectionRetryAttempts
```
public int getConnectionRetryAttempts()
```
    Gets the number of times a connection will be tried if a host is unreachable.
    
    戻り値:
    number of times a connection will be tried if a host is unreachable
  - setConnectionRetryAttempts
```
public void setConnectionRetryAttempts(int attempts)
```
    Sets the number of times a connection will be tried if a host is unreachable.
    
    パラメータ:
    attempts - number of times a connection will be tried if a host is unreachable
  - getHttpsProtocolSocketFactory
```
public org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory getHttpsProtocolSocketFactory()
```
    Gets the protocol socket factory used for the https scheme.
    
    戻り値:
    protocol socket factory used for the https scheme
  - setHttpsProtocolSocketFactory
```
public void setHttpsProtocolSocketFactory(org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory factory)
```
    Sets the protocol socket factory used for the https scheme.
    
    パラメータ:
    factory - the httpsProtocolSocketFactory to set

クラス HttpClientBuilder

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

HttpClientBuilder

メソッドの詳細

resetDefaults

buildClient

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

isPreemptiveAuthentication

setPreemptiveAuthentication

getContentCharSet

setContentCharSet

getConnectionTimeout

setConnectionTimeout

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

isTcpNoDelay

setTcpNoDelay

getMaxConnectionsPerHost

setMaxConnectionsPerHost

getMaxTotalConnections

setMaxTotalConnections

getConnectionRetryAttempts

setConnectionRetryAttempts

getHttpsProtocolSocketFactory

setHttpsProtocolSocketFactory