File	Doc	Category	Size	Date	Package
InitialContext.java	API Doc	Java SE 6 API	19287	Tue Jun 10 00:26:20 BST 2008	javax.naming

InitialContext

• java.lang.Object

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.Object	addToEnvironment(java.lang.String propName, java.lang.Object propVal) myProps.put(propName, propVal); return getDefaultInitCtx().addToEnvironment(propName, propVal);
public void	bind(java.lang.String name, java.lang.Object obj) getURLOrDefaultInitCtx(name).bind(name, obj);
public void	bind(javax.naming.Name name, java.lang.Object obj) getURLOrDefaultInitCtx(name).bind(name, obj);
public void	close() myProps = null; if (defaultInitCtx != null) { defaultInitCtx.close(); defaultInitCtx = null; } gotDefault = false;
public 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. 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.Name	composeName(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.Context	createSubcontext(java.lang.String name) return getURLOrDefaultInitCtx(name).createSubcontext(name);
public javax.naming.Context	createSubcontext(javax.naming.Name name) return getURLOrDefaultInitCtx(name).createSubcontext(name);
public void	destroySubcontext(java.lang.String name) getURLOrDefaultInitCtx(name).destroySubcontext(name);
public void	destroySubcontext(javax.naming.Name name) getURLOrDefaultInitCtx(name).destroySubcontext(name);
public static T	doLookup(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 T	doLookup(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.Context	getDefaultInitCtx() 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.Hashtable	getEnvironment() return getDefaultInitCtx().getEnvironment();
public java.lang.String	getNameInNamespace() return getDefaultInitCtx().getNameInNamespace();
public javax.naming.NameParser	getNameParser(java.lang.String name) return getURLOrDefaultInitCtx(name).getNameParser(name);
public javax.naming.NameParser	getNameParser(javax.naming.Name name) return getURLOrDefaultInitCtx(name).getNameParser(name);
protected javax.naming.Context	getURLOrDefaultInitCtx(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.Context	getURLOrDefaultInitCtx(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.String	getURLScheme(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 void	init(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.NamingEnumeration	list(java.lang.String name) return (getURLOrDefaultInitCtx(name).list(name));
public javax.naming.NamingEnumeration	list(javax.naming.Name name) return (getURLOrDefaultInitCtx(name).list(name));
public javax.naming.NamingEnumeration	listBindings(java.lang.String name) return getURLOrDefaultInitCtx(name).listBindings(name);
public javax.naming.NamingEnumeration	listBindings(javax.naming.Name name) return getURLOrDefaultInitCtx(name).listBindings(name);
public java.lang.Object	lookup(java.lang.String name) return getURLOrDefaultInitCtx(name).lookup(name);
public java.lang.Object	lookup(javax.naming.Name name) return getURLOrDefaultInitCtx(name).lookup(name);
public java.lang.Object	lookupLink(java.lang.String name) return getURLOrDefaultInitCtx(name).lookupLink(name);
public java.lang.Object	lookupLink(javax.naming.Name name) return getURLOrDefaultInitCtx(name).lookupLink(name);
public void	rebind(java.lang.String name, java.lang.Object obj) getURLOrDefaultInitCtx(name).rebind(name, obj);
public void	rebind(javax.naming.Name name, java.lang.Object obj) getURLOrDefaultInitCtx(name).rebind(name, obj);
public java.lang.Object	removeFromEnvironment(java.lang.String propName) myProps.remove(propName); return getDefaultInitCtx().removeFromEnvironment(propName);
public void	rename(java.lang.String oldName, java.lang.String newName) getURLOrDefaultInitCtx(oldName).rename(oldName, newName);
public void	rename(javax.naming.Name oldName, javax.naming.Name newName) getURLOrDefaultInitCtx(oldName).rename(oldName, newName);
public void	unbind(java.lang.String name) getURLOrDefaultInitCtx(name).unbind(name);
public void	unbind(javax.naming.Name name) getURLOrDefaultInitCtx(name).unbind(name);