Class SimpleHttpConnectionManager
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.SimpleHttpConnectionManager
- All Implemented Interfaces:
HttpConnectionManager
A connection manager that provides access to a single HttpConnection. This
manager makes no attempt to provide exclusive access to the contained
HttpConnection.
- Since:
- 2.0
-
Field Summary
-
Constructor Summary
ConstructorDescriptionThe connection manager created with this constructor will always try to keep the connection open (alive) between consecutive requests.SimpleHttpConnectionManager
(boolean alwaysClose) The connection manager created with this constructor will try to keep the connection open (alive) between consecutive requests if the alwaysClose parameter is set to false. -
Method Summary
Modifier and TypeMethodDescriptionvoid
closeIdleConnections
(long idleTimeout) Closes connections that have been idle for at least the given amount of time.getConnection
(HostConfiguration hostConfiguration) Gets an HttpConnection for a given host configuration.getConnection
(HostConfiguration hostConfiguration, long timeout) Deprecated.Use #getConnectionWithTimeout(HostConfiguration, long)getConnectionWithTimeout
(HostConfiguration hostConfiguration, long timeout) This method always returns the same connection object.Returnsparameters
associated with this connection manager.boolean
void
Releases the given HttpConnection for use by other requests.void
setConnectionStaleCheckingEnabled
(boolean connectionStaleCheckingEnabled) void
setParams
(HttpConnectionManagerParams params) Assignsparameters
for this connection manager.void
shutdown()
since 3.1
-
Field Details
-
httpConnection
The http connection
-
-
Constructor Details
-
SimpleHttpConnectionManager
public SimpleHttpConnectionManager(boolean alwaysClose) The connection manager created with this constructor will try to keep the connection open (alive) between consecutive requests if the alwaysClose parameter is set to false. Otherwise the connection manager will always close connections upon release.- Parameters:
alwaysClose
- if set true, the connection manager will always close connections upon release.
-
SimpleHttpConnectionManager
public SimpleHttpConnectionManager()The connection manager created with this constructor will always try to keep the connection open (alive) between consecutive requests.
-
-
Method Details
-
getConnection
Description copied from interface:HttpConnectionManager
Gets an HttpConnection for a given host configuration. If a connection is not available this method will block until one is. The connection manager should be registered with any HttpConnection that is created.- Specified by:
getConnection
in interfaceHttpConnectionManager
- Parameters:
hostConfiguration
- the host configuration to use to configure the connection- Returns:
- an HttpConnection for the given configuration
- See Also:
-
isConnectionStaleCheckingEnabled
public boolean isConnectionStaleCheckingEnabled()Gets the staleCheckingEnabled value to be set on HttpConnections that are created.- Returns:
true
if stale checking will be enabled on HttpConections- See Also:
-
setConnectionStaleCheckingEnabled
public void setConnectionStaleCheckingEnabled(boolean connectionStaleCheckingEnabled) Deprecated.Sets the staleCheckingEnabled value to be set on HttpConnections that are created.- Parameters:
connectionStaleCheckingEnabled
-true
if stale checking will be enabled on HttpConections- See Also:
-
getConnectionWithTimeout
This method always returns the same connection object. If the connection is already open, it will be closed and the new host configuration will be applied.- Specified by:
getConnectionWithTimeout
in interfaceHttpConnectionManager
- Parameters:
hostConfiguration
- The host configuration specifying the connection details.timeout
- this parameter has no effect. The connection is always returned immediately.- Returns:
- an HttpConnection for the given configuraiton
- Since:
- 3.0
- See Also:
-
getConnection
Deprecated.Use #getConnectionWithTimeout(HostConfiguration, long)Description copied from interface:HttpConnectionManager
Gets an HttpConnection for a given host configuration. If a connection is not available, this method will block for at most the specified number of milliseconds or until a connection becomes available. The connection manager should be registered with any HttpConnection that is created.- Specified by:
getConnection
in interfaceHttpConnectionManager
- Parameters:
hostConfiguration
- the host configuration to use to configure the connectiontimeout
- - the time (in milliseconds) to wait for a connection to become available, 0 to specify an infinite timeout- Returns:
- an HttpConnection for the given configuraiton
- See Also:
-
releaseConnection
Description copied from interface:HttpConnectionManager
Releases the given HttpConnection for use by other requests.- Specified by:
releaseConnection
in interfaceHttpConnectionManager
- Parameters:
conn
- - The HttpConnection to make available.- See Also:
-
HttpConnectionManager#releaseConnection(org.apache.commons.httpclient.HttpConnection)
-
getParams
Returnsparameters
associated with this connection manager.- Specified by:
getParams
in interfaceHttpConnectionManager
- Since:
- 2.1
- See Also:
-
setParams
Assignsparameters
for this connection manager.- Specified by:
setParams
in interfaceHttpConnectionManager
- Since:
- 2.1
- See Also:
-
closeIdleConnections
public void closeIdleConnections(long idleTimeout) Description copied from interface:HttpConnectionManager
Closes connections that have been idle for at least the given amount of time. Only connections that are currently owned, not checked out, are subject to idle timeouts.- Specified by:
closeIdleConnections
in interfaceHttpConnectionManager
- Parameters:
idleTimeout
- the minimum idle time, in milliseconds, for connections to be closed- Since:
- 3.0
-
shutdown
public void shutdown()since 3.1
-