FileDocCategorySizeDatePackage
InitialContext.javaAPI DocJava SE 6 API19287Tue Jun 10 00:26:20 BST 2008javax.naming

InitialContext

public class InitialContext extends Object implements Context
This class is the starting context for performing naming operations.

All naming operations are relative to a context. The initial context implements the Context interface and provides the starting point for resolution of names.

When the initial context is constructed, its environment is initialized with properties defined in the environment parameter passed to the constructor, and in any application resource files. In addition, a small number of standard JNDI properties may be specified as system properties or as applet parameters (through the use of {@link Context#APPLET}). These special properties are listed in the field detail sections of the Context and LdapContext interface documentation.

JNDI determines each property's value by merging the values from the following two sources, in order:

  1. The first occurrence of the property from the constructor's environment parameter and (for appropriate properties) the applet parameters and system properties.
  2. The application resource files (jndi.properties).
For each property found in both of these two sources, or in more than one application resource file, the property's value is determined as follows. If the property is one of the standard JNDI properties that specify a list of JNDI factories (see Context), all of the values are concatenated into a single colon-separated list. For other properties, only the first value found is used.

The initial context implementation is determined at runtime. The default policy uses the environment property "{@link Context#INITIAL_CONTEXT_FACTORY java.naming.factory.initial}", which contains the class name of the initial context factory. An exception to this policy is made when resolving URL strings, as described below.

When a URL string (a String of the form scheme_id:rest_of_name) is passed as a name parameter to any method, a URL context factory for handling that scheme is located and used to resolve the URL. If no such factory is found, the initial context specified by "java.naming.factory.initial" is used. Similarly, when a CompositeName object whose first component is a URL string is passed as a name parameter to any method, a URL context factory is located and used to resolve the first name component. See {@link NamingManager#getURLContext NamingManager.getURLContext()} for a description of how URL context factories are located.

This default policy of locating the initial context and URL context factories may be overridden by calling NamingManager.setInitialContextFactoryBuilder().

NoInitialContextException is thrown when an initial context cannot be instantiated. This exception can be thrown during any interaction with the InitialContext, not only when the InitialContext is constructed. For example, the implementation of the initial context might lazily retrieve the context only when actual methods are invoked on it. The application should not have any dependency on when the existence of an initial context is determined.

When the environment property "java.naming.factory.initial" is non-null, the InitialContext constructor will attempt to create the initial context specified therein. At that time, the initial context factory involved might throw an exception if a problem is encountered. However, it is provider implementation-dependent when it verifies and indicates to the users of the initial context any environment property- or connection- related problems. It can do so lazily--delaying until an operation is performed on the context, or eagerly, at the time the context is constructed.

An InitialContext instance is not synchronized against concurrent access by multiple threads. Multiple threads each manipulating a different InitialContext instance need not synchronize. Threads that need to access a single InitialContext instance concurrently should synchronize amongst themselves and provide the necessary locking.

author
Rosanna Lee
author
Scott Seligman
version
1.15 06/01/06
see
Context
see
NamingManager#setInitialContextFactoryBuilder NamingManager.setInitialContextFactoryBuilder
since
JNDI 1.1 / Java 2 Platform, Standard Edition, v 1.3

Fields Summary
protected Hashtable
myProps
The environment associated with this InitialContext. It is initialized to null and is updated by the constructor that accepts an environment or by the init() method.
protected Context
defaultInitCtx
Field holding the result of calling NamingManager.getInitialContext(). It is set by getDefaultInitCtx() the first time getDefaultInitCtx() is called. Subsequent invocations of getDefaultInitCtx() return the value of defaultInitCtx.
protected boolean
gotDefault
Field indicating whether the initial context has been obtained by calling NamingManager.getInitialContext(). If true, its result is in defaultInitCtx.
Constructors Summary
protected InitialContext(boolean lazy)
Constructs an initial context with the option of not initializing it. This may be used by a constructor in a subclass when the value of the environment parameter is not yet known at the time the InitialContext constructor is called. The subclass's constructor will call this constructor, compute the value of the environment, and then call init() before returning.

param
lazy true means do not initialize the initial context; false is equivalent to calling new InitialContext()
throws
NamingException if a naming exception is encountered
see
#init(Hashtable)
since
1.3


                                                                   		        		      	               
         
	if (!lazy) {
	    init(null);
	}
    
public InitialContext()
Constructs an initial context. No environment properties are supplied. Equivalent to new InitialContext(null).

throws
NamingException if a naming exception is encountered
see
#InitialContext(Hashtable)

	init(null);
    
public InitialContext(Hashtable environment)
Constructs an initial context using the supplied environment. Environment properties are discussed in the class description.

This constructor will not modify environment or save a reference to it, but may save a clone.

param
environment environment used to create the initial context. Null indicates an empty environment.
throws
NamingException if a naming exception is encountered

	if (environment != null) {
	    environment = (Hashtable)environment.clone();
	}
	init(environment);
    
Methods Summary
public java.lang.ObjectaddToEnvironment(java.lang.String propName, java.lang.Object propVal)

	myProps.put(propName, propVal);
	return getDefaultInitCtx().addToEnvironment(propName, propVal);
    
public voidbind(java.lang.String name, java.lang.Object obj)

	getURLOrDefaultInitCtx(name).bind(name, obj);
    
public voidbind(javax.naming.Name name, java.lang.Object obj)

	getURLOrDefaultInitCtx(name).bind(name, obj);
    
public voidclose()

	myProps = null;
	if (defaultInitCtx != null) {
	    defaultInitCtx.close();
	    defaultInitCtx = null;
	}
	gotDefault = false;
    
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. Since an initial context may never be named relative to any context other than itself, the value of the prefix parameter must be an empty name ("").

	return name;
    
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. Since an initial context may never be named relative to any context other than itself, the value of the prefix parameter must be an empty name.

	return (Name)name.clone();
    
public javax.naming.ContextcreateSubcontext(java.lang.String name)

	return getURLOrDefaultInitCtx(name).createSubcontext(name);
    
public javax.naming.ContextcreateSubcontext(javax.naming.Name name)

	return getURLOrDefaultInitCtx(name).createSubcontext(name);
    
public voiddestroySubcontext(java.lang.String name)

	getURLOrDefaultInitCtx(name).destroySubcontext(name);
    
public voiddestroySubcontext(javax.naming.Name name)

	getURLOrDefaultInitCtx(name).destroySubcontext(name);
    
public static TdoLookup(javax.naming.Name name)
A static method to retrieve the named object. This is a shortcut method equivalent to invoking:

InitialContext ic = new InitialContext(); Object obj = ic.lookup();

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
throws
NamingException if a naming exception is encountered
see
#doLookup(String)
see
#lookup(Name)
since
1.6

        return (T) (new InitialContext()).lookup(name);
    
public static TdoLookup(java.lang.String name)
A static method to retrieve the named object. See {@link #doLookup(Name)} for details.

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

        return (T) (new InitialContext()).lookup(name);
    
protected javax.naming.ContextgetDefaultInitCtx()
Retrieves the initial context by calling NamingManager.getInitialContext() and cache it in defaultInitCtx. Set gotDefault so that we know we've tried this before.

return
The non-null cached initial context.
exception
NoInitialContextException If cannot find an initial context.
exception
NamingException If a naming exception was encountered.

	if (!gotDefault) {
	    defaultInitCtx = NamingManager.getInitialContext(myProps);
	    gotDefault = true;
	}
	if (defaultInitCtx == null)
	    throw new NoInitialContextException();

	return defaultInitCtx;
    
public java.util.HashtablegetEnvironment()

	return getDefaultInitCtx().getEnvironment();
    
public java.lang.StringgetNameInNamespace()

	return getDefaultInitCtx().getNameInNamespace();
    
public javax.naming.NameParsergetNameParser(java.lang.String name)

	return getURLOrDefaultInitCtx(name).getNameParser(name);
    
public javax.naming.NameParsergetNameParser(javax.naming.Name name)

	return getURLOrDefaultInitCtx(name).getNameParser(name);
    
protected javax.naming.ContextgetURLOrDefaultInitCtx(javax.naming.Name name)
Retrieves a context for resolving name. If the first component of name name is a URL string, then attempt to find a URL context for it. If none is found, or if the first component of name is not a URL string, then return getDefaultInitCtx().

When creating a subclass of InitialContext, use this method as follows. Define a new method that uses this method to get an initial context of the desired subclass.

protected XXXContext getURLOrDefaultInitXXXCtx(Name name)
throws NamingException {
Context answer = getURLOrDefaultInitCtx(name);
if (!(answer instanceof XXXContext)) {
if (answer == null) {
throw new NoInitialContextException();
} else {
throw new NotContextException("Not an XXXContext");
}
}
return (XXXContext)answer;
}
When providing implementations for the new methods in the subclass, use this newly defined method to get the initial context.

public Object XXXMethod1(Name name, ...) {
throws NamingException {
return getURLOrDefaultInitXXXCtx(name).XXXMethod1(name, ...);
}

param
name The non-null name for which to get the context.
return
A URL context for name or the cached initial context. The result cannot be null.
exception
NoInitialContextException If cannot find an initial context.
exception
NamingException In a naming exception is encountered.
see
javax.naming.spi.NamingManager#getURLContext

	if (NamingManager.hasInitialContextFactoryBuilder()) {
	    return getDefaultInitCtx();
	}
	if (name.size() > 0) {
	    String first = name.get(0);
	    String scheme = getURLScheme(first);
	    if (scheme != null) {
		Context ctx = NamingManager.getURLContext(scheme, myProps);
		if (ctx != null) {
		    return ctx;
		}
	    } 
	}
	return getDefaultInitCtx();
    
protected javax.naming.ContextgetURLOrDefaultInitCtx(java.lang.String name)
Retrieves a context for resolving the string name name. If name name is a URL string, then attempt to find a URL context for it. If none is found, or if name is not a URL string, then return getDefaultInitCtx().

See getURLOrDefaultInitCtx(Name) for description of how a subclass should use this method.

param
name The non-null name for which to get the context.
return
A URL context for name or the cached initial context. The result cannot be null.
exception
NoInitialContextException If cannot find an initial context.
exception
NamingException In a naming exception is encountered.
see
javax.naming.spi.NamingManager#getURLContext

	if (NamingManager.hasInitialContextFactoryBuilder()) {
	    return getDefaultInitCtx();
	}
	String scheme = getURLScheme(name);
	if (scheme != null) {
	    Context ctx = NamingManager.getURLContext(scheme, myProps);
	    if (ctx != null) {
		return ctx;
	    }
	}
	return getDefaultInitCtx();
    
private static java.lang.StringgetURLScheme(java.lang.String str)

	int colon_posn = str.indexOf(':");
	int slash_posn = str.indexOf('/");

	if (colon_posn > 0 && (slash_posn == -1 || colon_posn < slash_posn))
	    return str.substring(0, colon_posn);
	return null;
    
protected voidinit(java.util.Hashtable environment)
Initializes the initial context using the supplied environment. Environment properties are discussed in the class description.

This method will modify environment and save a reference to it. The caller may no longer modify it.

param
environment environment used to create the initial context. Null indicates an empty environment.
throws
NamingException if a naming exception is encountered
see
#InitialContext(boolean)
since
1.3

	myProps = ResourceManager.getInitialEnvironment(environment);

	if (myProps.get(Context.INITIAL_CONTEXT_FACTORY) != null) {
	    // user has specified initial context factory; try to get it
	    getDefaultInitCtx();
	}
    
public javax.naming.NamingEnumerationlist(java.lang.String name)

	return (getURLOrDefaultInitCtx(name).list(name));
    
public javax.naming.NamingEnumerationlist(javax.naming.Name name)

	return (getURLOrDefaultInitCtx(name).list(name));
    
public javax.naming.NamingEnumerationlistBindings(java.lang.String name)

	return getURLOrDefaultInitCtx(name).listBindings(name);
    
public javax.naming.NamingEnumerationlistBindings(javax.naming.Name name)

	return getURLOrDefaultInitCtx(name).listBindings(name);
    
public java.lang.Objectlookup(java.lang.String name)

	return getURLOrDefaultInitCtx(name).lookup(name);
    
public java.lang.Objectlookup(javax.naming.Name name)

	return getURLOrDefaultInitCtx(name).lookup(name);
    
public java.lang.ObjectlookupLink(java.lang.String name)

	return getURLOrDefaultInitCtx(name).lookupLink(name);
    
public java.lang.ObjectlookupLink(javax.naming.Name name)

	return getURLOrDefaultInitCtx(name).lookupLink(name);
    
public voidrebind(java.lang.String name, java.lang.Object obj)

	getURLOrDefaultInitCtx(name).rebind(name, obj);
    
public voidrebind(javax.naming.Name name, java.lang.Object obj)

	getURLOrDefaultInitCtx(name).rebind(name, obj);
    
public java.lang.ObjectremoveFromEnvironment(java.lang.String propName)

	myProps.remove(propName);
	return getDefaultInitCtx().removeFromEnvironment(propName);
    
public voidrename(java.lang.String oldName, java.lang.String newName)

	getURLOrDefaultInitCtx(oldName).rename(oldName, newName);
    
public voidrename(javax.naming.Name oldName, javax.naming.Name newName)

	getURLOrDefaultInitCtx(oldName).rename(oldName, newName);
    
public voidunbind(java.lang.String name)

	getURLOrDefaultInitCtx(name).unbind(name);
    
public voidunbind(javax.naming.Name name)

	getURLOrDefaultInitCtx(name).unbind(name);