HttpClientFactoryBean (Ektorp Spring 1.4.2 API)

java.lang.Object
- org.ektorp.spring.HttpClientFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<HttpClient>, org.springframework.beans.factory.InitializingBean
```
public class HttpClientFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<HttpClient>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
```
FactoryBean that produces a HttpClient. Configuration parameters are set through @Value annotations. The application context must define properties along the line of:

Author:

henrik lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autoUpdateViewOnChange`
`boolean`	`caching`
`boolean`	`cleanupIdleConnections`
`protected HttpClient`	`client`
`int`	`connectionTimeout`
`protected Properties`	`couchDBProperties`
`boolean`	`enableSSL`
`String`	`host`
`int`	`maxCacheEntries`
`int`	`maxConnections`
`int`	`maxObjectSizeBytes`
`String`	`password`
`int`	`port`
`boolean`	`relaxedSSLSettings`
`int`	`socketTimeout`
`protected org.apache.http.conn.ssl.SSLSocketFactory`	`sslSocketFactory`
`boolean`	`testConnectionAtStartup`
`String`	`url`
`boolean`	`useExpectContinue`
`String`	`username`

Constructor Summary

Constructors
Constructor and Description

HttpClientFactoryBean()

Constructors
Constructor and Description
`HttpClientFactoryBean()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()` Create the couchDB connection when starting the bean factory
`protected void`	`configureAutoUpdateViewOnChange()`
`void`	`destroy()` Shutdown the HTTP Client when destroying the bean
`HttpClient`	`getObject()`
`Class<? extends HttpClient>`	`getObjectType()`
`boolean`	`isSingleton()`
`void`	`setAutoUpdateViewOnChange(boolean b)`
`void`	`setCaching(boolean caching)`
`void`	`setCleanupIdleConnections(boolean cleanupIdleConnections)`
`void`	`setConnectionTimeout(int connectionTimeout)`
`void`	`setEnableSSL(boolean enableSSL)`
`void`	`setHost(String host)`
`void`	`setMaxCacheEntries(int maxCacheEntries)`
`void`	`setMaxConnections(int maxConnections)`
`void`	`setMaxObjectSizeBytes(int maxObjectSizeBytes)`
`void`	`setPassword(String s)`
`void`	`setPort(int port)`
`void`	`setProperties(Properties p)`
`void`	`setRelaxedSSLSettings(boolean relaxedSSLSettings)`
`void`	`setSocketTimeout(int socketTimeout)`
`void`	`setSslSocketFactory(org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)`
`void`	`setTestConnectionAtStartup(boolean b)`
`void`	`setUrl(String url)`
`void`	`setUseExpectContinue(boolean value)`
`void`	`setUsername(String user)`
`protected void`	`testConnect(HttpClient client)`

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

Field Detail

client
```
protected HttpClient client
```

url
```
public String url
```

host
```
public String host
```

port
```
public int port
```

maxConnections
```
public int maxConnections
```

connectionTimeout
```
public int connectionTimeout
```

socketTimeout
```
public int socketTimeout
```

autoUpdateViewOnChange
```
public boolean autoUpdateViewOnChange
```

username
```
public String username
```

password
```
public String password
```

testConnectionAtStartup
```
public boolean testConnectionAtStartup
```

cleanupIdleConnections
```
public boolean cleanupIdleConnections
```

enableSSL
```
public boolean enableSSL
```

relaxedSSLSettings
```
public boolean relaxedSSLSettings
```

caching
```
public boolean caching
```

maxCacheEntries
```
public int maxCacheEntries
```

maxObjectSizeBytes
```
public int maxObjectSizeBytes
```

useExpectContinue
```
public boolean useExpectContinue
```

sslSocketFactory

protected org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory

couchDBProperties
```
protected Properties couchDBProperties
```

Constructor Detail
- HttpClientFactoryBean
```
public HttpClientFactoryBean()
```

Method Detail

getObject
```
public HttpClient getObject()
                     throws Exception
```
Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<HttpClient>

Throws:

Exception

configureAutoUpdateViewOnChange

protected void configureAutoUpdateViewOnChange()

testConnect

protected void testConnect(HttpClient client)

getObjectType
```
public Class<? extends HttpClient> getObjectType()
```
Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<HttpClient>

isSingleton
```
public boolean isSingleton()
```
Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<HttpClient>

setAutoUpdateViewOnChange

public void setAutoUpdateViewOnChange(boolean b)

setUsername
```
public void setUsername(String user)
```

setPassword
```
public void setPassword(String s)
```

setUseExpectContinue

public void setUseExpectContinue(boolean value)

setTestConnectionAtStartup

public void setTestConnectionAtStartup(boolean b)

setSslSocketFactory

public void setSslSocketFactory(org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)

setHost
```
public void setHost(String host)
```

setPort
```
public void setPort(int port)
```

setMaxConnections

public void setMaxConnections(int maxConnections)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

setCleanupIdleConnections

public void setCleanupIdleConnections(boolean cleanupIdleConnections)

setEnableSSL

public void setEnableSSL(boolean enableSSL)

setRelaxedSSLSettings

public void setRelaxedSSLSettings(boolean relaxedSSLSettings)

setCaching

public void setCaching(boolean caching)

setMaxCacheEntries

public void setMaxCacheEntries(int maxCacheEntries)

setMaxObjectSizeBytes

public void setMaxObjectSizeBytes(int maxObjectSizeBytes)

setUrl
```
public void setUrl(String url)
```

setProperties

public void setProperties(Properties p)

destroy
```
public void destroy()
             throws Exception
```
Shutdown the HTTP Client when destroying the bean

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
Create the couchDB connection when starting the bean factory

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

Class HttpClientFactoryBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

url

host

port

maxConnections

connectionTimeout

socketTimeout

autoUpdateViewOnChange

username

password

testConnectionAtStartup

cleanupIdleConnections

enableSSL

relaxedSSLSettings

caching

maxCacheEntries

maxObjectSizeBytes

useExpectContinue

sslSocketFactory

couchDBProperties

Constructor Detail

HttpClientFactoryBean

Method Detail

getObject

configureAutoUpdateViewOnChange

testConnect

getObjectType

isSingleton

setAutoUpdateViewOnChange

setUsername

setPassword

setUseExpectContinue

setTestConnectionAtStartup

setSslSocketFactory

setHost

setPort

setMaxConnections

setConnectionTimeout

setSocketTimeout

setCleanupIdleConnections

setEnableSSL

setRelaxedSSLSettings

setCaching

setMaxCacheEntries

setMaxObjectSizeBytes

setUrl

setProperties

destroy

afterPropertiesSet