org.rvpf.base.rmi

Class RegistryEntry

Object

RegistryEntry

public final class RegistryEntry
extends Object

Registry entry.

Notes

• An entry is local if the binding is not specified.
• A local entry is private if the local registry is private.
• The service name must be specified either explicitly, or by a path in the binding, or by a default name.
• When supplied, a default prefix will be inserted before the name unless one is already present.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryEntry.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	getLookupKey() Gets the lookup key.
String	getName() Gets the name.
String	getPath() Gets the path.
URI	getURI() Gets the URI.
boolean	isPrivate() Asks if this entry is private.
boolean	isRemote() Asks if remote.
Remote	lookup(String sessionMode, Logger logger) Performs a lookup of the registry entry.
static RegistryEntry.Builder	newBuilder() Returns a new builder.
static void	setRegistry(Registry registry, boolean registryIsPrivate) Sets the registry connection informations.
String	toString()

Methods inherited from class Object

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

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static RegistryEntry.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

setRegistry

public static void setRegistry(@Nonnull
                               Registry registry,
                               boolean registryIsPrivate)

Sets the registry connection informations.

Parameters:

registry - The registry.

registryIsPrivate - True if the registry is private.

getLookupKey

@Nonnull
 @CheckReturnValue
public String getLookupKey()

Gets the lookup key.

Returns:

The lookup key.

getName

@Nonnull
 @CheckReturnValue
public String getName()

Gets the name.

Returns:

The name.

getPath

@Nonnull
 @CheckReturnValue
public String getPath()

Gets the path.

Returns:

The path (always relative).

getURI

@Nonnull
 @CheckReturnValue
public URI getURI()

Gets the URI.

Returns:

The URI.

isPrivate

public boolean isPrivate()

Asks if this entry is private.

An entry is private if it does not specify a registry location and if the local registry is private.

Returns:

True if this entry is private.

isRemote

public boolean isRemote()

Asks if remote.

An entry is remote if the registry is not located on the local machine.

Returns:

True if remote.

lookup

@Nonnull
 @CheckReturnValue
public Remote lookup(@Nonnull
                                                   String sessionMode,
                                                   Logger logger)
                                            throws AccessException,
                                                   RemoteException,
                                                   NotBoundException

Performs a lookup of the registry entry.

Parameters:

sessionMode - The session mode name.

logger - The logger.

Returns:

The remote instance.

Throws:

NotBoundException - When the server name is not currently bound.

RemoteException - When the communication with the registry failed.

AccessException - When access is denied.

toString

public String toString()

Overrides:

toString in class Object