public class HttpInvokerClientInterceptor extends RemoteInvocationBasedAccessor implements MethodInterceptor, HttpInvokerClientConfiguration
MethodInterceptor
for accessing an
HTTP invoker service. The service URL must be an HTTP URL exposing
an HTTP invoker service.
Serializes remote invocation objects and deserializes 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 a very extensible and customizable protocol.
It supports the RemoteInvocationFactory mechanism, like RMI invoker,
allowing to include additional invocation attributes (for example,
a security context). Furthermore, it allows to customize request
execution via the HttpInvokerRequestExecutor
strategy.
Can use the JDK's RMIClassLoader
to load classes
from a given codebase
, performing on-demand dynamic
code download from a remote location. The codebase can consist of multiple
URLs, separated by spaces. Note that RMIClassLoader requires a SecurityManager
to be set, analogous to when using dynamic class download with standard RMI!
(See the RMI documentation for details.)
WARNING: Be aware of vulnerabilities due to unsafe Java deserialization: Manipulated input streams could lead to unwanted code execution on the server during the deserialization step. As a consequence, do not expose HTTP invoker endpoints to untrusted clients but rather just between your own services. In general, we strongly recommend any other message format (e.g. JSON) instead.
UrlBasedRemoteAccessor.setServiceUrl(java.lang.String)
,
setCodebaseUrl(java.lang.String)
,
RemoteInvocationBasedAccessor.setRemoteInvocationFactory(org.springframework.remoting.support.RemoteInvocationFactory)
,
setHttpInvokerRequestExecutor(org.springframework.remoting.httpinvoker.HttpInvokerRequestExecutor)
,
HttpInvokerServiceExporter
,
HttpInvokerProxyFactoryBean
,
RMIClassLoader
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
codebaseUrl |
private HttpInvokerRequestExecutor |
httpInvokerRequestExecutor |
logger
Constructor and Description |
---|
HttpInvokerClientInterceptor() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
protected RemoteAccessException |
convertHttpInvokerAccessException(java.lang.Throwable ex)
Convert the given HTTP invoker access exception to an appropriate
Spring
RemoteAccessException . |
protected RemoteInvocationResult |
executeRequest(RemoteInvocation invocation)
Execute the given remote invocation via the
HttpInvokerRequestExecutor . |
protected RemoteInvocationResult |
executeRequest(RemoteInvocation invocation,
MethodInvocation originalInvocation)
Execute the given remote invocation via the
HttpInvokerRequestExecutor . |
java.lang.String |
getCodebaseUrl()
Return the codebase URL to download classes from if not found locally.
|
HttpInvokerRequestExecutor |
getHttpInvokerRequestExecutor()
Return the HttpInvokerRequestExecutor used by this remote accessor.
|
java.lang.Object |
invoke(MethodInvocation methodInvocation)
Implement this method to perform extra treatments before and
after the invocation.
|
void |
setCodebaseUrl(java.lang.String codebaseUrl)
Set the codebase URL to download classes from if not found locally.
|
void |
setHttpInvokerRequestExecutor(HttpInvokerRequestExecutor httpInvokerRequestExecutor)
Set the HttpInvokerRequestExecutor implementation to use for executing
remote invocations.
|
createRemoteInvocation, getRemoteInvocationFactory, recreateRemoteInvocationResult, setRemoteInvocationFactory
getServiceUrl, setServiceUrl
getServiceInterface, setServiceInterface
getBeanClassLoader, overrideThreadContextClassLoader, resetThreadContextClassLoader, setBeanClassLoader
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getServiceUrl
private java.lang.String codebaseUrl
private HttpInvokerRequestExecutor httpInvokerRequestExecutor
public void setCodebaseUrl(java.lang.String codebaseUrl)
Follows RMI's codebase conventions for dynamic class download. In contrast to RMI, where the server determines the URL for class download (via the "java.rmi.server.codebase" system property), it's the client that determines the codebase URL here. The server will usually be the same as for the service URL, just pointing to a different path there.
UrlBasedRemoteAccessor.setServiceUrl(java.lang.String)
,
CodebaseAwareObjectInputStream
,
RMIClassLoader
public java.lang.String getCodebaseUrl()
getCodebaseUrl
in interface HttpInvokerClientConfiguration
null
if noneRMIClassLoader
public void setHttpInvokerRequestExecutor(HttpInvokerRequestExecutor httpInvokerRequestExecutor)
Default is SimpleHttpInvokerRequestExecutor
. Alternatively,
consider using HttpComponentsHttpInvokerRequestExecutor
for more
sophisticated needs.
public HttpInvokerRequestExecutor getHttpInvokerRequestExecutor()
Creates a default SimpleHttpInvokerRequestExecutor if no executor has been initialized already.
public void afterPropertiesSet()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
afterPropertiesSet
in class UrlBasedRemoteAccessor
public java.lang.Object invoke(MethodInvocation methodInvocation) throws java.lang.Throwable
MethodInterceptor
Joinpoint.proceed()
.invoke
in interface MethodInterceptor
methodInvocation
- the method invocation joinpointJoinpoint.proceed()
;
might be intercepted by the interceptorjava.lang.Throwable
- if the interceptors or the target object
throws an exceptionprotected RemoteInvocationResult executeRequest(RemoteInvocation invocation, MethodInvocation originalInvocation) throws java.lang.Exception
HttpInvokerRequestExecutor
.
This implementation delegates to executeRequest(RemoteInvocation)
.
Can be overridden to react to the specific original MethodInvocation.
invocation
- the RemoteInvocation to executeoriginalInvocation
- the original MethodInvocation (can e.g. be cast
to the ProxyMethodInvocation interface for accessing user attributes)java.lang.Exception
- in case of errorsprotected RemoteInvocationResult executeRequest(RemoteInvocation invocation) throws java.lang.Exception
HttpInvokerRequestExecutor
.
Can be overridden in subclasses to pass a different configuration object to the executor. Alternatively, add further configuration properties in a subclass of this accessor: By default, the accessor passed itself as configuration object to the executor.
invocation
- the RemoteInvocation to executejava.io.IOException
- if thrown by I/O operationsjava.lang.ClassNotFoundException
- if thrown during deserializationjava.lang.Exception
- in case of general errorsgetHttpInvokerRequestExecutor()
,
HttpInvokerClientConfiguration
protected RemoteAccessException convertHttpInvokerAccessException(java.lang.Throwable ex)
RemoteAccessException
.ex
- the exception to convertnull
to have the
original exception propagated to the caller