com.rmiproxy.jndi.rmiproxy.registry
Class RegistryContext

java.lang.Object
  |
  +--com.rmiproxy.jndi.AbstractContext
        |
        +--com.rmiproxy.jndi.rmiproxy.registry.RegistryContext

All Implemented Interfaces:

javax.naming.Context, javax.naming.Referenceable

public class RegistryContext

extends AbstractContext

implements javax.naming.Context, javax.naming.Referenceable

A RegistryContext is a context representing a remote RMI registry.

Field Summary

static java.lang.String

SECURITY_MGR

Fields inherited from class com.rmiproxy.jndi.AbstractContext

environment

Fields inherited from interface javax.naming.Context

APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES

Constructor Summary

RegistryContext(java.lang.String host, int port, java.util.Hashtable env)
Returns a context for the registry at a given host and port.

Method Summary

java.lang.Object	addToEnvironment(java.lang.String propName, java.lang.Object propVal) Adds a new environment property to the environment of this context.
void	bind(javax.naming.Name name, java.lang.Object obj) If the object to be bound is both Remote and Referenceable, binds the object itself, not its Reference.
javax.naming.Name	composeName(javax.naming.Name name, javax.naming.Name prefix) Composes the name of this context with a name relative to this context.
javax.naming.Context	createSubcontext(javax.naming.Name name) Creates and binds a new context.
void	destroySubcontext(javax.naming.Name name) Destroys the named context and removes it from the namespace.
java.lang.String	getNameInNamespace() Retrieves the full name of this context within its own namespace.
javax.naming.NameParser	getNameParser(javax.naming.Name name) Retrieves the parser associated with the named context.
javax.naming.Reference	getReference() Returns an RMI registry reference for this context.
javax.naming.NamingEnumeration	list(javax.naming.Name name) Enumerates the names bound in the named context, along with the class names of objects bound to them.
javax.naming.NamingEnumeration	listBindings(javax.naming.Name name) Enumerates the names bound in the named context, along with the objects bound to them.
java.lang.Object	lookup(javax.naming.Name name) Retrieves the named object.
java.lang.Object	lookupLink(javax.naming.Name name) Retrieves the named object, following links except for the terminal atomic component of the name.
protected javax.naming.Name[]	parseComponents(javax.naming.Name name) Parse name components.
void	rebind(javax.naming.Name name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding.
void	rename(javax.naming.Name oldName, javax.naming.Name newName) Rename is implemented by this sequence of operations: lookup, bind, unbind.
void	unbind(javax.naming.Name name) Unbinds the named object.
static javax.naming.NamingException	wrapRemoteException(java.rmi.RemoteException re) Wrap a RemoteException inside a NamingException.

Methods inherited from class com.rmiproxy.jndi.AbstractContext

bind, close, composeName, createSubcontext, destroySubcontext, finalize, getEnvironment, getNameParser, list, listBindings, lookup, lookupLink, rebind, removeFromEnvironment, rename, unbind

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.naming.Context

bind, close, composeName, createSubcontext, destroySubcontext, getEnvironment, getNameParser, list, listBindings, lookup, lookupLink, rebind, removeFromEnvironment, rename, unbind

Field Detail

SECURITY_MGR

public static final java.lang.String SECURITY_MGR

Constructor Detail

RegistryContext

public RegistryContext(java.lang.String host,
                       int port,
                       java.util.Hashtable env)
                throws javax.naming.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.

Method Detail

lookup

public java.lang.Object lookup(javax.naming.Name name)
                        throws javax.naming.NamingException

Description copied from class: AbstractContext

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).

Specified by:

lookup in interface javax.naming.Context

Overrides:

lookup in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the object to look up

Returns:

the object bound to name

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.lookup(String), AbstractContext.lookupLink(Name)

bind

public void bind(javax.naming.Name name,
                 java.lang.Object obj)
          throws javax.naming.NamingException

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

Specified by:

bind in interface javax.naming.Context

Overrides:

bind in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

NameAlreadyBoundException - if name is already bound

javax.naming.directory.InvalidAttributesException - if object did not supply all mandatory attributes

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.bind(String, Object), AbstractContext.rebind(Name, Object), javax.naming.directory.DirContext#bind(Name, Object, javax.naming.directory.Attributes)

rebind

public void rebind(javax.naming.Name name,
                   java.lang.Object obj)
            throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

rebind in interface javax.naming.Context

Overrides:

rebind in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

javax.naming.directory.InvalidAttributesException - if object did not supply all mandatory attributes

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.rebind(String, Object), AbstractContext.bind(Name, Object), javax.naming.directory.DirContext#rebind(Name, Object, javax.naming.directory.Attributes), javax.naming.directory.DirContext

unbind

public void unbind(javax.naming.Name name)
            throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

unbind in interface javax.naming.Context

Overrides:

unbind in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name to unbind; may not be empty

Throws:

NameNotFoundException - if an intermediate context does not exist

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.unbind(String)

rename

public void rename(javax.naming.Name oldName,
                   javax.naming.Name newName)
            throws javax.naming.NamingException

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

Specified by:

rename in interface javax.naming.Context

Overrides:

rename in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

oldName - the name of the existing binding; may not be empty

newName - the name of the new binding; may not be empty

Throws:

NameAlreadyBoundException - if newName is already bound

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.rename(String, String), AbstractContext.bind(Name, Object), AbstractContext.rebind(Name, Object)

list

public javax.naming.NamingEnumeration list(javax.naming.Name name)
                                    throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

list in interface javax.naming.Context

Overrides:

list in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the context to list

Returns:

an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.list(String), AbstractContext.listBindings(Name), NameClassPair

listBindings

public javax.naming.NamingEnumeration listBindings(javax.naming.Name name)
                                            throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

listBindings in interface javax.naming.Context

Overrides:

listBindings in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the context to list

Returns:

an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.listBindings(String), AbstractContext.list(Name), Binding

destroySubcontext

public void destroySubcontext(javax.naming.Name name)
                       throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

destroySubcontext in interface javax.naming.Context

Overrides:

destroySubcontext in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the context to be destroyed; may not be empty

Throws:

NameNotFoundException - if an intermediate context does not exist

NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type

ContextNotEmptyException - if the named context is not empty

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.destroySubcontext(String)

createSubcontext

public javax.naming.Context createSubcontext(javax.naming.Name name)
                                      throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

createSubcontext in interface javax.naming.Context

Overrides:

createSubcontext in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the context to create; may not be empty

Returns:

the newly created context

Throws:

NameAlreadyBoundException - if name is already bound

javax.naming.directory.InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.createSubcontext(String), javax.naming.directory.DirContext#createSubcontext

lookupLink

public java.lang.Object lookupLink(javax.naming.Name name)
                            throws javax.naming.NamingException

Description copied from class: AbstractContext

Retrieves the named object, following links except for the terminal atomic component of the name. If the object bound to name is not a link, returns the object itself.

Specified by:

lookupLink in interface javax.naming.Context

Overrides:

lookupLink in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the object to look up

Returns:

the object bound to name, not following the terminal link (if any).

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.lookupLink(String)

getNameParser

public javax.naming.NameParser getNameParser(javax.naming.Name name)
                                      throws javax.naming.NamingException

Description copied from class: AbstractContext

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).

Specified by:

getNameParser in interface javax.naming.Context

Overrides:

getNameParser in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - the name of the context from which to get the parser

Returns:

a name parser that can parse compound names into their atomic components

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.getNameParser(String), CompoundName

composeName

public javax.naming.Name composeName(javax.naming.Name name,
                                     javax.naming.Name prefix)
                              throws javax.naming.NamingException

Description copied from class: AbstractContext

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".

Specified by:

composeName in interface javax.naming.Context

Overrides:

composeName in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

name - a name relative to this context

prefix - the name of this context relative to one of its ancestors

Returns:

the composition of prefix and name

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.composeName(String, String)

addToEnvironment

public java.lang.Object addToEnvironment(java.lang.String propName,
                                         java.lang.Object propVal)
                                  throws javax.naming.NamingException

Description copied from class: AbstractContext

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.

Specified by:

addToEnvironment in interface javax.naming.Context

Overrides:

addToEnvironment in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Parameters:

propName - the name of the environment property to add; may not be null

propVal - the value of the property to add; may not be null

Returns:

the previous value of the property, or null if the property was not in the environment before

Throws:

javax.naming.NamingException - if a naming exception is encountered

See Also:

AbstractContext.getEnvironment(), AbstractContext.removeFromEnvironment(String)

getNameInNamespace

public java.lang.String getNameInNamespace()

Description copied from class: AbstractContext

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.

Specified by:

getNameInNamespace in interface javax.naming.Context

Overrides:

getNameInNamespace in class AbstractContext

Following copied from class: com.rmiproxy.jndi.AbstractContext

Returns:

this context's name in its own namespace; never null

Throws:

OperationNotSupportedException - if the naming system does not have the notion of a full name

javax.naming.NamingException - if a naming exception is encountered

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException

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.

Specified by:

getReference in interface javax.naming.Referenceable

See Also:

RegistryContextFactory

wrapRemoteException

public static javax.naming.NamingException wrapRemoteException(java.rmi.RemoteException re)

Wrap a RemoteException inside a NamingException.

parseComponents

protected javax.naming.Name[] parseComponents(javax.naming.Name name)
                                       throws javax.naming.NamingException

Parse name components.

Parameters:

name - Name to parse

Returns:

Name[] consisting of two elements, first of which is 'my' part of the name, second is the rest for the next naming service (nns). As per Lee & Seligman JNDI book pp. 371-2, 'strong separation' model.