nl.tudelft.simulation.naming
Class RemoteContext

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              nl.tudelft.simulation.naming.RemoteContext

All Implemented Interfaces:

java.rmi.Remote, RemoteContextInterface, java.io.Serializable

public class RemoteContext

extends java.rmi.server.UnicastRemoteObject

implements RemoteContextInterface

(c) copyright 2003 Delft University of Technology , the Netherlands.
See for project information www.simulation.tudelft.nl
License of use: General Public License (GPL) , no warranty

Since:

1.4

Version:

1.1 Apr 7, 2004

Author:

Peter Jacobs

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface nl.tudelft.simulation.naming.RemoteContextInterface

WRAPPED_PREFIX

Constructor Summary

RemoteContext(javax.naming.event.EventContext eventContext)
constructs a new RemoteContext

Method Summary

void	addNamingListener(javax.naming.Name target, int scope, RemoteContextListenerInterface l) Adds a listener for receiving naming events fired when the object(s) identified by a target and scope changes.
void	addNamingListener(java.lang.String target, int scope, RemoteContextListenerInterface l) Adds a listener for receiving naming events fired when the object named by the string target name and scope changes.
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) Binds a name to an object.
void	bind(java.lang.String name, java.lang.Object obj) Binds a name to an object.
void	close() Closes this context.
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.
java.lang.String	composeName(java.lang.String name, java.lang.String prefix) Composes the name of this context with a name relative to this context.
RemoteContextInterface	createSubcontext(javax.naming.Name name) Creates and binds a new context.
RemoteContextInterface	createSubcontext(java.lang.String name) Creates and binds a new context.
void	destroySubcontext(javax.naming.Name name) Destroys the named context and removes it from the namespace.
void	destroySubcontext(java.lang.String name) Destroys the named context and removes it from the namespace.
java.util.Hashtable	getEnvironment() Retrieves the environment in effect for this context.
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.NameParser	getNameParser(java.lang.String name) Retrieves the parser associated with the named 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	list(java.lang.String 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.
javax.naming.NamingEnumeration	listBindings(java.lang.String 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	lookup(java.lang.String 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.
java.lang.Object	lookupLink(java.lang.String name) Retrieves the named object, following links except for the terminal atomic component of the name.
void	rebind(javax.naming.Name name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding.
void	rebind(java.lang.String name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding.
java.lang.Object	removeFromEnvironment(java.lang.String propName) Removes an environment property from the environment of this context.
void	removeNamingListener(RemoteContextListenerInterface l) Removes a listener from receiving naming events fired by this EventContext.
void	rename(javax.naming.Name oldName, javax.naming.Name newName) Binds a new name to the object bound to an old name, and unbinds the old name.
void	rename(java.lang.String oldName, java.lang.String newName) Binds a new name to the object bound to an old name, and unbinds the old name.
boolean	targetMustExist() Determines whether a listener can register interest in a target that does not exist.
void	unbind(javax.naming.Name name) Unbinds the named object.
void	unbind(java.lang.String name) Unbinds the named object.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteContext

public RemoteContext(javax.naming.event.EventContext eventContext)
              throws java.rmi.RemoteException

constructs a new RemoteContext

Parameters:

eventContext - the underlying context

Throws:

java.rmi.RemoteException - on network failure

Method Detail

addNamingListener

public void addNamingListener(javax.naming.Name target,
                              int scope,
                              RemoteContextListenerInterface l)
                       throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

Adds a listener for receiving naming events fired when the object(s) identified by a target and scope changes. The event source of those events is this context. See the class description for a discussion on event source and target. See the descriptions of the constants OBJECT_SCOPE, ONELEVEL_SCOPE, and SUBTREE_SCOPE to see how scope affects the registration.

target needs to name a context only when scope is ONELEVEL_SCOPE.target may name a non-context if scope is either OBJECT_SCOPE or SUBTREE_SCOPE. Using SUBTREE_SCOPE for a non-context might be useful, for example, if the caller does not know in advance whether target is a context and just wants to register interest in the (possibly degenerate subtree) rooted at target.

When the listener is notified of an event, the listener may in invoked in a thread other than the one in which addNamingListener() is executed. Care must be taken when multiple threads are accessing the same EventContext concurrently. See the package description for more information on threading issues.

Specified by:

addNamingListener in interface RemoteContextInterface

Parameters:

target - A nonnull name to be resolved relative to this context.

scope - One of OBJECT_SCOPE,ONELEVEL_SCOPE, or SUBTREE_SCOPE.

l - The nonnull listener.

Throws:

javax.naming.NamingException - If a problem was encountered while adding the listener.

See Also:

RemoteContextInterface.addNamingListener(javax.naming.Name, int, nl.tudelft.simulation.naming.listener.RemoteContextListenerInterface)

addNamingListener

public void addNamingListener(java.lang.String target,
                              int scope,
                              RemoteContextListenerInterface l)
                       throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

Adds a listener for receiving naming events fired when the object named by the string target name and scope changes. See the overload that accepts a Name for details.

Specified by:

addNamingListener in interface RemoteContextInterface

Parameters:

target - The nonnull string name of the object resolved relative to this context.

scope - One of OBJECT_SCOPE,ONELEVEL_SCOPE, or SUBTREE_SCOPE.

l - The nonnull listener.

Throws:

javax.naming.NamingException - If a problem was encountered while adding the listener.

See Also:

RemoteContextInterface.addNamingListener(java.lang.String, int, nl.tudelft.simulation.naming.listener.RemoteContextListenerInterface)

removeNamingListener

public void removeNamingListener(RemoteContextListenerInterface l)
                          throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

Removes a listener from receiving naming events fired by this EventContext. The listener may have registered more than once with this EventContext, perhaps with different target/scope arguments. After this method is invoked, the listener will no longer receive events with this EventContext instance as the event source (except for those events already in the process of being dispatched). If the listener was not, or is no longer, registered with this EventContext instance, this method does not do anything.

Specified by:

removeNamingListener in interface RemoteContextInterface

Parameters:

l - The nonnull listener.

Throws:

javax.naming.NamingException - If a problem was encountered while removing the listener.

See Also:

RemoteContextInterface.removeNamingListener(nl.tudelft.simulation.naming.listener.RemoteContextListenerInterface)

targetMustExist

public boolean targetMustExist()
                        throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

Determines whether a listener can register interest in a target that does not exist.

Specified by:

targetMustExist in interface RemoteContextInterface

Returns:

true if the target must exist; false if the target need not exist.

Throws:

javax.naming.NamingException - If the context's behavior in this regard cannot be determined.

See Also:

RemoteContextInterface.targetMustExist()

lookup

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.lookup(javax.naming.Name)

lookup

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

Description copied from interface: RemoteContextInterface

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

Specified by:

lookup in interface RemoteContextInterface

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:

RemoteContextInterface.lookup(java.lang.String)

bind

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

Description copied from interface: RemoteContextInterface

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

Specified by:

bind in interface RemoteContextInterface

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

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

See Also:

RemoteContextInterface.bind(javax.naming.Name, java.lang.Object)

bind

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

Description copied from interface: RemoteContextInterface

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

Specified by:

bind in interface RemoteContextInterface

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

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

See Also:

RemoteContextInterface.bind(java.lang.String, java.lang.Object)

rebind

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

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

See Also:

RemoteContextInterface.rebind(javax.naming.Name, java.lang.Object)

rebind

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

Description copied from interface: RemoteContextInterface

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

Specified by:

rebind in interface RemoteContextInterface

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

Throws:

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

See Also:

RemoteContextInterface.rebind(java.lang.String, java.lang.Object)

unbind

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

Parameters:

name - the name to unbind; may not be empty

Throws:

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

See Also:

RemoteContextInterface.unbind(javax.naming.Name)

unbind

public void unbind(java.lang.String name)
            throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

unbind in interface RemoteContextInterface

Parameters:

name - the name to unbind; may not be empty

Throws:

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

See Also:

RemoteContextInterface.unbind(java.lang.String)

rename

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

Description copied from interface: RemoteContextInterface

Binds a new name to the object bound to an old name, and unbinds the old name. Both names are relative to this context. Any attributes associated with the old name become associated with the new name. Intermediate contexts of the old name are not changed.

Specified by:

rename in interface RemoteContextInterface

Parameters:

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

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

Throws:

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

See Also:

RemoteContextInterface.rename(javax.naming.Name, javax.naming.Name)

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

rename in interface RemoteContextInterface

Parameters:

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

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

Throws:

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

See Also:

RemoteContextInterface.rename(java.lang.String, java.lang.String)

list

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.list(javax.naming.Name)

list

public javax.naming.NamingEnumeration list(java.lang.String name)
                                    throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

list in interface RemoteContextInterface

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:

RemoteContextInterface.list(java.lang.String)

listBindings

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.listBindings(javax.naming.Name)

listBindings

public javax.naming.NamingEnumeration listBindings(java.lang.String name)
                                            throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

listBindings in interface RemoteContextInterface

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:

RemoteContextInterface.listBindings(java.lang.String)

destroySubcontext

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

Parameters:

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

Throws:

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

See Also:

RemoteContextInterface.destroySubcontext(javax.naming.Name)

destroySubcontext

public void destroySubcontext(java.lang.String name)
                       throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

destroySubcontext in interface RemoteContextInterface

Parameters:

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

Throws:

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

See Also:

RemoteContextInterface.destroySubcontext(java.lang.String)

createSubcontext

public RemoteContextInterface createSubcontext(javax.naming.Name name)
                                        throws javax.naming.NamingException,
                                               java.rmi.RemoteException

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

Parameters:

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

Returns:

the newly created context

Throws:

java.rmi.RemoteException - on network exception

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

See Also:

RemoteContextInterface.createSubcontext(javax.naming.Name)

createSubcontext

public RemoteContextInterface createSubcontext(java.lang.String name)
                                        throws javax.naming.NamingException,
                                               java.rmi.RemoteException

Description copied from interface: RemoteContextInterface

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

Specified by:

createSubcontext in interface RemoteContextInterface

Parameters:

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

Returns:

the newly created context

Throws:

java.rmi.RemoteException - on network exception

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

See Also:

RemoteContextInterface.createSubcontext(java.lang.String)

lookupLink

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.lookupLink(javax.naming.Name)

lookupLink

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

Description copied from interface: RemoteContextInterface

Retrieves the named object, following links except for the terminal atomic component of the name. See RemoteContextInterface.lookupLink(Name)for details.

Specified by:

lookupLink in interface RemoteContextInterface

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:

RemoteContextInterface.lookupLink(java.lang.String)

getNameParser

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.getNameParser(javax.naming.Name)

getNameParser

public javax.naming.NameParser getNameParser(java.lang.String name)
                                      throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

getNameParser in interface RemoteContextInterface

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:

RemoteContextInterface.getNameParser(java.lang.String)

composeName

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.composeName(javax.naming.Name, javax.naming.Name)

composeName

public java.lang.String composeName(java.lang.String name,
                                    java.lang.String prefix)
                             throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

composeName in interface RemoteContextInterface

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:

RemoteContextInterface.composeName(java.lang.String, java.lang.String)

addToEnvironment

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

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

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:

RemoteContextInterface.addToEnvironment(java.lang.String, java.lang.Object)

removeFromEnvironment

public java.lang.Object removeFromEnvironment(java.lang.String propName)
                                       throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

removeFromEnvironment in interface RemoteContextInterface

Parameters:

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

Returns:

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

Throws:

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

See Also:

RemoteContextInterface.removeFromEnvironment(java.lang.String)

getEnvironment

public java.util.Hashtable getEnvironment()
                                   throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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

Specified by:

getEnvironment in interface RemoteContextInterface

Returns:

the environment of this context; never null

Throws:

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

See Also:

RemoteContextInterface.getEnvironment()

close

public void close()
           throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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.

Specified by:

close in interface RemoteContextInterface

Throws:

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

See Also:

RemoteContextInterface.close()

getNameInNamespace

public java.lang.String getNameInNamespace()
                                    throws javax.naming.NamingException

Description copied from interface: RemoteContextInterface

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 RemoteContextInterface

Returns:

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

Throws:

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

See Also:

RemoteContextInterface.getNameInNamespace()