|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.remoting.support.RemoteExporter
org.springframework.remoting.support.RemoteInvocationBasedExporter
org.springframework.remoting.rmi.RmiServiceExporter
public class RmiServiceExporter
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 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. Ensuring 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
Field Summary |
---|
Fields inherited from class org.springframework.remoting.support.RemoteExporter |
---|
logger |
Constructor Summary | |
---|---|
RmiServiceExporter()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
Register the service as RMI object. |
void |
destroy()
Unbind the RMI service from the registry at bean factory shutdown. |
protected Remote |
getObjectToExport()
Determine the object to export: either the service object itself or a RmiInvocationWrapper in case of a non-RMI service object. |
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. |
protected Object |
invoke(RemoteInvocation invocation,
Object targetObject)
Redefined here to be visible to RmiInvocationWrapper. |
void |
setClientSocketFactory(RMIClientSocketFactory clientSocketFactory)
Set a custom RMI client socket factory to use for exporting the service. |
void |
setRegistryClientSocketFactory(RMIClientSocketFactory registryClientSocketFactory)
Set a custom RMI client socket factory to use for the RMI registry. |
void |
setRegistryHost(String registryHost)
Set the port 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 |
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. |
Methods inherited from class org.springframework.remoting.support.RemoteInvocationBasedExporter |
---|
getRemoteInvocationExecutor, invokeAndCreateResult, setRemoteInvocationExecutor |
Methods inherited from class org.springframework.remoting.support.RemoteExporter |
---|
checkService, checkServiceInterface, getExporterName, getProxyForService, getService, getServiceInterface, isRegisterTraceInterceptor, setRegisterTraceInterceptor, setService, setServiceInterface |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RmiServiceExporter()
Method Detail |
---|
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).
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.
setServerSocketFactory(java.rmi.server.RMIServerSocketFactory)
,
RMIClientSocketFactory
,
RMIServerSocketFactory
,
UnicastRemoteObject.exportObject(Remote, int, RMIClientSocketFactory, RMIServerSocketFactory)
public void setServerSocketFactory(RMIServerSocketFactory serverSocketFactory)
Only needs to be specified when the client socket factory does not
implement java.rmi.server.RMIServerSocketFactory
already.
setClientSocketFactory(java.rmi.server.RMIClientSocketFactory)
,
RMIClientSocketFactory
,
RMIServerSocketFactory
,
UnicastRemoteObject.exportObject(Remote, int, RMIClientSocketFactory, RMIServerSocketFactory)
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.
setRegistryServerSocketFactory(java.rmi.server.RMIServerSocketFactory)
,
RMIClientSocketFactory
,
RMIServerSocketFactory
,
LocateRegistry.getRegistry(String, int, RMIClientSocketFactory)
public void setRegistryServerSocketFactory(RMIServerSocketFactory registryServerSocketFactory)
Only needs to be specified when the client socket factory does not
implement java.rmi.server.RMIServerSocketFactory
already.
setRegistryClientSocketFactory(java.rmi.server.RMIClientSocketFactory)
,
RMIClientSocketFactory
,
RMIServerSocketFactory
,
LocateRegistry.createRegistry(int, RMIClientSocketFactory, RMIServerSocketFactory)
public void afterPropertiesSet() throws RemoteException
afterPropertiesSet
in interface InitializingBean
RemoteException
protected 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 use
RemoteException
- if the registry couldn't be located or createdprotected void testRegistry(Registry registry) throws RemoteException
registry
- the RMI registry to test
RemoteException
- if thrown by registry methodsprotected Remote getObjectToExport()
protected Object invoke(RemoteInvocation invocation, Object targetObject) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException
invoke
in class RemoteInvocationBasedExporter
invocation
- the remote invocationtargetObject
- the target object to apply the invocation to
NoSuchMethodException
- if the method name could not be resolved
IllegalAccessException
- if the method could not be accessed
InvocationTargetException
- if the method invocation resulted in an exceptionRemoteInvocationExecutor.invoke(org.springframework.remoting.support.RemoteInvocation, java.lang.Object)
public void destroy() throws RemoteException, NotBoundException
destroy
in interface DisposableBean
RemoteException
NotBoundException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |