public class RmiServiceExporter extends RmiBasedExporter implements InitializingBean, DisposableBean
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
RmiClientInterceptor
,
RmiProxyFactoryBean
,
Remote
,
RemoteException
,
HessianServiceExporter
,
BurlapServiceExporter
,
HttpInvokerServiceExporter
logger
Constructor and Description |
---|
RmiServiceExporter() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by the containing
BeanFactory after it has set all bean properties
and satisfied BeanFactoryAware , ApplicationContextAware etc. |
void |
destroy()
Unbind the RMI service from the registry on bean factory shutdown.
|
protected Registry |
getRegistry(int registryPort)
Locate or create the RMI registry for this exporter.
|
protected Registry |
getRegistry(int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Locate or create the RMI registry for this exporter.
|
protected Registry |
getRegistry(String registryHost,
int registryPort,
RMIClientSocketFactory clientSocketFactory,
RMIServerSocketFactory serverSocketFactory)
Locate or create the RMI registry for this exporter.
|
void |
prepare()
Initialize this service exporter, registering the service as RMI object.
|
void |
setAlwaysCreateRegistry(boolean alwaysCreateRegistry)
Set whether to always create the registry in-process,
not attempting to locate an existing registry at the specified port.
|
void |
setClientSocketFactory(RMIClientSocketFactory clientSocketFactory)
Set a custom RMI client socket factory to use for exporting the service.
|
void |
setRegistry(Registry registry)
Specify the RMI registry to register the exported service with.
|
void |
setRegistryClientSocketFactory(RMIClientSocketFactory registryClientSocketFactory)
Set a custom RMI client socket factory to use for the RMI registry.
|
void |
setRegistryHost(String registryHost)
Set the host of the registry for the exported RMI service,
i.e.
|
void |
setRegistryPort(int registryPort)
Set the port of the registry for the exported RMI service,
i.e.
|
void |
setRegistryServerSocketFactory(RMIServerSocketFactory registryServerSocketFactory)
Set a custom RMI server socket factory to use for the RMI registry.
|
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.
|
void |
setServerSocketFactory(RMIServerSocketFactory serverSocketFactory)
Set a custom RMI server socket factory to use for exporting the service.
|
void |
setServiceName(String serviceName)
Set the name of the exported RMI service,
i.e.
|
void |
setServicePort(int servicePort)
Set the port that the exported RMI service will use.
|
protected void |
testRegistry(Registry registry)
Test the given RMI registry, calling some operation on it to
check whether it is still active.
|
getObjectToExport, invoke
getRemoteInvocationExecutor, invokeAndCreateResult, setRemoteInvocationExecutor
checkService, checkServiceInterface, getExporterName, getProxyForService, getService, getServiceInterface, setInterceptors, setRegisterTraceInterceptor, setService, setServiceInterface
getBeanClassLoader, overrideThreadContextClassLoader, resetThreadContextClassLoader, setBeanClassLoader
public void setServiceName(String serviceName)
rmi://host:port/NAME
public void setServicePort(int servicePort)
Default is 0 (anonymous port).
public void setClientSocketFactory(RMIClientSocketFactory clientSocketFactory)
If the given object also implements java.rmi.server.RMIServerSocketFactory
,
it will automatically be registered as server socket factory too.
public void setServerSocketFactory(RMIServerSocketFactory serverSocketFactory)
Only needs to be specified when the client socket factory does not
implement java.rmi.server.RMIServerSocketFactory
already.
public void setRegistry(Registry registry)
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 setRegistryHost(String registryHost)
rmi://HOST:port/name
Default is localhost.
public void setRegistryPort(int registryPort)
rmi://host:PORT/name
Default is Registry.REGISTRY_PORT
(1099).
Registry.REGISTRY_PORT
public void setRegistryClientSocketFactory(RMIClientSocketFactory registryClientSocketFactory)
If the given object also implements java.rmi.server.RMIServerSocketFactory
,
it will automatically be registered as server socket factory too.
public void setRegistryServerSocketFactory(RMIServerSocketFactory registryServerSocketFactory)
Only needs to be specified when the client socket factory does not
implement java.rmi.server.RMIServerSocketFactory
already.
public void setAlwaysCreateRegistry(boolean alwaysCreateRegistry)
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 setReplaceExistingBinding(boolean replaceExistingBinding)
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 afterPropertiesSet() throws RemoteException
InitializingBean
BeanFactory
after it has set all bean properties
and satisfied BeanFactoryAware
, ApplicationContextAware
etc.
This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
afterPropertiesSet
in interface InitializingBean
RemoteException
public void prepare() throws RemoteException
Creates an RMI registry on the specified port if none exists.
RemoteException
- if service registration failedprotected Registry getRegistry(String registryHost, int registryPort, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory) throws RemoteException
registryHost
- the registry host to use (if this is specified,
no implicit creation of a RMI registry will happen)registryPort
- the registry port to useclientSocketFactory
- the RMI client socket factory for the registry (if any)serverSocketFactory
- the RMI server socket factory for the registry (if any)RemoteException
- if the registry couldn't be located or createdprotected Registry getRegistry(int registryPort, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory) throws RemoteException
registryPort
- the registry port to useclientSocketFactory
- the RMI client socket factory for the registry (if any)serverSocketFactory
- the RMI server socket factory for the registry (if any)RemoteException
- if the registry couldn't be located or createdprotected Registry getRegistry(int registryPort) throws RemoteException
registryPort
- the registry port to useRemoteException
- if the registry couldn't be located or createdprotected void testRegistry(Registry registry) throws RemoteException
Default implementation calls Registry.list()
.
registry
- the RMI registry to testRemoteException
- if thrown by registry methodsRegistry.list()
public void destroy() throws RemoteException
destroy
in interface DisposableBean
RemoteException