org.apache.naming
public class SelectorContext extends Object implements Context
Version: $Revision: 795749 $ $Date: 2009-07-20 12:40:29 +0200 (Mon, 20 Jul 2009) $
Field Summary | |
---|---|
protected Hashtable | env
Environment. |
protected boolean | initialContext
Request for an initial context. |
static String | IC_PREFIX
Initial context prefix. |
static String | prefix
Namespace URL. |
static int | prefixLength
Namespace URL length. |
protected StringManager | sm
The string manager for this package. |
Constructor Summary | |
---|---|
SelectorContext(Hashtable env)
Builds a Catalina selector context using the given environment. | |
SelectorContext(Hashtable env, boolean initialContext)
Builds a Catalina selector context using the given environment. |
Method Summary | |
---|---|
Object | addToEnvironment(String propName, Object propVal)
Adds a new environment property to the environment of this context. |
void | bind(Name name, Object obj)
Binds a name to an object. |
void | bind(String name, Object obj)
Binds a name to an object.
|
void | close()
Closes this context. |
Name | composeName(Name name, Name prefix)
Composes the name of this context with a name relative to this context.
|
String | composeName(String name, String prefix)
Composes the name of this context with a name relative to this context.
|
Context | createSubcontext(Name name)
Creates and binds a new context. |
Context | createSubcontext(String name)
Creates and binds a new context.
|
void | destroySubcontext(Name name)
Destroys the named context and removes it from the namespace. |
void | destroySubcontext(String name)
Destroys the named context and removes it from the namespace.
|
protected Context | getBoundContext()
Get the bound context. |
Hashtable | getEnvironment()
Retrieves the environment in effect for this context. |
String | getNameInNamespace()
Retrieves the full name of this context within its own namespace.
|
NameParser | getNameParser(Name name)
Retrieves the parser associated with the named context. |
NameParser | getNameParser(String name)
Retrieves the parser associated with the named context.
|
NamingEnumeration | list(Name name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them. |
NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them.
|
NamingEnumeration | listBindings(Name name)
Enumerates the names bound in the named context, along with the
objects bound to them. |
NamingEnumeration | listBindings(String name)
Enumerates the names bound in the named context, along with the
objects bound to them.
|
Object | lookup(Name name)
Retrieves the named object. |
Object | lookup(String name)
Retrieves the named object.
|
Object | lookupLink(Name name)
Retrieves the named object, following links except for the terminal
atomic component of the name. |
Object | lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name.
|
protected String | parseName(String name)
Strips the URL header.
|
protected Name | parseName(Name name)
Strips the URL header.
|
void | rebind(Name name, Object obj)
Binds a name to an object, overwriting any existing binding. |
void | rebind(String name, Object obj)
Binds a name to an object, overwriting any existing binding.
|
Object | removeFromEnvironment(String propName)
Removes an environment property from the environment of this context.
|
void | rename(Name oldName, Name newName)
Binds a new name to the object bound to an old name, and unbinds the
old name. |
void | rename(String oldName, String newName)
Binds a new name to the object bound to an old name, and unbinds the
old name.
|
void | unbind(Name name)
Unbinds the named object. |
void | unbind(String name)
Unbinds the named object.
|
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
Throws: NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Throws: NamingException if a naming exception is encountered
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.
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: NamingException if a naming exception is encountered
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: NamingException if a naming exception is encountered
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 InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes NamingException if a naming exception is encountered
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 InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes NamingException if a naming exception is encountered
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 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
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
Returns: the environment of this context; never null
Throws: NamingException if a naming exception is encountered
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: 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 NamingException if a naming exception is encountered
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: NamingException if a naming exception is encountered
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: NamingException if a naming exception is encountered
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
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: NamingException if a naming exception is encountered
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: NamingException if a naming exception is encountered
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
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: NamingException if a naming exception is encountered
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: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name, not following the terminal link (if any).
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name, not following the terminal link (if any).
Throws: NamingException if a naming exception is encountered
Returns: the parsed name
Throws: NamingException if there is no "java:" header or if no naming context has been bound to this thread
Returns: the parsed name
Throws: NamingException if there is no "java:" header or if no naming context has been bound to this thread
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 the name to bind; may not be empty obj the object to bind; possibly null
Throws: InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null
Throws: InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: propName the name of the environment property to remove; may not be null
Throws: NamingException if a naming exception is encountered
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 NamingException if a naming exception is encountered
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 NamingException if a naming exception is encountered
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.
Parameters: name the name to bind; may not be empty
Throws: NameNotFoundException if an intermediate context does not exist NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty
Throws: NameNotFoundException if an intermediate context does not exist NamingException if a naming exception is encountered