org.springframework.remoting.httpinvoker
Class SimpleHttpInvokerServiceExporter

java.lang.Object
  extended by org.springframework.remoting.support.RemotingSupport
      extended by org.springframework.remoting.support.RemoteExporter
          extended by org.springframework.remoting.support.RemoteInvocationBasedExporter
              extended by org.springframework.remoting.rmi.RemoteInvocationSerializingExporter
                  extended by org.springframework.remoting.httpinvoker.SimpleHttpInvokerServiceExporter
All Implemented Interfaces:
HttpHandler, Aware, BeanClassLoaderAware, InitializingBean

public class SimpleHttpInvokerServiceExporter
extends RemoteInvocationSerializingExporter
implements HttpHandler

HTTP request handler that exports the specified service bean as HTTP invoker service endpoint, accessible via an HTTP invoker proxy. Designed for Sun's JRE 1.6 HTTP server, implementing the HttpHandler interface.

Deserializes remote invocation objects and serializes remote invocation result objects. Uses Java serialization just like RMI, but provides the same ease of setup as Caucho's HTTP-based Hessian and Burlap protocols.

HTTP invoker is the recommended protocol for Java-to-Java remoting. It is more powerful and more extensible than Hessian and Burlap, at the expense of being tied to Java. Nevertheless, it is as easy to set up as Hessian and Burlap, which is its main advantage compared to RMI.

Since:
2.5.1
Author:
Juergen Hoeller
See Also:
HttpInvokerClientInterceptor, HttpInvokerProxyFactoryBean, SimpleHessianServiceExporter, SimpleBurlapServiceExporter

Field Summary
 
Fields inherited from class org.springframework.remoting.rmi.RemoteInvocationSerializingExporter
CONTENT_TYPE_SERIALIZED_OBJECT
 
Fields inherited from class org.springframework.remoting.support.RemotingSupport
logger
 
Constructor Summary
SimpleHttpInvokerServiceExporter()
           
 
Method Summary
protected  InputStream decorateInputStream(HttpExchange exchange, InputStream is)
          Return the InputStream to use for reading remote invocations, potentially decorating the given original InputStream.
protected  OutputStream decorateOutputStream(HttpExchange exchange, OutputStream os)
          Return the OutputStream to use for writing remote invocation results, potentially decorating the given original OutputStream.
 void handle(HttpExchange exchange)
          Reads a remote invocation from the request, executes it, and writes the remote invocation result to the response.
protected  RemoteInvocation readRemoteInvocation(HttpExchange exchange)
          Read a RemoteInvocation from the given HTTP request.
protected  RemoteInvocation readRemoteInvocation(HttpExchange exchange, InputStream is)
          Deserialize a RemoteInvocation object from the given InputStream.
protected  void writeRemoteInvocationResult(HttpExchange exchange, RemoteInvocationResult result)
          Write the given RemoteInvocationResult to the given HTTP response.
protected  void writeRemoteInvocationResult(HttpExchange exchange, RemoteInvocationResult result, OutputStream os)
          Serialize the given RemoteInvocation to the given OutputStream.
 
Methods inherited from class org.springframework.remoting.rmi.RemoteInvocationSerializingExporter
afterPropertiesSet, createObjectInputStream, createObjectOutputStream, doReadRemoteInvocation, doWriteRemoteInvocationResult, getContentType, getProxy, prepare, setContentType
 
Methods inherited from class org.springframework.remoting.support.RemoteInvocationBasedExporter
getRemoteInvocationExecutor, invoke, invokeAndCreateResult, setRemoteInvocationExecutor
 
Methods inherited from class org.springframework.remoting.support.RemoteExporter
checkService, checkServiceInterface, getExporterName, getProxyForService, getService, getServiceInterface, setInterceptors, setRegisterTraceInterceptor, setService, setServiceInterface
 
Methods inherited from class org.springframework.remoting.support.RemotingSupport
getBeanClassLoader, overrideThreadContextClassLoader, resetThreadContextClassLoader, setBeanClassLoader
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleHttpInvokerServiceExporter

public SimpleHttpInvokerServiceExporter()
Method Detail

handle

public void handle(HttpExchange exchange)
            throws IOException
Reads a remote invocation from the request, executes it, and writes the remote invocation result to the response.

Specified by:
handle in interface HttpHandler
Throws:
IOException
See Also:
readRemoteInvocation(com.sun.net.httpserver.HttpExchange), RemoteInvocationBasedExporter.invokeAndCreateResult(org.springframework.remoting.support.RemoteInvocation, Object), writeRemoteInvocationResult(com.sun.net.httpserver.HttpExchange, org.springframework.remoting.support.RemoteInvocationResult)

readRemoteInvocation

protected RemoteInvocation readRemoteInvocation(HttpExchange exchange)
                                         throws IOException,
                                                ClassNotFoundException
Read a RemoteInvocation from the given HTTP request.

Delegates to readRemoteInvocation(com.sun.net.httpserver.HttpExchange, java.io.InputStream) with the HttpExchange.getRequestBody() request's input stream}.

Parameters:
exchange - current HTTP request/response
Returns:
the RemoteInvocation object
Throws:
IOException - in case of I/O failure
ClassNotFoundException - if thrown by deserialization

readRemoteInvocation

protected RemoteInvocation readRemoteInvocation(HttpExchange exchange,
                                                InputStream is)
                                         throws IOException,
                                                ClassNotFoundException
Deserialize a RemoteInvocation object from the given InputStream.

Gives decorateInputStream(com.sun.net.httpserver.HttpExchange, java.io.InputStream) a chance to decorate the stream first (for example, for custom encryption or compression). Creates a CodebaseAwareObjectInputStream and calls RemoteInvocationSerializingExporter.doReadRemoteInvocation(java.io.ObjectInputStream) to actually read the object.

Can be overridden for custom serialization of the invocation.

Parameters:
exchange - current HTTP request/response
is - the InputStream to read from
Returns:
the RemoteInvocation object
Throws:
IOException - in case of I/O failure
ClassNotFoundException - if thrown during deserialization

decorateInputStream

protected InputStream decorateInputStream(HttpExchange exchange,
                                          InputStream is)
                                   throws IOException
Return the InputStream to use for reading remote invocations, potentially decorating the given original InputStream.

The default implementation returns the given stream as-is. Can be overridden, for example, for custom encryption or compression.

Parameters:
exchange - current HTTP request/response
is - the original InputStream
Returns:
the potentially decorated InputStream
Throws:
IOException - in case of I/O failure

writeRemoteInvocationResult

protected void writeRemoteInvocationResult(HttpExchange exchange,
                                           RemoteInvocationResult result)
                                    throws IOException
Write the given RemoteInvocationResult to the given HTTP response.

Parameters:
exchange - current HTTP request/response
result - the RemoteInvocationResult object
Throws:
IOException - in case of I/O failure

writeRemoteInvocationResult

protected void writeRemoteInvocationResult(HttpExchange exchange,
                                           RemoteInvocationResult result,
                                           OutputStream os)
                                    throws IOException
Serialize the given RemoteInvocation to the given OutputStream.

The default implementation gives decorateOutputStream(com.sun.net.httpserver.HttpExchange, java.io.OutputStream) a chance to decorate the stream first (for example, for custom encryption or compression). Creates an ObjectOutputStream for the final stream and calls RemoteInvocationSerializingExporter.doWriteRemoteInvocationResult(org.springframework.remoting.support.RemoteInvocationResult, java.io.ObjectOutputStream) to actually write the object.

Can be overridden for custom serialization of the invocation.

Parameters:
exchange - current HTTP request/response
result - the RemoteInvocationResult object
os - the OutputStream to write to
Throws:
IOException - in case of I/O failure
See Also:
decorateOutputStream(com.sun.net.httpserver.HttpExchange, java.io.OutputStream), RemoteInvocationSerializingExporter.doWriteRemoteInvocationResult(org.springframework.remoting.support.RemoteInvocationResult, java.io.ObjectOutputStream)

decorateOutputStream

protected OutputStream decorateOutputStream(HttpExchange exchange,
                                            OutputStream os)
                                     throws IOException
Return the OutputStream to use for writing remote invocation results, potentially decorating the given original OutputStream.

The default implementation returns the given stream as-is. Can be overridden, for example, for custom encryption or compression.

Parameters:
exchange - current HTTP request/response
os - the original OutputStream
Returns:
the potentially decorated OutputStream
Throws:
IOException - in case of I/O failure