org.rvpf.service.rmi

Class ServiceRegistry

Object

ServiceRegistry

public final class ServiceRegistry
extends Object

Service registry.

Notes

• A private registry (specified by the 'private' property) does not use the RMI infrastructure. Instead, the registered servers are called directly. Since the serialization/deserialization process is bypassed, the servers must take appropriate precautions when handling objects seen by the clients. The isPrivate() method may be used by the servers to detect that situation.
• A stealth registry (when the registry port is not specified) uses an allocated port.
• A protected registry (specified by the 'protected' property) does not accept registrations from outside its JVM. A private or stealth registry is implicitly protected.
• A registry is local when it is located in the current JVM.
• A registry is shared (allowed by the 'shared' property) when it has been created in an other JVM on the local system.

Method Summary

Modifier and Type	Method and Description
static ServiceRegistry	getInstance() Gets the singleton instance.
static Optional<InetAddress>	getRegistryAddress() Gets the registry address.
static int	getRegistryPort() Gets the registry port.
Registry	getRMIRegistry() Gets the RMI registry.
static boolean	isLocal() Asks if the registry is local (located in the current JVM).
static boolean	isPrivate() Asks if the registry is private.
static boolean	isProtected() Asks if the registry is protected.
boolean	isRegistered(String name) Asks if a name is registered.
static boolean	isShared() Asks if the registry is shared.
static boolean	isStealth() Asks if the registry is stealth.
static void	purge() Purges the registry entries.
boolean	register(SessionFactory sessionFactory, String name, Logger logger) Registers.
String	registerServer(SessionFactory server, URI serverURI, Logger logger) Registers a RMI server.
static boolean	setUp(KeyedGroups configProperties) Sets up the singleton instance.
void	unregister(String name, Logger logger) Unregisters.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

@Nonnull
 @CheckReturnValue
public static ServiceRegistry getInstance()

Gets the singleton instance.

Returns:

The singleton instance.

getRegistryAddress

@Nonnull
 @CheckReturnValue
public static Optional<InetAddress> getRegistryAddress()

Gets the registry address.

Returns:

The registry address (empty if unknown).

getRegistryPort

@CheckReturnValue
public static int getRegistryPort()

Gets the registry port.

Returns:

The registry port (-1 if unknown).

isLocal

@CheckReturnValue
public static boolean isLocal()

Asks if the registry is local (located in the current JVM).

Returns:

True if the registry is local.

isPrivate

@CheckReturnValue
public static boolean isPrivate()

Asks if the registry is private.

Returns:

True if the registry is private.

isProtected

@CheckReturnValue
public static boolean isProtected()

Asks if the registry is protected.

Returns:

True if the registry is protected.

isShared

@CheckReturnValue
public static boolean isShared()

Asks if the registry is shared.

Returns:

True if the registry is shared.

isStealth

@CheckReturnValue
public static boolean isStealth()

Asks if the registry is stealth.

Returns:

True if the registry is stealth.

purge

public static void purge()

Purges the registry entries.

setUp

@CheckReturnValue
public static boolean setUp(@Nonnull
                                               KeyedGroups configProperties)

Sets up the singleton instance.

Parameters:

configProperties - The configuration properties.

Returns:

A true value on success.

getRMIRegistry

@Nonnull
 @CheckReturnValue
public Registry getRMIRegistry()

Gets the RMI registry.

Returns:

The RMI registry.

isRegistered

@CheckReturnValue
public boolean isRegistered(String name)
                                        throws RemoteException

Asks if a name is registered.

Parameters:

name - The name.

Returns:

A true value if registered.

Throws:

RemoteException - When communication with the registry fails.

register

@CheckReturnValue
public boolean register(@Nonnull
                                           SessionFactory sessionFactory,
                                           @Nonnull
                                           String name,
                                           @Nonnull
                                           Logger logger)

Registers.

Parameters:

sessionFactory - The session factory.

name - The name.

logger - A logger.

Returns:

A true value on success.

registerServer

@Nullable
 @CheckReturnValue
public String registerServer(@Nonnull
                                                            SessionFactory server,
                                                            @Nonnull
                                                            URI serverURI,
                                                            @Nonnull
                                                            Logger logger)

Registers a RMI server.

Parameters:

server - The server object.

serverURI - The server URI.

logger - A logger.

Returns:

The server name (null on failure).

unregister

public void unregister(@Nonnull
                       String name,
                       @Nonnull
                       Logger logger)

Unregisters.

Parameters:

name - The name.

logger - A logger.