Class SelectorContext
- java.lang.Object
-
- org.apache.naming.SelectorContext
-
- All Implemented Interfaces:
javax.naming.Context
public class SelectorContext extends java.lang.Object implements javax.naming.ContextCatalina JNDI Context implementation.- Author:
- Remy Maucherat
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Hashtable<java.lang.String,java.lang.Object>envEnvironment.static java.lang.StringIC_PREFIXInitial context prefix.protected booleaninitialContextRequest for an initial context.static java.lang.StringprefixNamespace URL.static intprefixLengthNamespace URL length.protected static StringManagersmThe string manager for this package.
-
Constructor Summary
Constructors Constructor 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.ObjectaddToEnvironment(java.lang.String propName, java.lang.Object propVal)Adds a new environment property to the environment of this context.voidbind(java.lang.String name, java.lang.Object obj)Binds a name to an object.voidbind(javax.naming.Name name, java.lang.Object obj)Binds a name to an object.voidclose()Closes this context.java.lang.StringcomposeName(java.lang.String name, java.lang.String prefix)Composes the name of this context with a name relative to this context.javax.naming.NamecomposeName(javax.naming.Name name, javax.naming.Name prefix)Composes the name of this context with a name relative to this context.javax.naming.ContextcreateSubcontext(java.lang.String name)Creates and binds a new context.javax.naming.ContextcreateSubcontext(javax.naming.Name name)Creates and binds a new context.voiddestroySubcontext(java.lang.String name)Destroys the named context and removes it from the namespace.voiddestroySubcontext(javax.naming.Name name)Destroys the named context and removes it from the namespace.protected javax.naming.ContextgetBoundContext()Get the bound context.java.util.Hashtable<?,?>getEnvironment()Retrieves the environment in effect for this context.java.lang.StringgetNameInNamespace()Retrieves the full name of this context within its own namespace.javax.naming.NameParsergetNameParser(java.lang.String name)Retrieves the parser associated with the named context.javax.naming.NameParsergetNameParser(javax.naming.Name name)Retrieves the parser associated with the named context.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.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.Binding>listBindings(java.lang.String name)Enumerates the names bound in the named context, along with the 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.java.lang.Objectlookup(java.lang.String name)Retrieves the named object.java.lang.Objectlookup(javax.naming.Name name)Retrieves the named object.java.lang.ObjectlookupLink(java.lang.String name)Retrieves the named object, following links except for the terminal atomic component of the name.java.lang.ObjectlookupLink(javax.naming.Name name)Retrieves the named object, following links except for the terminal atomic component of the name.protected java.lang.StringparseName(java.lang.String name)Strips the URL header.protected javax.naming.NameparseName(javax.naming.Name name)Strips the URL header.voidrebind(java.lang.String name, java.lang.Object obj)Binds a name to an object, overwriting any existing binding.voidrebind(javax.naming.Name name, java.lang.Object obj)Binds a name to an object, overwriting any existing binding.java.lang.ObjectremoveFromEnvironment(java.lang.String propName)Removes an environment property from the environment of this context.voidrename(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.voidrename(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.voidunbind(java.lang.String name)Unbinds the named object.voidunbind(javax.naming.Name name)Unbinds the named object.
-
-
-
Field Detail
-
prefix
public static final java.lang.String prefix
Namespace URL.- See Also:
- Constant Field Values
-
prefixLength
public static final int prefixLength
Namespace URL length.
-
IC_PREFIX
public static final java.lang.String IC_PREFIX
Initial context prefix.- See Also:
- Constant Field Values
-
env
protected final java.util.Hashtable<java.lang.String,java.lang.Object> env
Environment.
-
sm
protected static final StringManager sm
The string manager for this package.
-
initialContext
protected final boolean initialContext
Request for an initial context.
-
-
Constructor Detail
-
SelectorContext
public SelectorContext(java.util.Hashtable<java.lang.String,java.lang.Object> env)
Builds a Catalina selector context using the given environment.- Parameters:
env- The environment
-
SelectorContext
public SelectorContext(java.util.Hashtable<java.lang.String,java.lang.Object> env, boolean initialContext)Builds a Catalina selector context using the given environment.- Parameters:
env- The environmentinitialContext-trueif this is the main initial context
-
-
Method Detail
-
lookup
public java.lang.Object lookup(javax.naming.Name name) throws javax.naming.NamingExceptionRetrieves 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:
lookupin interfacejavax.naming.Context- 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
-
lookup
public java.lang.Object lookup(java.lang.String name) throws javax.naming.NamingExceptionRetrieves the named object.- Specified by:
lookupin interfacejavax.naming.Context- 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
-
bind
public void bind(javax.naming.Name name, java.lang.Object obj) throws javax.naming.NamingExceptionBinds 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:
bindin interfacejavax.naming.Context- Parameters:
name- the name to bind; may not be emptyobj- the object to bind; possibly null- Throws:
javax.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 encountered
-
bind
public void bind(java.lang.String name, java.lang.Object obj) throws javax.naming.NamingExceptionBinds a name to an object.- Specified by:
bindin interfacejavax.naming.Context- Parameters:
name- the name to bind; may not be emptyobj- the object to bind; possibly null- Throws:
javax.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 encountered
-
rebind
public void rebind(javax.naming.Name name, java.lang.Object obj) throws javax.naming.NamingExceptionBinds 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:
rebindin interfacejavax.naming.Context- Parameters:
name- the name to bind; may not be emptyobj- the object to bind; possibly null- Throws:
javax.naming.directory.InvalidAttributesException- if object did not supply all mandatory attributesjavax.naming.NamingException- if a naming exception is encountered
-
rebind
public void rebind(java.lang.String name, java.lang.Object obj) throws javax.naming.NamingExceptionBinds a name to an object, overwriting any existing binding.- Specified by:
rebindin interfacejavax.naming.Context- Parameters:
name- the name to bind; may not be emptyobj- the object to bind; possibly null- Throws:
javax.naming.directory.InvalidAttributesException- if object did not supply all mandatory attributesjavax.naming.NamingException- if a naming exception is encountered
-
unbind
public void unbind(javax.naming.Name name) throws javax.naming.NamingExceptionUnbinds 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.
- Specified by:
unbindin interfacejavax.naming.Context- Parameters:
name- the name to bind; may not be empty- Throws:
javax.naming.NameNotFoundException- if an intermediate context does not existjavax.naming.NamingException- if a naming exception is encountered
-
unbind
public void unbind(java.lang.String name) throws javax.naming.NamingExceptionUnbinds the named object.- Specified by:
unbindin interfacejavax.naming.Context- Parameters:
name- the name to bind; may not be empty- Throws:
javax.naming.NameNotFoundException- if an intermediate context does not existjavax.naming.NamingException- if a naming exception is encountered
-
rename
public void rename(javax.naming.Name oldName, javax.naming.Name newName) throws javax.naming.NamingExceptionBinds 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:
renamein interfacejavax.naming.Context- Parameters:
oldName- the name of the existing binding; may not be emptynewName- the name of the new binding; may not be empty- Throws:
javax.naming.NameAlreadyBoundException- if name is already boundjavax.naming.NamingException- if a naming exception is encountered
-
rename
public void rename(java.lang.String oldName, java.lang.String newName) throws javax.naming.NamingExceptionBinds a new name to the object bound to an old name, and unbinds the old name.- Specified by:
renamein interfacejavax.naming.Context- Parameters:
oldName- the name of the existing binding; may not be emptynewName- the name of the new binding; may not be empty- Throws:
javax.naming.NameAlreadyBoundException- if name is already boundjavax.naming.NamingException- if a naming exception is encountered
-
list
public javax.naming.NamingEnumeration<javax.naming.NameClassPair> list(javax.naming.Name name) throws javax.naming.NamingExceptionEnumerates 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:
listin interfacejavax.naming.Context- 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
-
list
public javax.naming.NamingEnumeration<javax.naming.NameClassPair> list(java.lang.String name) throws javax.naming.NamingExceptionEnumerates the names bound in the named context, along with the class names of objects bound to them.- Specified by:
listin interfacejavax.naming.Context- 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
-
listBindings
public javax.naming.NamingEnumeration<javax.naming.Binding> listBindings(javax.naming.Name name) throws javax.naming.NamingExceptionEnumerates 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:
listBindingsin interfacejavax.naming.Context- 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
-
listBindings
public javax.naming.NamingEnumeration<javax.naming.Binding> listBindings(java.lang.String name) throws javax.naming.NamingExceptionEnumerates the names bound in the named context, along with the objects bound to them.- Specified by:
listBindingsin interfacejavax.naming.Context- 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
-
destroySubcontext
public void destroySubcontext(javax.naming.Name name) throws javax.naming.NamingExceptionDestroys 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:
destroySubcontextin interfacejavax.naming.Context- Parameters:
name- the name of the context to be destroyed; may not be empty- Throws:
javax.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
-
destroySubcontext
public void destroySubcontext(java.lang.String name) throws javax.naming.NamingExceptionDestroys the named context and removes it from the namespace.- Specified by:
destroySubcontextin interfacejavax.naming.Context- Parameters:
name- the name of the context to be destroyed; may not be empty- Throws:
javax.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
-
createSubcontext
public javax.naming.Context createSubcontext(javax.naming.Name name) throws javax.naming.NamingExceptionCreates 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:
createSubcontextin interfacejavax.naming.Context- Parameters:
name- the name of the context to create; may not be empty- Returns:
- the newly created context
- Throws:
javax.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 encountered
-
createSubcontext
public javax.naming.Context createSubcontext(java.lang.String name) throws javax.naming.NamingExceptionCreates and binds a new context.- Specified by:
createSubcontextin interfacejavax.naming.Context- Parameters:
name- the name of the context to create; may not be empty- Returns:
- the newly created context
- Throws:
javax.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 encountered
-
lookupLink
public java.lang.Object lookupLink(javax.naming.Name name) throws javax.naming.NamingExceptionRetrieves 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:
lookupLinkin interfacejavax.naming.Context- 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
-
lookupLink
public java.lang.Object lookupLink(java.lang.String name) throws javax.naming.NamingExceptionRetrieves the named object, following links except for the terminal atomic component of the name.- Specified by:
lookupLinkin interfacejavax.naming.Context- 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
-
getNameParser
public javax.naming.NameParser getNameParser(javax.naming.Name name) throws javax.naming.NamingExceptionRetrieves 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:
getNameParserin interfacejavax.naming.Context- 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
-
getNameParser
public javax.naming.NameParser getNameParser(java.lang.String name) throws javax.naming.NamingExceptionRetrieves the parser associated with the named context.- Specified by:
getNameParserin interfacejavax.naming.Context- 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
-
composeName
public javax.naming.Name composeName(javax.naming.Name name, javax.naming.Name prefix) throws javax.naming.NamingExceptionComposes 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.
- Specified by:
composeNamein interfacejavax.naming.Context- Parameters:
name- a name relative to this contextprefix- 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
-
composeName
public java.lang.String composeName(java.lang.String name, java.lang.String prefix) throws javax.naming.NamingExceptionComposes the name of this context with a name relative to this context.- Specified by:
composeNamein interfacejavax.naming.Context- Parameters:
name- a name relative to this contextprefix- 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
-
addToEnvironment
public java.lang.Object addToEnvironment(java.lang.String propName, java.lang.Object propVal) throws javax.naming.NamingExceptionAdds a new environment property to the environment of this context. If the property already exists, its value is overwritten.- Specified by:
addToEnvironmentin interfacejavax.naming.Context- Parameters:
propName- the name of the environment property to add; may not be nullpropVal- the value of the property to add; may not be null- Throws:
javax.naming.NamingException- if a naming exception is encountered
-
removeFromEnvironment
public java.lang.Object removeFromEnvironment(java.lang.String propName) throws javax.naming.NamingExceptionRemoves an environment property from the environment of this context.- Specified by:
removeFromEnvironmentin interfacejavax.naming.Context- Parameters:
propName- the name of the environment property to remove; may not be null- Throws:
javax.naming.NamingException- if a naming exception is encountered
-
getEnvironment
public java.util.Hashtable<?,?> getEnvironment() throws javax.naming.NamingExceptionRetrieves 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:
getEnvironmentin interfacejavax.naming.Context- Returns:
- the environment of this context; never null
- Throws:
javax.naming.NamingException- if a naming exception is encountered
-
close
public void close() throws javax.naming.NamingExceptionCloses 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:
closein interfacejavax.naming.Context- Throws:
javax.naming.NamingException- if a naming exception is encountered
-
getNameInNamespace
public java.lang.String getNameInNamespace() throws javax.naming.NamingExceptionRetrieves 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:
getNameInNamespacein interfacejavax.naming.Context- Returns:
- this context's name in its own namespace; never null
- Throws:
javax.naming.OperationNotSupportedException- if the naming system does not have the notion of a full namejavax.naming.NamingException- if a naming exception is encountered
-
getBoundContext
protected javax.naming.Context getBoundContext() throws javax.naming.NamingExceptionGet the bound context.- Returns:
- the Context bound with either the current thread or the current classloader
- Throws:
javax.naming.NamingException- Bindings exception
-
parseName
protected java.lang.String parseName(java.lang.String name) throws javax.naming.NamingExceptionStrips the URL header.- Parameters:
name- The name- Returns:
- the parsed name
- Throws:
javax.naming.NamingException- if there is no "java:" header or if no naming context has been bound to this thread
-
parseName
protected javax.naming.Name parseName(javax.naming.Name name) throws javax.naming.NamingExceptionStrips the URL header.- Parameters:
name- The name- Returns:
- the parsed name
- Throws:
javax.naming.NamingException- if there is no "java:" header or if no naming context has been bound to this thread
-
-