FileDocCategorySizeDatePackage
SelectorContext.javaAPI DocGlassfish v2 API26038Fri May 04 22:33:00 BST 2007org.apache.naming

SelectorContext

public class SelectorContext extends Object implements Context
Catalina JNDI Context implementation.
author
Remy Maucherat
version
$Revision: 1.4 $ $Date: 2007/05/05 05:32:59 $

Fields Summary
public static final String
prefix
Namespace URL.
public static final int
prefixLength
Namespace URL length.
public static final String
IC_PREFIX
Initial context prefix.
protected Hashtable
env
Environment.
protected StringManager
sm
The string manager for this package.
protected boolean
initialContext
Request for an initial context.
Constructors Summary
public SelectorContext(Hashtable env)
Builds a Catalina selector context using the given environment.



    // ----------------------------------------------------------- Constructors


                  
       
        this.env = env;
    
public SelectorContext(Hashtable env, boolean initialContext)
Builds a Catalina selector context using the given environment.

        this(env);
        this.initialContext = initialContext;
    
Methods Summary
public java.lang.ObjectaddToEnvironment(java.lang.String propName, java.lang.Object propVal)
Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.

param
propName the name of the environment property to add; may not be null
param
propVal the value of the property to add; may not be null
exception
NamingException if a naming exception is encountered

        return getBoundContext().addToEnvironment(propName, propVal);
    
public voidbind(javax.naming.Name name, java.lang.Object obj)
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.

param
name the name to bind; may not be empty
param
obj the object to bind; possibly null
exception
NameAlreadyBoundException if name is already bound
exception
InvalidAttributesException if object did not supply all mandatory attributes
exception
NamingException if a naming exception is encountered

        getBoundContext().bind(parseName(name), obj);
    
public voidbind(java.lang.String name, java.lang.Object obj)
Binds a name to an object.

param
name the name to bind; may not be empty
param
obj the object to bind; possibly null
exception
NameAlreadyBoundException if name is already bound
exception
InvalidAttributesException if object did not supply all mandatory attributes
exception
NamingException if a naming exception is encountered

        getBoundContext().bind(parseName(name), obj);
    
public voidclose()
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.

exception
NamingException if a naming exception is encountered

        getBoundContext().close();
    
public javax.naming.NamecomposeName(javax.naming.Name name, javax.naming.Name prefix)
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.

param
name a name relative to this context
param
prefix the name of this context relative to one of its ancestors
return
the composition of prefix and name
exception
NamingException if a naming exception is encountered

	prefix = (Name) prefix.clone();
	return prefix.addAll(name);
    
public java.lang.StringcomposeName(java.lang.String name, java.lang.String prefix)
Composes the name of this context with a name relative to this context.

param
name a name relative to this context
param
prefix the name of this context relative to one of its ancestors
return
the composition of prefix and name
exception
NamingException if a naming exception is encountered

        return prefix + "/" + name;
    
public javax.naming.ContextcreateSubcontext(javax.naming.Name name)
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.

param
name the name of the context to create; may not be empty
return
the newly created context
exception
NameAlreadyBoundException if name is already bound
exception
InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes
exception
NamingException if a naming exception is encountered

        return getBoundContext().createSubcontext(parseName(name));
    
public javax.naming.ContextcreateSubcontext(java.lang.String name)
Creates and binds a new context.

param
name the name of the context to create; may not be empty
return
the newly created context
exception
NameAlreadyBoundException if name is already bound
exception
InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes
exception
NamingException if a naming exception is encountered

        return getBoundContext().createSubcontext(parseName(name));
    
public voiddestroySubcontext(javax.naming.Name name)
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.

param
name the name of the context to be destroyed; may not be empty
exception
NameNotFoundException if an intermediate context does not exist
exception
NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type

        getBoundContext().destroySubcontext(parseName(name));
    
public voiddestroySubcontext(java.lang.String name)
Destroys the named context and removes it from the namespace.

param
name the name of the context to be destroyed; may not be empty
exception
NameNotFoundException if an intermediate context does not exist
exception
NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type

        getBoundContext().destroySubcontext(parseName(name));
    
protected javax.naming.ContextgetBoundContext()
Get the bound context.


        if (initialContext) {
            String ICName = IC_PREFIX;
            if (ContextBindings.isThreadBound()) {
                ICName += ContextBindings.getThreadName();
            } else if (ContextBindings.isClassLoaderBound()) {
                ICName += ContextBindings.getClassLoaderName();
            }
            Context initialContext = ContextBindings.getContext(ICName);
            if (initialContext == null) {
                // Allocating a new context and binding it to the appropriate 
                // name
                initialContext = new NamingContext(env, ICName);
                ContextBindings.bindContext(ICName, initialContext);
            }
            return initialContext;
        } else {
            if (ContextBindings.isThreadBound()) {
                return ContextBindings.getThread();
            } else {
                return ContextBindings.getClassLoader();
            }
        }

    
public java.util.HashtablegetEnvironment()
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().

return
the environment of this context; never null
exception
NamingException if a naming exception is encountered

        return getBoundContext().getEnvironment();
    
public java.lang.StringgetNameInNamespace()
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.

return
this context's name in its own namespace; never null
exception
OperationNotSupportedException if the naming system does not have the notion of a full name
exception
NamingException if a naming exception is encountered

        return prefix;
    
public javax.naming.NameParsergetNameParser(javax.naming.Name name)
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).

param
name the name of the context from which to get the parser
return
a name parser that can parse compound names into their atomic components
exception
NamingException if a naming exception is encountered

        return getBoundContext().getNameParser(parseName(name));
    
public javax.naming.NameParsergetNameParser(java.lang.String name)
Retrieves the parser associated with the named context.

param
name the name of the context from which to get the parser
return
a name parser that can parse compound names into their atomic components
exception
NamingException if a naming exception is encountered

        return getBoundContext().getNameParser(parseName(name));
    
public javax.naming.NamingEnumerationlist(javax.naming.Name name)
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.

param
name the name of the context to list
return
an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
exception
NamingException if a naming exception is encountered

        return getBoundContext().list(parseName(name));
    
public javax.naming.NamingEnumerationlist(java.lang.String name)
Enumerates the names bound in the named context, along with the class names of objects bound to them.

param
name the name of the context to list
return
an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
exception
NamingException if a naming exception is encountered

        return getBoundContext().list(parseName(name));
    
public javax.naming.NamingEnumerationlistBindings(javax.naming.Name name)
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.

param
name the name of the context to list
return
an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
exception
NamingException if a naming exception is encountered

        return getBoundContext().listBindings(parseName(name));
    
public javax.naming.NamingEnumerationlistBindings(java.lang.String name)
Enumerates the names bound in the named context, along with the objects bound to them.

param
name the name of the context to list
return
an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
exception
NamingException if a naming exception is encountered

        return getBoundContext().listBindings(parseName(name));
    
public java.lang.Objectlookup(javax.naming.Name name)
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).

param
name the name of the object to look up
return
the object bound to name
exception
NamingException if a naming exception is encountered



    // --------------------------------------------------------- Public Methods


    // -------------------------------------------------------- Context Methods


                                                                          
       
          
        // Strip the URL header
        // Find the appropriate NamingContext according to the current bindings
        // Execute the lookup on that context
        return getBoundContext().lookup(parseName(name));
    
public java.lang.Objectlookup(java.lang.String name)
Retrieves the named object.

param
name the name of the object to look up
return
the object bound to name
exception
NamingException if a naming exception is encountered

        // Strip the URL header
        // Find the appropriate NamingContext according to the current bindings
        // Execute the lookup on that context
        return getBoundContext().lookup(parseName(name));
    
public java.lang.ObjectlookupLink(javax.naming.Name name)
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.

param
name the name of the object to look up
return
the object bound to name, not following the terminal link (if any).
exception
NamingException if a naming exception is encountered

        return getBoundContext().lookupLink(parseName(name));
    
public java.lang.ObjectlookupLink(java.lang.String name)
Retrieves the named object, following links except for the terminal atomic component of the name.

param
name the name of the object to look up
return
the object bound to name, not following the terminal link (if any).
exception
NamingException if a naming exception is encountered

        return getBoundContext().lookupLink(parseName(name));
    
protected java.lang.StringparseName(java.lang.String name)
Strips the URL header.

return
the parsed name
exception
NamingException if there is no "java:" header or if no naming context has been bound to this thread

        
	if ((!initialContext) && (name.startsWith(prefix))) {
            return (name.substring(prefixLength));
        } else {
            if (initialContext) {
                return (name);
            } else {
                throw new NamingException
                    (sm.getString("selectorContext.noJavaUrl"));
            }
        }
        
    
protected javax.naming.NameparseName(javax.naming.Name name)
Strips the URL header.

return
the parsed name
exception
NamingException if there is no "java:" header or if no naming context has been bound to this thread


	if ((!initialContext) && (!name.isEmpty()) 
            && (name.get(0).equals(prefix))) {
            return (name.getSuffix(1));
        } else {
            if (initialContext) {
                return (name);
            } else {
                throw new NamingException
                    (sm.getString("selectorContext.noJavaUrl"));
            }
        }

    
public voidrebind(javax.naming.Name name, java.lang.Object obj)
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.

param
name the name to bind; may not be empty
param
obj the object to bind; possibly null
exception
InvalidAttributesException if object did not supply all mandatory attributes
exception
NamingException if a naming exception is encountered

        getBoundContext().rebind(parseName(name), obj);
    
public voidrebind(java.lang.String name, java.lang.Object obj)
Binds a name to an object, overwriting any existing binding.

param
name the name to bind; may not be empty
param
obj the object to bind; possibly null
exception
InvalidAttributesException if object did not supply all mandatory attributes
exception
NamingException if a naming exception is encountered

        getBoundContext().rebind(parseName(name), obj);
    
public java.lang.ObjectremoveFromEnvironment(java.lang.String propName)
Removes an environment property from the environment of this context.

param
propName the name of the environment property to remove; may not be null
exception
NamingException if a naming exception is encountered

        return getBoundContext().removeFromEnvironment(propName);
    
public 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. 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.

param
oldName the name of the existing binding; may not be empty
param
newName the name of the new binding; may not be empty
exception
NameAlreadyBoundException if newName is already bound
exception
NamingException if a naming exception is encountered

        getBoundContext().rename(parseName(oldName), parseName(newName));
    
public 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.

param
oldName the name of the existing binding; may not be empty
param
newName the name of the new binding; may not be empty
exception
NameAlreadyBoundException if newName is already bound
exception
NamingException if a naming exception is encountered

        getBoundContext().rename(parseName(oldName), parseName(newName));
    
public voidunbind(java.lang.String name)
Unbinds the named object.

param
name the name to bind; may not be empty
exception
NameNotFoundException if an intermediate context does not exist
exception
NamingException if a naming exception is encountered

        getBoundContext().unbind(parseName(name));
    
public voidunbind(javax.naming.Name name)
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.

param
name the name to bind; may not be empty
exception
NameNotFoundException if an intermediate context does not exist
exception
NamingException if a naming exception is encountered

        getBoundContext().unbind(parseName(name));