Top Description Inners Fields Constructors Methods
org.mortbay.naming.local

public Class localContextRoot

extends Object
implements Context
Class Inheritance
All Implemented Interfaces
javax.naming.Context
Imports
java.util.Hashtable, .Properties, javax.naming.CompoundName, .Context, .Name, .NameParser, .NamingEnumeration, .NamingException, org.mortbay.naming.NamingContext

localContext
Author
janb
Version
$Revision: 1327 $ $Date: 2006-11-27 12:40:14 -0600 (Mon, 27 Nov 2006) $

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class

Field Summary

Modifier and TypeField and Description
private final Hashtable<K, V>
private static final NamingContext

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
addToEnvironment(String
the name of the environment property to add; may not be null
propName
,
Object
the value of the property to add; may not be null
propVal
)

Implements javax.naming.Context.addToEnvironment.

Adds a new environment property to the environment of this context.
public void
bind(String
the name to bind; may not be empty
name
,
Object
the object to bind; possibly null
obj
)

Implements javax.naming.Context.bind.

Binds a name to an object.
public void
bind(Name
the name to bind; may not be empty
name
,
Object
the object to bind; possibly null
obj
)

Implements javax.naming.Context.bind.

Binds a name to an object.
public void
close()

Implements javax.naming.Context.close.

Closes this context.
public String
composeName(String
a name relative to this context
name
,
String
the name of this context relative to one of its ancestors
prefix
)

Implements javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context.
public Name
composeName(Name
a name relative to this context
name
,
Name
the name of this context relative to one of its ancestors
prefix
)

Implements javax.naming.Context.composeName.

Composes the name of this context with a name relative to this context.
public Context
createSubcontext(String
the name of the context to create; may not be empty
name
)

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.
public Context
createSubcontext(Name
the name of the context to create; may not be empty
name
)

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.
public void
destroySubcontext(String
the name of the context to be destroyed; may not be empty
name
)

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.
public void
destroySubcontext(Name
the name of the context to be destroyed; may not be empty
name
)

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.
public Hashtable<K, V>
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(String
the name of the context from which to get the parser
name
)

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.
public NameParser
getNameParser(Name
the name of the context from which to get the parser
name
)

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.
protected String
protected Name
public NamingEnumeration<T>
list(String
the name of the context to list
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<T>
list(Name
the name of the context to list
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<T>
listBindings(String
the name of the context to list
name
)

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.
public NamingEnumeration<T>
listBindings(Name
the name of the context to list
name
)

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.
public Object
lookup(String
the name of the object to look up
name
)

Implements javax.naming.Context.lookup.

Retrieves the named object.
public Object
lookup(Name
the name of the object to look up
name
)

Implements javax.naming.Context.lookup.

Retrieves the named object.
public void
rebind(String
the name to bind; may not be empty
name
,
Object
the object to bind; possibly null
obj
)

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.
public void
rebind(Name
the name to bind; may not be empty
name
,
Object
the object to bind; possibly null
obj
)

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.
public Object
removeFromEnvironment(String
the name of the environment property to remove; may not be null
propName
)

Implements javax.naming.Context.removeFromEnvironment.

Removes an environment property from the environment of this context.
public void
rename(String
the name of the existing binding; may not be empty
oldName
,
String
the name of the new binding; may not be empty
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
rename(Name
the name of the existing binding; may not be empty
oldName
,
Name
the name of the new binding; may not be empty
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(String
the name to unbind; may not be empty
name
)

Implements javax.naming.Context.unbind.

Unbinds the named object.
public void
unbind(Name
the name to unbind; may not be empty
name
)

Implements javax.naming.Context.unbind.

Unbinds the named object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_envback to summary
private final Hashtable<K, V> _env
_rootback to summary
private static final NamingContext _root

Constructor Detail

localContextRootback to summary
public localContextRoot(Hashtable<K, V> env)

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.

Parameters
propName:String

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

propVal:Object

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

Returns:Object

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#addToEnvironment(java.lang.String, java.lang.Object)
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.

Parameters
name:String

the name to bind; may not be empty

obj:Object

the object to bind; possibly null

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#bind(java.lang.String, java.lang.Object)
bindback to summary
public void bind(Name name, Object obj) throws NamingException

Implements javax.naming.Context.bind.

Doc from javax.naming.Context.bind.

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.

Parameters
name:Name

the name to bind; may not be empty

obj:Object

the object to bind; possibly null

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#bind(javax.naming.Name, java.lang.Object)
closeback to summary
public void close() throws NamingException

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.

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#close()
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.

Parameters
name:String

a name relative to this context

prefix:String

the name of this context relative to one of its ancestors

Returns:String

the composition of prefix and name

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#composeName(java.lang.String, java.lang.String)
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".
Parameters
name:Name

a name relative to this context

prefix:Name

the name of this context relative to one of its ancestors

Returns:Name

the composition of prefix and name

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#composeName(javax.naming.Name, javax.naming.Name)
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.

Parameters
name:String

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

Returns:Context

the newly created context

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#createSubcontext(java.lang.String)
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.

Parameters
name:Name

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

Returns:Context

the newly created context

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#createSubcontext(javax.naming.Name)
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.

Parameters
name:String

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#destroySubcontext(java.lang.String)
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.

Parameters
name:Name

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#destroySubcontext(javax.naming.Name)
getEnvironmentback to summary
public Hashtable<K, V> 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().

Returns:Hashtable<K, V>

the environment of this context; never null

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#getEnvironment()
getNameInNamespaceback to summary
public String getNameInNamespace() throws NamingException

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.

Returns:String

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#getNameInNamespace()
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.

Parameters
name:String

the name of the context from which to get the parser

Returns:NameParser

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#getNameParser(java.lang.String)
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).

Parameters
name:Name

the name of the context from which to get the parser

Returns:NameParser

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#getNameParser(javax.naming.Name)
getSuffixback to summary
protected String getSuffix(String url) throws NamingException
getSuffixback to summary
protected Name getSuffix(Name name) throws NamingException
listback to summary
public NamingEnumeration<T> 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.

Parameters
name:String

the name of the context to list

Returns:NamingEnumeration<T>

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#list(java.lang.String)
listback to summary
public NamingEnumeration<T> 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.

Parameters
name:Name

the name of the context to list

Returns:NamingEnumeration<T>

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#list(javax.naming.Name)
listBindingsback to summary
public NamingEnumeration<T> 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.

Parameters
name:String

the name of the context to list

Returns:NamingEnumeration<T>

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#listBindings(java.lang.String)
listBindingsback to summary
public NamingEnumeration<T> 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.

Parameters
name:Name

the name of the context to list

Returns:NamingEnumeration<T>

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#listBindings(javax.naming.Name)
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.

Parameters
name:String

the name of the object to look up

Returns:Object

the object bound to name

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#lookup(java.lang.String)
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).

Parameters
name:Name

the name of the object to look up

Returns:Object

the object bound to name

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#lookup(javax.naming.Name)
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.

Parameters
name:String

the name to bind; may not be empty

obj:Object

the object to bind; possibly null

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#rebind(java.lang.String, java.lang.Object)
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.

Parameters
name:Name

the name to bind; may not be empty

obj:Object

the object to bind; possibly null

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#rebind(javax.naming.Name, java.lang.Object)
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.

Parameters
propName:String

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

Returns:Object

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

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#removeFromEnvironment(java.lang.String)
renameback to summary
public void rename(String oldName, 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.

Parameters
oldName:String

the name of the existing binding; may not be empty

newName:String

the name of the new binding; may not be empty

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#rename(java.lang.String, java.lang.String)
renameback to summary
public void rename(Name oldName, Name 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. 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.

Parameters
oldName:Name

the name of the existing binding; may not be empty

newName:Name

the name of the new binding; may not be empty

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#rename(javax.naming.Name, javax.naming.Name)
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.

Parameters
name:String

the name to unbind; may not be empty

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#unbind(java.lang.String)
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.

Parameters
name:Name

the name to unbind; may not be empty

Exceptions
NamingException:
if a naming exception is encountered
See Also
javax.naming.Context#unbind(javax.naming.Name)
org.mortbay.naming.local back to summary

pack-priv Class localContextRoot.LocalNameParser

extends Object
implements NameParser
Class Inheritance
All Implemented Interfaces
javax.naming.NameParser

Field Summary

Modifier and TypeField and Description
pack-priv Properties

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public Name
parse(String
The non-null string name to parse.
name
)

Implements javax.naming.NameParser.parse.

Parses a name into its components.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

syntaxback to summary
pack-priv Properties syntax

Constructor Detail

LocalNameParserback to summary
pack-priv LocalNameParser()

Method Detail

parseback to summary
public Name parse(String name) throws NamingException

Implements javax.naming.NameParser.parse.

Doc from javax.naming.NameParser.parse.

Parses a name into its components.

Parameters
name:String

The non-null string name to parse.

Returns:Name

A non-null parsed form of the name using the naming convention of this parser.

Exceptions
NamingException:
If a naming exception was encountered.