| java.lang.Object | |||||
| ↳ | org.springframework.remoting.support.RemotingSupport | ||||
| ↳ | org.springframework.remoting.support.RemoteExporter | ||||
| ↳ | org.springframework.remoting.support.RemoteInvocationBasedExporter | ||||
| ↳ | org.springframework.remoting.rmi.RmiBasedExporter | ||||
| ↳ | org.springframework.remoting.rmi.RmiServiceExporter | ||||
Class Overview
RMI exporter that exposes the specified service as RMI object with the specified name.
Such services can be accessed via plain RMI or via RmiProxyFactoryBean.
Also supports exposing any non-RMI service via RMI invokers, to be accessed via
RmiClientInterceptor / RmiProxyFactoryBean's automatic detection
of such invokers.
With an RMI invoker, RMI communication works on the RmiInvocationHandler
level, needing only one stub for any service. Service interfaces do not have to
extend java.rmi.Remote or throw java.rmi.RemoteException
on all methods, but in and out parameters have to be serializable.
The major advantage of RMI, compared to Hessian and Burlap, is serialization. Effectively, any serializable Java object can be transported without hassle. Hessian and Burlap have their own (de-)serialization mechanisms, but are HTTP-based and thus much easier to setup than RMI. Alternatively, consider Spring's HTTP invoker to combine Java serialization with HTTP-based transport.
Note: RMI makes a best-effort attempt to obtain the fully qualified host name.
If one cannot be determined, it will fall back and use the IP address. Depending
on your network configuration, in some cases it will resolve the IP to the loopback
address. To ensure that RMI will use the host name bound to the correct network
interface, you should pass the java.rmi.server.hostname property to the
JVM that will export the registry and/or the service using the "-D" JVM argument.
For example: -Djava.rmi.server.hostname=myserver.com
Summary
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
org.springframework.remoting.support.RemotingSupport
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
| |||||||||||
Unbind the RMI service from the registry on bean factory shutdown.
| |||||||||||
Initialize this service exporter, registering the service as RMI object.
| |||||||||||
Set whether to always create the registry in-process,
not attempting to locate an existing registry at the specified port.
| |||||||||||
Set a custom RMI client socket factory to use for exporting the service.
| |||||||||||
Specify the RMI registry to register the exported service with.
| |||||||||||
Set a custom RMI client socket factory to use for the RMI registry.
| |||||||||||
Set the host of the registry for the exported RMI service,
i.e.
| |||||||||||
Set the port of the registry for the exported RMI service,
i.e.
| |||||||||||
Set a custom RMI server socket factory to use for the RMI registry.
| |||||||||||
Set whether to replace an existing binding in the RMI registry,
that is, whether to simply override an existing binding with the
specified service in case of a naming conflict in the registry.
| |||||||||||
Set a custom RMI server socket factory to use for exporting the service.
| |||||||||||
Set the name of the exported RMI service,
i.e.
| |||||||||||
Set the port that the exported RMI service will use.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Locate or create the RMI registry for this exporter.
| |||||||||||
Locate or create the RMI registry for this exporter.
| |||||||||||
Locate or create the RMI registry for this exporter.
| |||||||||||
Test the given RMI registry, calling some operation on it to
check whether it is still active.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
org.springframework.remoting.rmi.RmiBasedExporter
| |||||||||||
|
From class
org.springframework.remoting.support.RemoteInvocationBasedExporter
| |||||||||||
|
From class
org.springframework.remoting.support.RemoteExporter
| |||||||||||
|
From class
org.springframework.remoting.support.RemotingSupport
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
org.springframework.beans.factory.BeanClassLoaderAware
| |||||||||||
|
From interface
org.springframework.beans.factory.DisposableBean
| |||||||||||
|
From interface
org.springframework.beans.factory.InitializingBean
| |||||||||||
Public Constructors
public RmiServiceExporter ()
Public Methods
public void afterPropertiesSet ()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
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.
Throws
| RemoteException |
|---|
public void destroy ()
Unbind the RMI service from the registry on bean factory shutdown.
Throws
| RemoteException |
|---|
public void prepare ()
Initialize this service exporter, registering the service as RMI object.
Creates an RMI registry on the specified port if none exists.
Throws
| RemoteException | if service registration failed |
|---|
public void setAlwaysCreateRegistry (boolean alwaysCreateRegistry)
Set whether to always create the registry in-process, not attempting to locate an existing registry at the specified port.
Default is "false". Switch this flag to "true" in order to avoid the overhead of locating an existing registry when you always intend to create a new registry in any case.
public void setClientSocketFactory (RMIClientSocketFactory clientSocketFactory)
Set a custom RMI client socket factory to use for exporting the service.
If the given object also implements java.rmi.server.RMIServerSocketFactory,
it will automatically be registered as server socket factory too.
public void setRegistry (Registry registry)
Specify the RMI registry to register the exported service with. Typically used in combination with RmiRegistryFactoryBean.
Alternatively, you can specify all registry properties locally. This exporter will then try to locate the specified registry, automatically creating a new local one if appropriate.
Default is a local registry at the default port (1099), created on the fly if necessary.
public void setRegistryClientSocketFactory (RMIClientSocketFactory registryClientSocketFactory)
Set a custom RMI client socket factory to use for the RMI registry.
If the given object also implements java.rmi.server.RMIServerSocketFactory,
it will automatically be registered as server socket factory too.
public void setRegistryHost (String registryHost)
Set the host of the registry for the exported RMI service,
i.e. rmi://HOST:port/name
Default is localhost.
public void setRegistryPort (int registryPort)
Set the port of the registry for the exported RMI service,
i.e. rmi://host:PORT/name
Default is Registry.REGISTRY_PORT (1099).
See Also
public void setRegistryServerSocketFactory (RMIServerSocketFactory registryServerSocketFactory)
Set a custom RMI server socket factory to use for the RMI registry.
Only needs to be specified when the client socket factory does not
implement java.rmi.server.RMIServerSocketFactory already.
public void setReplaceExistingBinding (boolean replaceExistingBinding)
Set whether to replace an existing binding in the RMI registry, that is, whether to simply override an existing binding with the specified service in case of a naming conflict in the registry.
Default is "true", assuming that an existing binding for this exporter's service name is an accidental leftover from a previous execution. Switch this to "false" to make the exporter fail in such a scenario, indicating that there was already an RMI object bound.
public void setServerSocketFactory (RMIServerSocketFactory serverSocketFactory)
Set a custom RMI server socket factory to use for exporting the service.
Only needs to be specified when the client socket factory does not
implement java.rmi.server.RMIServerSocketFactory already.
public void setServiceName (String serviceName)
Set the name of the exported RMI service,
i.e. rmi://host:port/NAME
public void setServicePort (int servicePort)
Set the port that the exported RMI service will use.
Default is 0 (anonymous port).
Protected Methods
protected Registry getRegistry (String registryHost, int registryPort, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory)
Locate or create the RMI registry for this exporter.
Parameters
| registryHost | the registry host to use (if this is specified, no implicit creation of a RMI registry will happen) |
|---|---|
| registryPort | the registry port to use |
| clientSocketFactory | the RMI client socket factory for the registry (if any) |
| serverSocketFactory | the RMI server socket factory for the registry (if any) |
Returns
- the RMI registry
Throws
| RemoteException | if the registry couldn't be located or created |
|---|
protected Registry getRegistry (int registryPort)
Locate or create the RMI registry for this exporter.
Parameters
| registryPort | the registry port to use |
|---|
Returns
- the RMI registry
Throws
| RemoteException | if the registry couldn't be located or created |
|---|
protected Registry getRegistry (int registryPort, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory)
Locate or create the RMI registry for this exporter.
Parameters
| registryPort | the registry port to use |
|---|---|
| clientSocketFactory | the RMI client socket factory for the registry (if any) |
| serverSocketFactory | the RMI server socket factory for the registry (if any) |
Returns
- the RMI registry
Throws
| RemoteException | if the registry couldn't be located or created |
|---|
protected void testRegistry (Registry registry)
Test the given RMI registry, calling some operation on it to check whether it is still active.
Default implementation calls Registry.list().
Parameters
| registry | the RMI registry to test |
|---|
Throws
| RemoteException | if thrown by registry methods |
|---|