public class SelectorContext
extends java.lang.Object
implements javax.naming.Context
Modifier and Type | Field and Description |
---|---|
protected java.util.Hashtable<java.lang.String,java.lang.Object> |
env
Environment.
|
static java.lang.String |
IC_PREFIX
Initial context prefix.
|
protected boolean |
initialContext
Request for an initial context.
|
static java.lang.String |
prefix
Namespace URL.
|
static int |
prefixLength
Namespace URL length.
|
protected static StringManager |
sm
The string manager for this package.
|
Constructor and Description |
---|
SelectorContext(java.util.Hashtable<java.lang.String,java.lang.Object> env)
Builds a Catalina selector context using the given environment.
|
SelectorContext(java.util.Hashtable<java.lang.String,java.lang.Object> env,
boolean initialContext)
Builds a Catalina selector context using the given environment.
|
Modifier and Type | Method and Description |
---|---|
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.
|
javax.naming.Context |
createSubcontext(javax.naming.Name name)
Creates and binds a new context.
|
javax.naming.Context |
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.
|
protected javax.naming.Context |
getBoundContext()
Get the bound context.
|
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<javax.naming.NameClassPair> |
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<javax.naming.NameClassPair> |
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<javax.naming.Binding> |
listBindings(javax.naming.Name name)
Enumerates the names bound in the named context, along with the
objects bound to them.
|
javax.naming.NamingEnumeration<javax.naming.Binding> |
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.
|
protected javax.naming.Name |
parseName(javax.naming.Name name)
Strips the URL header.
|
protected java.lang.String |
parseName(java.lang.String name)
Strips the URL header.
|
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 |
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.
|
void |
unbind(javax.naming.Name name)
Unbinds the named object.
|
void |
unbind(java.lang.String name)
Unbinds the named object.
|
public static final java.lang.String prefix
public static final int prefixLength
public static final java.lang.String IC_PREFIX
protected final java.util.Hashtable<java.lang.String,java.lang.Object> env
protected static final StringManager sm
protected final boolean initialContext
public SelectorContext(java.util.Hashtable<java.lang.String,java.lang.Object> env)
public SelectorContext(java.util.Hashtable<java.lang.String,java.lang.Object> env, boolean initialContext)
public java.lang.Object lookup(javax.naming.Name name) throws javax.naming.NamingException
lookup
in interface javax.naming.Context
name
- the name of the object to look upjavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object lookup(java.lang.String name) throws javax.naming.NamingException
lookup
in interface javax.naming.Context
name
- the name of the object to look upjavax.naming.NamingException
- if a naming exception is encounteredpublic void bind(javax.naming.Name name, java.lang.Object obj) throws javax.naming.NamingException
bind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nulljavax.naming.NameAlreadyBoundException
- if name is already
boundjavax.naming.directory.InvalidAttributesException
- if object did not
supply all mandatory attributesjavax.naming.NamingException
- if a naming exception is encounteredpublic void bind(java.lang.String name, java.lang.Object obj) throws javax.naming.NamingException
bind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nulljavax.naming.NameAlreadyBoundException
- if name is already
boundjavax.naming.directory.InvalidAttributesException
- if object did not
supply all mandatory attributesjavax.naming.NamingException
- if a naming exception is encounteredpublic void rebind(javax.naming.Name name, java.lang.Object obj) throws javax.naming.NamingException
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.
rebind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nulljavax.naming.directory.InvalidAttributesException
- if object did not
supply all mandatory attributesjavax.naming.NamingException
- if a naming exception is encounteredpublic void rebind(java.lang.String name, java.lang.Object obj) throws javax.naming.NamingException
rebind
in interface javax.naming.Context
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nulljavax.naming.directory.InvalidAttributesException
- if object did not
supply all mandatory attributesjavax.naming.NamingException
- if a naming exception is encounteredpublic void unbind(javax.naming.Name name) throws javax.naming.NamingException
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.
unbind
in interface javax.naming.Context
name
- the name to bind; may not be emptyjavax.naming.NameNotFoundException
- if an intermediate context
does not existjavax.naming.NamingException
- if a naming exception is encounteredpublic void unbind(java.lang.String name) throws javax.naming.NamingException
unbind
in interface javax.naming.Context
name
- the name to bind; may not be emptyjavax.naming.NameNotFoundException
- if an intermediate context
does not existjavax.naming.NamingException
- if a naming exception is encounteredpublic void rename(javax.naming.Name oldName, javax.naming.Name newName) throws javax.naming.NamingException
rename
in interface javax.naming.Context
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyjavax.naming.NameAlreadyBoundException
- if name is already
boundjavax.naming.NamingException
- if a naming exception is encounteredpublic void rename(java.lang.String oldName, java.lang.String newName) throws javax.naming.NamingException
rename
in interface javax.naming.Context
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyjavax.naming.NameAlreadyBoundException
- if name is already
boundjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration<javax.naming.NameClassPair> list(javax.naming.Name name) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
list
in interface javax.naming.Context
name
- the name of the context to listjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration<javax.naming.NameClassPair> list(java.lang.String name) throws javax.naming.NamingException
list
in interface javax.naming.Context
name
- the name of the context to listjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration<javax.naming.Binding> listBindings(javax.naming.Name name) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
listBindings
in interface javax.naming.Context
name
- the name of the context to listjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration<javax.naming.Binding> listBindings(java.lang.String name) throws javax.naming.NamingException
listBindings
in interface javax.naming.Context
name
- the name of the context to listjavax.naming.NamingException
- if a naming exception is encounteredpublic void destroySubcontext(javax.naming.Name name) throws javax.naming.NamingException
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.
destroySubcontext
in interface javax.naming.Context
name
- the name of the context to be destroyed; may not be emptyjavax.naming.NameNotFoundException
- if an intermediate context
does not existjavax.naming.NotContextException
- if the name is bound but does
not name a context, or does not name a context of the appropriate typejavax.naming.NamingException
public void destroySubcontext(java.lang.String name) throws javax.naming.NamingException
destroySubcontext
in interface javax.naming.Context
name
- the name of the context to be destroyed; may not be emptyjavax.naming.NameNotFoundException
- if an intermediate context
does not existjavax.naming.NotContextException
- if the name is bound but does
not name a context, or does not name a context of the appropriate typejavax.naming.NamingException
public javax.naming.Context createSubcontext(javax.naming.Name name) throws javax.naming.NamingException
createSubcontext
in interface javax.naming.Context
name
- the name of the context to create; may not be emptyjavax.naming.NameAlreadyBoundException
- if name is already
boundjavax.naming.directory.InvalidAttributesException
- if creation of the
sub-context requires specification of mandatory attributesjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.Context createSubcontext(java.lang.String name) throws javax.naming.NamingException
createSubcontext
in interface javax.naming.Context
name
- the name of the context to create; may not be emptyjavax.naming.NameAlreadyBoundException
- if name is already
boundjavax.naming.directory.InvalidAttributesException
- if creation of the
sub-context requires specification of mandatory attributesjavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object lookupLink(javax.naming.Name name) throws javax.naming.NamingException
lookupLink
in interface javax.naming.Context
name
- the name of the object to look upjavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object lookupLink(java.lang.String name) throws javax.naming.NamingException
lookupLink
in interface javax.naming.Context
name
- the name of the object to look upjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NameParser getNameParser(javax.naming.Name name) throws javax.naming.NamingException
getNameParser
in interface javax.naming.Context
name
- the name of the context from which to get the parserjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NameParser getNameParser(java.lang.String name) throws javax.naming.NamingException
getNameParser
in interface javax.naming.Context
name
- the name of the context from which to get the parserjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.Name composeName(javax.naming.Name name, javax.naming.Name prefix) throws javax.naming.NamingException
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.
composeName
in interface javax.naming.Context
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestorsjavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.String composeName(java.lang.String name, java.lang.String prefix) throws javax.naming.NamingException
composeName
in interface javax.naming.Context
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestorsjavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object addToEnvironment(java.lang.String propName, java.lang.Object propVal) throws javax.naming.NamingException
addToEnvironment
in interface javax.naming.Context
propName
- the name of the environment property to add; may not
be nullpropVal
- the value of the property to add; may not be nulljavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.Object removeFromEnvironment(java.lang.String propName) throws javax.naming.NamingException
removeFromEnvironment
in interface javax.naming.Context
propName
- the name of the environment property to remove;
may not be nulljavax.naming.NamingException
- if a naming exception is encounteredpublic java.util.Hashtable<?,?> getEnvironment() throws javax.naming.NamingException
getEnvironment
in interface javax.naming.Context
javax.naming.NamingException
- if a naming exception is encounteredpublic void close() throws javax.naming.NamingException
close
in interface javax.naming.Context
javax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.String getNameInNamespace() throws javax.naming.NamingException
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.
getNameInNamespace
in interface javax.naming.Context
javax.naming.OperationNotSupportedException
- if the naming
system does not have the notion of a full namejavax.naming.NamingException
- if a naming exception is encounteredprotected javax.naming.Context getBoundContext() throws javax.naming.NamingException
javax.naming.NamingException
protected java.lang.String parseName(java.lang.String name) throws javax.naming.NamingException
javax.naming.NamingException
- if there is no "java:" header or if no
naming context has been bound to this threadprotected javax.naming.Name parseName(javax.naming.Name name) throws javax.naming.NamingException
javax.naming.NamingException
- if there is no "java:" header or if no
naming context has been bound to this threadCopyright © 2000-2018 Apache Software Foundation. All Rights Reserved.