APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.jndi.rmi.registry

public Class RegistryContext

Additional top-level classes in compilation unit: AtomicNameParser, NameClassPairEnumeration, BindingEnumeration.

extends Object
implements Context, Referenceable
Class Inheritance
All Implemented Interfaces
javax.naming.Referenceable, javax.naming.Context
Imports
com.sun.naming.internal.NamingManagerHelper, .ObjectFactoriesFilter, java.util.Hashtable, .Properties, java.rmi.*, java.rmi.server.*, java.rmi.registry.Registry, .LocateRegistry, javax.naming.*, javax.naming.spi.NamingManager

A RegistryContext is a context representing a remote RMI registry.
Author
Scott Seligman

Field Summary

Modifier and TypeField and Description
private Hashtable<String, Object>
private String
private static final NameParser
private int
pack-priv Reference
private Registry
private static final String

Constructor Summary

AccessConstructor and Description
public
RegistryContext(String host, int port, Hashtable<?, ?> env)

Returns a context for the registry at a given host and port.

pack-priv
RegistryContext(RegistryContext ctx)

Returns a clone of a registry context.

Method Summary

Modifier and TypeMethod and Description
public Object
addToEnvironment(String propName, Object propVal)

Implements javax.naming.Context.addToEnvironment.

Adds a new environment property to the environment of this context.

public void
bind(Name name, Object obj)

Implements javax.naming.Context.bind.

If the object to be bound is both Remote and Referenceable, binds the object itself, not its Reference.

public void
bind(String name, Object obj)

Implements javax.naming.Context.bind.

Binds a name to an object.

public void
close()

Implements javax.naming.Context.close.

Closes this context.

public Name
composeName(Name name, Name prefix)

Implements javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context.

public String
composeName(String name, String prefix)

Implements javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context.

public Context
createSubcontext(Name name)

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.

public Context
createSubcontext(String name)

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.

private Object
decodeObject(Remote r, Name
The object's name relative to this context.
name
)

Decodes an object that has been retrieved from the registry.

public void
destroySubcontext(Name name)

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.

public void
destroySubcontext(String name)

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.

private Remote
encodeObject(Object obj, Name
The object's name relative to this context.
name
)

Encodes an object prior to binding it in the registry.

public Hashtable<String, Object>
getEnvironment()

Implements javax.naming.Context.getEnvironment.

Retrieves the environment in effect for this context.

public String
getNameInNamespace()

Implements javax.naming.Context.getNameInNamespace.

Retrieves the full name of this context within its own namespace.

public NameParser
getNameParser(Name name)

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.

public NameParser
getNameParser(String name)

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.

public Reference
getReference()

Implements javax.naming.Referenceable.getReference.

Returns an RMI registry reference for this context.

private static Registry
getRegistry(String host, int port, RMIClientSocketFactory socketFactory)

Returns the registry at a given host, port and socket factory.

public NamingEnumeration<NameClassPair>
list(Name name)

Implements javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them.

public NamingEnumeration<NameClassPair>
list(String name)

Implements javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them.

public NamingEnumeration<Binding>
listBindings(Name name)

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.

public NamingEnumeration<Binding>
listBindings(String name)

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.

public Object
lookup(Name name)

Implements javax.naming.Context.lookup.

Retrieves the named object.

public Object
lookup(String name)

Implements javax.naming.Context.lookup.

Retrieves the named object.

public void
rebind(Name name, Object obj)

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.

public void
rebind(String name, Object obj)

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.

public Object
removeFromEnvironment(String propName)

Implements javax.naming.Context.removeFromEnvironment.

Removes an environment property from the environment of this context.

public void
rename(Name oldName, Name newName)

Implements javax.naming.Context.rename.

Rename is implemented by this sequence of operations: lookup, bind, unbind.

public void
rename(String name, String newName)

Implements javax.naming.Context.rename.

Binds a new name to the object bound to an old name, and unbinds the old name.

public void
unbind(Name name)

Implements javax.naming.Context.unbind.

Unbinds the named object.

public void
unbind(String name)

Implements javax.naming.Context.unbind.

Unbinds the named object.

public static NamingException
wrapRemoteException(RemoteException re)

Wrap a RemoteException inside a NamingException.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

environmentback to summary
private Hashtable<String, Object> environment
hostback to summary
private String host
nameParserback to summary
private static final NameParser nameParser
portback to summary
private int port
referenceback to summary
pack-priv Reference reference
registryback to summary
private Registry registry
SOCKET_FACTORYback to summary
private static final String SOCKET_FACTORY

Constructor Detail

RegistryContextback to summary
public RegistryContext(String host, int port, Hashtable<?, ?> env) throws NamingException

Returns a context for the registry at a given host and port. If "host" is null, uses default host. If "port" is non-positive, uses default port. Cloning of "env" is handled by caller; see comments within RegistryContextFactory.getObjectInstance(), for example.

Annotations
@SuppressWarnings:unchecked
RegistryContextback to summary
pack-priv RegistryContext(RegistryContext ctx)

Returns a clone of a registry context. The context's private state is independent of the original's (so closing one context, for example, won't close the other).

Annotations
@SuppressWarnings:unchecked

Method Detail

addToEnvironmentback to summary
public Object addToEnvironment(String propName, Object propVal) throws NamingException

Implements javax.naming.Context.addToEnvironment.

Doc from javax.naming.Context.addToEnvironment.

Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten. See class description for more details on environment properties.

Exceptions
NamingException:
if a naming exception is encountered
bindback to summary
public void bind(Name name, Object obj) throws NamingException

Implements javax.naming.Context.bind.

If the object to be bound is both Remote and Referenceable, binds the object itself, not its Reference.

Exceptions
NamingException:

Doc from javax.naming.Context.bind.

if a naming exception is encountered

bindback to summary
public void bind(String name, Object obj) throws NamingException

Implements javax.naming.Context.bind.

Doc from javax.naming.Context.bind.

Binds a name to an object. See bind(Name, Object) for details.

Exceptions
NamingException:
if a naming exception is encountered
closeback to summary
public void close()

Implements javax.naming.Context.close.

Doc from javax.naming.Context.close.

Closes this context. This method releases this context's resources immediately, instead of waiting for them to be released automatically by the garbage collector.

This method is idempotent: invoking it on a context that has already been closed has no effect. Invoking any other method on a closed context is not allowed, and results in undefined behaviour.

composeNameback to summary
public Name composeName(Name name, Name prefix) throws NamingException

Implements javax.naming.Context.composeName.

Doc from javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context. Given a name (name) relative to this context, and the name (prefix) of this context relative to one of its ancestors, this method returns the composition of the two names using the syntax appropriate for the naming system(s) involved. That is, if name names an object relative to this context, the result is the name of the same object, but relative to the ancestor context. None of the names may be null.

For example, if this context is named "wiz.com" relative to the initial context, then

 composeName("east", "wiz.com")  
might return "east.wiz.com". If instead this context is named "org/research", then
 composeName("user/jane", "org/research")        
might return "org/research/user/jane" while
 composeName("user/jane", "research")    
returns "research/user/jane".
Exceptions
NamingException:
if a naming exception is encountered
composeNameback to summary
public String composeName(String name, String prefix) throws NamingException

Implements javax.naming.Context.composeName.

Doc from javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context. See composeName(Name, Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
createSubcontextback to summary
public Context createSubcontext(Name name) throws NamingException

Implements javax.naming.Context.createSubcontext.

Doc from javax.naming.Context.createSubcontext.

Creates and binds a new context. Creates a new context with the given name and binds it in the target context (that named by all but terminal atomic component of the name). All intermediate contexts and the target context must already exist.

Exceptions
NamingException:
if a naming exception is encountered
createSubcontextback to summary
public Context createSubcontext(String name) throws NamingException

Implements javax.naming.Context.createSubcontext.

Doc from javax.naming.Context.createSubcontext.

Creates and binds a new context. See createSubcontext(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
decodeObjectback to summary
private Object decodeObject(Remote r, Name name) throws NamingException

Decodes an object that has been retrieved from the registry. First, if the object is a RemoteReference, the Reference is unwrapped. Then, NamingManager.getObjectInstance() is invoked.

Parameters
name:Name

The object's name relative to this context.

destroySubcontextback to summary
public void destroySubcontext(Name name) throws NamingException

Implements javax.naming.Context.destroySubcontext.

Doc from javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace. Any attributes associated with the name are also removed. Intermediate contexts are not destroyed.

This method is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist.

In a federated naming system, a context from one naming system may be bound to a name in another. One can subsequently look up and perform operations on the foreign context using a composite name. However, an attempt destroy the context using this composite name will fail with NotContextException, because the foreign context is not a "subcontext" of the context in which it is bound. Instead, use unbind() to remove the binding of the foreign context. Destroying the foreign context requires that the destroySubcontext() be performed on a context from the foreign context's "native" naming system.

Exceptions
NamingException:
if a naming exception is encountered
destroySubcontextback to summary
public void destroySubcontext(String name) throws NamingException

Implements javax.naming.Context.destroySubcontext.

Doc from javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace. See destroySubcontext(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
encodeObjectback to summary
private Remote encodeObject(Object obj, Name name) throws NamingException, RemoteException

Encodes an object prior to binding it in the registry. First, NamingManager.getStateToBind() is invoked. If the resulting object is Remote, it is returned. If it is a Reference or Referenceable, the reference is wrapped in a Remote object. Otherwise, an exception is thrown.

Parameters
name:Name

The object's name relative to this context.

getEnvironmentback to summary
public Hashtable<String, Object> getEnvironment() throws NamingException

Implements javax.naming.Context.getEnvironment.

Doc from javax.naming.Context.getEnvironment.

Retrieves the environment in effect for this context. See class description for more details on environment properties.

The caller should not make any changes to the object returned: their effect on the context is undefined. The environment of this context may be changed using addToEnvironment() and removeFromEnvironment().

Annotations
@SuppressWarnings:unchecked
Exceptions
NamingException:
if a naming exception is encountered
getNameInNamespaceback to summary
public String getNameInNamespace()

Implements javax.naming.Context.getNameInNamespace.

Doc from javax.naming.Context.getNameInNamespace.

Retrieves the full name of this context within its own namespace.

Many naming services have a notion of a "full name" for objects in their respective namespaces. For example, an LDAP entry has a distinguished name, and a DNS record has a fully qualified name. This method allows the client application to retrieve this name. The string returned by this method is not a JNDI composite name and should not be passed directly to context methods. In naming systems for which the notion of full name does not make sense, OperationNotSupportedException is thrown.

getNameParserback to summary
public NameParser getNameParser(Name name) throws NamingException

Implements javax.naming.Context.getNameParser.

Doc from javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context. In a federation of namespaces, different naming systems will parse names differently. This method allows an application to get a parser for parsing names into their atomic components using the naming convention of a particular naming system. Within any single naming system, NameParser objects returned by this method must be equal (using the equals() test).

Exceptions
NamingException:
if a naming exception is encountered
getNameParserback to summary
public NameParser getNameParser(String name) throws NamingException

Implements javax.naming.Context.getNameParser.

Doc from javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context. See getNameParser(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
getReferenceback to summary
public Reference getReference() throws NamingException

Implements javax.naming.Referenceable.getReference.

Returns an RMI registry reference for this context.

If this context was created from a reference, that reference is returned. Otherwise, an exception is thrown if the registry's host is "localhost" or the default (null). Although this could possibly make for a valid reference, it's far more likely to be an easily made error.

Exceptions
NamingException:

Doc from javax.naming.Referenceable.getReference.

If a naming exception was encountered while retrieving the reference.

See Also
RegistryContextFactory
getRegistryback to summary
private static Registry getRegistry(String host, int port, RMIClientSocketFactory socketFactory) throws NamingException

Returns the registry at a given host, port and socket factory. If "host" is null, uses default host. If "port" is non-positive, uses default port. If "socketFactory" is null, uses the default socket.

listback to summary
public NamingEnumeration<NameClassPair> list(Name name) throws NamingException

Implements javax.naming.Context.list.

Doc from javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them. The contents of any subcontexts are not included.

If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.

Exceptions
NamingException:
if a naming exception is encountered
listback to summary
public NamingEnumeration<NameClassPair> list(String name) throws NamingException

Implements javax.naming.Context.list.

Doc from javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them. See list(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
listBindingsback to summary
public NamingEnumeration<Binding> listBindings(Name name) throws NamingException

Implements javax.naming.Context.listBindings.

Doc from javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them. The contents of any subcontexts are not included.

If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.

Exceptions
NamingException:
if a naming exception is encountered
listBindingsback to summary
public NamingEnumeration<Binding> listBindings(String name) throws NamingException

Implements javax.naming.Context.listBindings.

Doc from javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them. See listBindings(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
lookupback to summary
public Object lookup(Name name) throws NamingException

Implements javax.naming.Context.lookup.

Doc from javax.naming.Context.lookup.

Retrieves the named object. If name is empty, returns a new instance of this context (which represents the same naming context as this context, but its environment may be modified independently and it may be accessed concurrently).

Exceptions
NamingException:
if a naming exception is encountered
lookupback to summary
public Object lookup(String name) throws NamingException

Implements javax.naming.Context.lookup.

Doc from javax.naming.Context.lookup.

Retrieves the named object. See lookup(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
rebindback to summary
public void rebind(Name name, Object obj) throws NamingException

Implements javax.naming.Context.rebind.

Doc from javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.

If the object is a DirContext, any existing attributes associated with the name are replaced with those of the object. Otherwise, any existing attributes associated with the name remain unchanged.

Exceptions
NamingException:
if a naming exception is encountered
rebindback to summary
public void rebind(String name, Object obj) throws NamingException

Implements javax.naming.Context.rebind.

Doc from javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding. See rebind(Name, Object) for details.

Exceptions
NamingException:
if a naming exception is encountered
removeFromEnvironmentback to summary
public Object removeFromEnvironment(String propName) throws NamingException

Implements javax.naming.Context.removeFromEnvironment.

Doc from javax.naming.Context.removeFromEnvironment.

Removes an environment property from the environment of this context. See class description for more details on environment properties.

Exceptions
NamingException:
if a naming exception is encountered
renameback to summary
public void rename(Name oldName, Name newName) throws NamingException

Implements javax.naming.Context.rename.

Rename is implemented by this sequence of operations: lookup, bind, unbind. The sequence is not performed atomically.

Exceptions
NamingException:

Doc from javax.naming.Context.rename.

if a naming exception is encountered

renameback to summary
public void rename(String name, String newName) throws NamingException

Implements javax.naming.Context.rename.

Doc from javax.naming.Context.rename.

Binds a new name to the object bound to an old name, and unbinds the old name. See rename(Name, Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
unbindback to summary
public void unbind(Name name) throws NamingException

Implements javax.naming.Context.unbind.

Doc from javax.naming.Context.unbind.

Unbinds the named object. Removes the terminal atomic name in name from the target context--that named by all but the terminal atomic part of name.

This method is idempotent. It succeeds even if the terminal atomic name is not bound in the target context, but throws NameNotFoundException if any of the intermediate contexts do not exist.

Any attributes associated with the name are removed. Intermediate contexts are not changed.

Exceptions
NamingException:
if a naming exception is encountered
unbindback to summary
public void unbind(String name) throws NamingException

Implements javax.naming.Context.unbind.

Doc from javax.naming.Context.unbind.

Unbinds the named object. See unbind(Name) for details.

Exceptions
NamingException:
if a naming exception is encountered
wrapRemoteExceptionback to summary
public static NamingException wrapRemoteException(RemoteException re)

Wrap a RemoteException inside a NamingException.