RmiRegistryFactoryBean (spring-context 3.2.0.RELEASE API)

java.lang.Object
- org.springframework.remoting.rmi.RmiRegistryFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<Registry>, org.springframework.beans.factory.InitializingBean
```
public class RmiRegistryFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<Registry>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
```
FactoryBean that locates a Registry and exposes it for bean references. Can also create a local RMI registry on the fly if none exists already.
Can be used to set up and pass around the actual Registry object to applications objects that need to work with RMI. One example for such an object that needs to work with RMI is Spring's RmiServiceExporter, which either works with a passed-in Registry reference or falls back to the registry as specified by its local properties and defaults.
Also useful to enforce creation of a local RMI registry at a given port, for example for a JMX connector. If used in conjunction with ConnectorServerFactoryBean, it is recommended to mark the connector definition (ConnectorServerFactoryBean) as "depends-on" the registry definition (RmiRegistryFactoryBean), to guarantee starting up the registry first.
Note: The implementation of this class mirrors the corresponding logic in RmiServiceExporter, and also offers the same customization hooks. RmiServiceExporter implements its own registry lookup as a convenience: It is very common to simply rely on the registry defaults.

Since:

1.2.3

Author:

Juergen Hoeller

See Also:
RmiServiceExporter.setRegistry(java.rmi.registry.Registry), ConnectorServerFactoryBean, Registry, LocateRegistry

Field Summary

Fields
Modifier and Type Field and Description

protected Log logger

Fields
Modifier and Type	Field and Description
`protected Log`	`logger`

Constructor Summary

Constructors
Constructor and Description

RmiRegistryFactoryBean()

Constructors
Constructor and Description
`RmiRegistryFactoryBean()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`void`	`destroy()` Unexport the RMI registry on bean factory shutdown, provided that this bean actually created a registry.
`String`	`getHost()` Return the host of the registry for the exported RMI service.
`Registry`	`getObject()`
`Class<? extends Registry>`	`getObjectType()`
`int`	`getPort()` Return the port of the registry for the exported RMI service.
`protected Registry`	`getRegistry(int registryPort)` Locate or create the RMI registry.
`protected Registry`	`getRegistry(int registryPort, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory)` Locate or create the RMI registry.
`protected Registry`	`getRegistry(String registryHost, int registryPort, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory)` Locate or create the RMI registry.
`boolean`	`isSingleton()`
`void`	`setAlwaysCreate(boolean alwaysCreate)` 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 the RMI registry.
`void`	`setHost(String host)` Set the host of the registry for the exported RMI service, i.e.
`void`	`setPort(int port)` Set the port of the registry for the exported RMI service, i.e.
`void`	`setServerSocketFactory(RMIServerSocketFactory serverSocketFactory)` Set a custom RMI server socket factory to use for the RMI registry.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected final Log logger
```
- Constructor Detail
  - RmiRegistryFactoryBean
```
public RmiRegistryFactoryBean()
```
- Method Detail
  - setHost
```
public void setHost(String host)
```
    Set the host of the registry for the exported RMI service, i.e. rmi://HOST:port/name
    Default is localhost.
  - getHost
```
public String getHost()
```
    Return the host of the registry for the exported RMI service.
  - setPort
```
public void setPort(int port)
```
    Set the port of the registry for the exported RMI service, i.e. rmi://host:PORT/name
    Default is Registry.REGISTRY_PORT (1099).
  - getPort
```
public int getPort()
```
    Return the port of the registry for the exported RMI service.
  - setClientSocketFactory
```
public void setClientSocketFactory(RMIClientSocketFactory clientSocketFactory)
```
    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.
    
    See Also:
    setServerSocketFactory(java.rmi.server.RMIServerSocketFactory), RMIClientSocketFactory, RMIServerSocketFactory, LocateRegistry.getRegistry(String, int, java.rmi.server.RMIClientSocketFactory)
  - setServerSocketFactory
```
public void setServerSocketFactory(RMIServerSocketFactory serverSocketFactory)
```
    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.
    
    See Also:
    setClientSocketFactory(java.rmi.server.RMIClientSocketFactory), RMIClientSocketFactory, RMIServerSocketFactory, LocateRegistry.createRegistry(int, RMIClientSocketFactory, java.rmi.server.RMIServerSocketFactory)
  - setAlwaysCreate
```
public void setAlwaysCreate(boolean alwaysCreate)
```
    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.
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - getRegistry
```
protected Registry getRegistry(String registryHost,
                   int registryPort,
                   RMIClientSocketFactory clientSocketFactory,
                   RMIServerSocketFactory serverSocketFactory)
                        throws RemoteException
```
    Locate or create the RMI registry.
    
    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
  - getRegistry
```
protected Registry getRegistry(int registryPort,
                   RMIClientSocketFactory clientSocketFactory,
                   RMIServerSocketFactory serverSocketFactory)
                        throws RemoteException
```
    Locate or create the RMI registry.
    
    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
  - getRegistry
```
protected Registry getRegistry(int registryPort)
                        throws RemoteException
```
    Locate or create the RMI registry.
    
    Parameters:
    registryPort - the registry port to use
    
    Returns:
    the RMI registry
    
    Throws:
    
    RemoteException - if the registry couldn't be located or created
  - testRegistry
```
protected void testRegistry(Registry registry)
                     throws RemoteException
```
    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
    See Also:
    Registry.list()
  - getObject
```
public Registry getObject()
                   throws Exception
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<Registry>
    
    Throws:
    
    Exception
  - getObjectType
```
public Class<? extends Registry> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<Registry>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<Registry>
  - destroy
```
public void destroy()
             throws RemoteException
```
    Unexport the RMI registry on bean factory shutdown, provided that this bean actually created a registry.
    
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    RemoteException

Class RmiRegistryFactoryBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

RmiRegistryFactoryBean

Method Detail

setHost

getHost

setPort

getPort

setClientSocketFactory

setServerSocketFactory

setAlwaysCreate

afterPropertiesSet

getRegistry

getRegistry

getRegistry

testRegistry

getObject

getObjectType

isSingleton

destroy