|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor org.springframework.remoting.httpinvoker.CommonsHttpInvokerRequestExecutor
public class CommonsHttpInvokerRequestExecutor
HttpInvokerRequestExecutor
implementation that uses
Jakarta Commons HttpClient
to execute POST requests. Requires Commons HttpClient 3.0 or higher.
Allows to use a pre-configured HttpClient
instance, potentially with authentication, HTTP connection pooling, etc.
Also designed for easy subclassing, providing specific template methods.
SimpleHttpInvokerRequestExecutor
Field Summary |
---|
Fields inherited from class org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor |
---|
CONTENT_TYPE_SERIALIZED_OBJECT, ENCODING_GZIP, HTTP_HEADER_ACCEPT_ENCODING, HTTP_HEADER_CONTENT_ENCODING, HTTP_HEADER_CONTENT_LENGTH, HTTP_HEADER_CONTENT_TYPE, HTTP_METHOD_POST, logger |
Constructor Summary | |
---|---|
CommonsHttpInvokerRequestExecutor()
Create a new CommonsHttpInvokerRequestExecutor with a default HttpClient that uses a default MultiThreadedHttpConnectionManager. |
|
CommonsHttpInvokerRequestExecutor(HttpClient httpClient)
Create a new CommonsHttpInvokerRequestExecutor with the given HttpClient instance. |
Method Summary | |
---|---|
protected PostMethod |
createPostMethod(HttpInvokerClientConfiguration config)
Create a PostMethod for the given configuration. |
protected RemoteInvocationResult |
doExecuteRequest(HttpInvokerClientConfiguration config,
ByteArrayOutputStream baos)
Execute the given request through Commons HttpClient. |
protected void |
executePostMethod(HttpInvokerClientConfiguration config,
HttpClient httpClient,
PostMethod postMethod)
Execute the given PostMethod instance. |
HttpClient |
getHttpClient()
Return the HttpClient instance that this request executor uses. |
protected InputStream |
getResponseBody(HttpInvokerClientConfiguration config,
PostMethod postMethod)
Extract the response body from the given executed remote invocation request. |
protected boolean |
isGzipResponse(PostMethod postMethod)
Determine whether the given response indicates a GZIP response. |
void |
setHttpClient(HttpClient httpClient)
Set the HttpClient instance to use for this request executor. |
void |
setReadTimeout(int timeout)
Set the socket read timeout for the underlying HttpClient. |
protected void |
setRequestBody(HttpInvokerClientConfiguration config,
PostMethod postMethod,
ByteArrayOutputStream baos)
Set the given serialized remote invocation as request body. |
protected void |
validateResponse(HttpInvokerClientConfiguration config,
PostMethod postMethod)
Validate the given response as contained in the PostMethod object, throwing an exception if it does not correspond to a successful HTTP response. |
Methods inherited from class org.springframework.remoting.httpinvoker.AbstractHttpInvokerRequestExecutor |
---|
createObjectInputStream, decorateInputStream, decorateOutputStream, doReadRemoteInvocationResult, doWriteRemoteInvocation, executeRequest, getBeanClassLoader, getByteArrayOutputStream, getContentType, isAcceptGzipEncoding, readRemoteInvocationResult, setAcceptGzipEncoding, setBeanClassLoader, setContentType, writeRemoteInvocation |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CommonsHttpInvokerRequestExecutor()
DEFAULT_READ_TIMEOUT_MILLISECONDS
.
HttpClient
,
MultiThreadedHttpConnectionManager
public CommonsHttpInvokerRequestExecutor(HttpClient httpClient)
httpClient
- the HttpClient instance to use for this request executorMethod Detail |
---|
public void setHttpClient(HttpClient httpClient)
public HttpClient getHttpClient()
public void setReadTimeout(int timeout)
timeout
- the timeout value in millisecondsHttpConnectionParams.setSoTimeout(int)
,
DEFAULT_READ_TIMEOUT_MILLISECONDS
protected RemoteInvocationResult doExecuteRequest(HttpInvokerClientConfiguration config, ByteArrayOutputStream baos) throws IOException, ClassNotFoundException
This method implements the basic processing workflow: The actual work happens in this class's template methods.
doExecuteRequest
in class AbstractHttpInvokerRequestExecutor
config
- the HTTP invoker configuration that specifies the
target servicebaos
- the ByteArrayOutputStream that contains the serialized
RemoteInvocation object
IOException
- if thrown by I/O operations
ClassNotFoundException
- if thrown during deserializationcreatePostMethod(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration)
,
setRequestBody(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.commons.httpclient.methods.PostMethod, java.io.ByteArrayOutputStream)
,
executePostMethod(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.commons.httpclient.HttpClient, org.apache.commons.httpclient.methods.PostMethod)
,
validateResponse(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.commons.httpclient.methods.PostMethod)
,
getResponseBody(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, org.apache.commons.httpclient.methods.PostMethod)
protected PostMethod createPostMethod(HttpInvokerClientConfiguration config) throws IOException
The default implementation creates a standard PostMethod with "application/x-java-serialized-object" as "Content-Type" header.
config
- the HTTP invoker configuration that specifies the
target service
IOException
- if thrown by I/O methodsprotected void setRequestBody(HttpInvokerClientConfiguration config, PostMethod postMethod, ByteArrayOutputStream baos) throws IOException
The default implementation simply sets the serialized invocation as the PostMethod's request body. This can be overridden, for example, to write a specific encoding and potentially set appropriate HTTP request headers.
config
- the HTTP invoker configuration that specifies the target servicepostMethod
- the PostMethod to set the request body onbaos
- the ByteArrayOutputStream that contains the serialized
RemoteInvocation object
IOException
- if thrown by I/O methodsEntityEnclosingMethod.setRequestBody(java.io.InputStream)
,
EntityEnclosingMethod.setRequestEntity(org.apache.commons.httpclient.methods.RequestEntity)
,
InputStreamRequestEntity
protected void executePostMethod(HttpInvokerClientConfiguration config, HttpClient httpClient, PostMethod postMethod) throws IOException
config
- the HTTP invoker configuration that specifies the target servicehttpClient
- the HttpClient to execute onpostMethod
- the PostMethod to execute
IOException
- if thrown by I/O methodsHttpClient.executeMethod(org.apache.commons.httpclient.HttpMethod)
protected void validateResponse(HttpInvokerClientConfiguration config, PostMethod postMethod) throws IOException
Default implementation rejects any HTTP status code beyond 2xx, to avoid parsing the response body and trying to deserialize from a corrupted stream.
config
- the HTTP invoker configuration that specifies the target servicepostMethod
- the executed PostMethod to validate
IOException
- if validation failedHttpMethodBase.getStatusCode()
,
HttpException
protected InputStream getResponseBody(HttpInvokerClientConfiguration config, PostMethod postMethod) throws IOException
The default implementation simply fetches the PostMethod's response body stream. If the response is recognized as GZIP response, the InputStream will get wrapped in a GZIPInputStream.
config
- the HTTP invoker configuration that specifies the target servicepostMethod
- the PostMethod to read the response body from
IOException
- if thrown by I/O methodsisGzipResponse(org.apache.commons.httpclient.methods.PostMethod)
,
GZIPInputStream
,
HttpMethodBase.getResponseBodyAsStream()
,
HttpMethodBase.getResponseHeader(String)
protected boolean isGzipResponse(PostMethod postMethod)
Default implementation checks whether the HTTP "Content-Encoding" header contains "gzip" (in any casing).
postMethod
- the PostMethod to check
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |