public class SimpleHttpInvokerRequestExecutor extends AbstractHttpInvokerRequestExecutor
HttpInvokerRequestExecutor
implementation
that uses standard Java facilities to execute POST requests, without support for HTTP
authentication or advanced configuration options.
Designed for easy subclassing, customizing specific template methods. However,
consider HttpComponentsHttpInvokerRequestExecutor
for more sophisticated needs:
The standard HttpURLConnection
class is rather limited in its capabilities.
HttpURLConnection
CONTENT_TYPE_SERIALIZED_OBJECT, ENCODING_GZIP, HTTP_HEADER_ACCEPT_ENCODING, HTTP_HEADER_ACCEPT_LANGUAGE, HTTP_HEADER_CONTENT_ENCODING, HTTP_HEADER_CONTENT_LENGTH, HTTP_HEADER_CONTENT_TYPE, HTTP_METHOD_POST, logger
Constructor and Description |
---|
SimpleHttpInvokerRequestExecutor() |
Modifier and Type | Method and Description |
---|---|
protected RemoteInvocationResult |
doExecuteRequest(HttpInvokerClientConfiguration config,
ByteArrayOutputStream baos)
Execute the given request through a standard
HttpURLConnection . |
protected boolean |
isGzipResponse(HttpURLConnection con)
Determine whether the given response is a GZIP response.
|
protected HttpURLConnection |
openConnection(HttpInvokerClientConfiguration config)
Open an
HttpURLConnection for the given remote invocation request. |
protected void |
prepareConnection(HttpURLConnection connection,
int contentLength)
Prepare the given HTTP connection.
|
protected InputStream |
readResponseBody(HttpInvokerClientConfiguration config,
HttpURLConnection con)
Extract the response body from the given executed remote invocation
request.
|
void |
setConnectTimeout(int connectTimeout)
Set the underlying URLConnection's connect timeout (in milliseconds).
|
void |
setReadTimeout(int readTimeout)
Set the underlying URLConnection's read timeout (in milliseconds).
|
protected void |
validateResponse(HttpInvokerClientConfiguration config,
HttpURLConnection con)
Validate the given response as contained in the
HttpURLConnection object,
throwing an exception if it does not correspond to a successful HTTP response. |
protected void |
writeRequestBody(HttpInvokerClientConfiguration config,
HttpURLConnection con,
ByteArrayOutputStream baos)
Set the given serialized remote invocation as request body.
|
createObjectInputStream, decorateInputStream, decorateOutputStream, doReadRemoteInvocationResult, doWriteRemoteInvocation, executeRequest, getBeanClassLoader, getByteArrayOutputStream, getContentType, isAcceptGzipEncoding, readRemoteInvocationResult, setAcceptGzipEncoding, setBeanClassLoader, setContentType, writeRemoteInvocation
public void setConnectTimeout(int connectTimeout)
Default is the system's default timeout.
URLConnection.setConnectTimeout(int)
public void setReadTimeout(int readTimeout)
Default is the system's default timeout.
URLConnection.setReadTimeout(int)
protected RemoteInvocationResult doExecuteRequest(HttpInvokerClientConfiguration config, ByteArrayOutputStream baos) throws IOException, ClassNotFoundException
HttpURLConnection
.
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 objectIOException
- if thrown by I/O operationsClassNotFoundException
- if thrown during deserializationopenConnection(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration)
,
prepareConnection(java.net.HttpURLConnection, int)
,
writeRequestBody(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, java.net.HttpURLConnection, java.io.ByteArrayOutputStream)
,
validateResponse(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, java.net.HttpURLConnection)
,
readResponseBody(org.springframework.remoting.httpinvoker.HttpInvokerClientConfiguration, java.net.HttpURLConnection)
protected HttpURLConnection openConnection(HttpInvokerClientConfiguration config) throws IOException
HttpURLConnection
for the given remote invocation request.config
- the HTTP invoker configuration that specifies the
target serviceIOException
- if thrown by I/O methodsURL.openConnection()
protected void prepareConnection(HttpURLConnection connection, int contentLength) throws IOException
The default implementation specifies POST as method, "application/x-java-serialized-object" as "Content-Type" header, and the given content length as "Content-Length" header.
connection
- the HTTP connection to preparecontentLength
- the length of the content to sendIOException
- if thrown by HttpURLConnection methodsHttpURLConnection.setRequestMethod(java.lang.String)
,
URLConnection.setRequestProperty(java.lang.String, java.lang.String)
protected void writeRequestBody(HttpInvokerClientConfiguration config, HttpURLConnection con, ByteArrayOutputStream baos) throws IOException
The default implementation simply write the serialized invocation to the HttpURLConnection's OutputStream. 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 servicecon
- the HttpURLConnection to write the request body tobaos
- the ByteArrayOutputStream that contains the serialized
RemoteInvocation objectIOException
- if thrown by I/O methodsURLConnection.getOutputStream()
,
URLConnection.setRequestProperty(java.lang.String, java.lang.String)
protected void validateResponse(HttpInvokerClientConfiguration config, HttpURLConnection con) throws IOException
HttpURLConnection
object,
throwing an exception if it does not correspond to a successful HTTP response.
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 servicecon
- the HttpURLConnection to validateIOException
- if validation failedHttpURLConnection.getResponseCode()
protected InputStream readResponseBody(HttpInvokerClientConfiguration config, HttpURLConnection con) throws IOException
The default implementation simply reads the serialized invocation from the HttpURLConnection's InputStream. 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 servicecon
- the HttpURLConnection to read the response body fromIOException
- if thrown by I/O methodsisGzipResponse(java.net.HttpURLConnection)
,
GZIPInputStream
,
URLConnection.getInputStream()
,
HttpURLConnection.getHeaderField(int)
,
HttpURLConnection.getHeaderFieldKey(int)
protected boolean isGzipResponse(HttpURLConnection con)
Default implementation checks whether the HTTP "Content-Encoding" header contains "gzip" (in any casing).
con
- the HttpURLConnection to check