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 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:
jndi.properties). 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 "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 NamingManager.getURLContext()
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.
Context, NamingManager.setInitialContextFactoryBuilder
protected Hashtable<Object,Object> 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.
addToEnvironment(java.lang.String, java.lang.Object), removeFromEnvironment(java.lang.String), getEnvironment()
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.
getDefaultInitCtx()protected boolean gotDefault
Field indicating whether the initial context has been obtained by calling NamingManager.getInitialContext(). If true, its result is in defaultInitCtx.
protected InitialContext(boolean lazy)
throws NamingException 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.
lazy - true means do not initialize the initial context; false is equivalent to calling new InitialContext()
NamingException - if a naming exception is encounteredinit(Hashtable)public InitialContext()
throws NamingException Constructs an initial context. No environment properties are supplied. Equivalent to new InitialContext(null).
NamingException - if a naming exception is encounteredInitialContext(Hashtable)public InitialContext(Hashtable<?,?> environment)
throws NamingException 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. Caller should not modify mutable keys and values in environment after it has been passed to the constructor.
environment - environment used to create the initial context. Null indicates an empty environment.NamingException - if a naming exception is encounteredprotected void init(Hashtable<?,?> environment)
throws NamingException 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.
environment - environment used to create the initial context. Null indicates an empty environment.NamingException - if a naming exception is encounteredInitialContext(boolean)public static <T> T doLookup(Name name)
throws NamingException 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).
T - the type of the returned objectname - the name of the object to look upname
NamingException - if a naming exception is encountereddoLookup(String), lookup(Name)
public static <T> T doLookup(String name)
throws NamingException A static method to retrieve the named object. See doLookup(Name) for details.
T - the type of the returned objectname - the name of the object to look upname
NamingException - if a naming exception is encounteredprotected Context getDefaultInitCtx()
throws NamingException Retrieves the initial context by calling NamingManager.getInitialContext() and cache it in defaultInitCtx. Set gotDefault so that we know we've tried this before.
NoInitialContextException - If cannot find an initial context.NamingException - If a naming exception was encountered.protected Context getURLOrDefaultInitCtx(String name)
throws NamingException 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.
name - The non-null name for which to get the context.name or the cached initial context. The result cannot be null.NoInitialContextException - If cannot find an initial context.NamingException - In a naming exception is encountered.NamingManager.getURLContext(java.lang.String, java.util.Hashtable<?, ?>)protected Context getURLOrDefaultInitCtx(Name name)
throws NamingException 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, ...);
}
name - The non-null name for which to get the context.name or the cached initial context. The result cannot be null.NoInitialContextException - If cannot find an initial context.NamingException - In a naming exception is encountered.NamingManager.getURLContext(java.lang.String, java.util.Hashtable<?, ?>)public Object lookup(String name)
throws NamingException Description copied from interface: Context
Retrieves the named object. See Context.lookup(Name) for details.
lookup in interface Context
name - the name of the object to look upname
NamingException - if a naming exception is encounteredpublic Object lookup(Name name)
throws NamingException Description copied from interface: Context
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).
lookup in interface Context
name - the name of the object to look upname
NamingException - if a naming exception is encounteredContext.lookup(String), Context.lookupLink(Name)
public void bind(String name,
Object obj)
throws NamingException Description copied from interface: Context
Binds a name to an object. See Context.bind(Name, Object) for details.
bind in interface Context
name - the name to bind; may not be emptyobj - the object to bind; possibly nullNameAlreadyBoundException - if name is already boundInvalidAttributesException - if object did not supply all mandatory attributesNamingException - if a naming exception is encounteredpublic void bind(Name name,
Object obj)
throws NamingException Description copied from interface: Context
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.
bind in interface Context
name - the name to bind; may not be emptyobj - the object to bind; possibly nullNameAlreadyBoundException - if name is already boundInvalidAttributesException - if object did not supply all mandatory attributesNamingException - if a naming exception is encounteredContext.bind(String, Object), Context.rebind(Name, Object), DirContext.bind(Name, Object,
javax.naming.directory.Attributes)
public void rebind(String name,
Object obj)
throws NamingException Description copied from interface: Context
Binds a name to an object, overwriting any existing binding. See Context.rebind(Name, Object) for details.
rebind in interface Context
name - the name to bind; may not be emptyobj - the object to bind; possibly nullInvalidAttributesException - if object did not supply all mandatory attributesNamingException - if a naming exception is encounteredpublic void rebind(Name name,
Object obj)
throws NamingException Description copied from interface: Context
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.
rebind in interface Context
name - the name to bind; may not be emptyobj - the object to bind; possibly nullInvalidAttributesException - if object did not supply all mandatory attributesNamingException - if a naming exception is encounteredContext.rebind(String, Object), Context.bind(Name, Object), DirContext.rebind(Name, Object,
javax.naming.directory.Attributes), DirContext
public void unbind(String name)
throws NamingException Description copied from interface: Context
Unbinds the named object. See Context.unbind(Name) for details.
unbind in interface Context
name - the name to unbind; may not be emptyNameNotFoundException - if an intermediate context does not existNamingException - if a naming exception is encounteredpublic void unbind(Name name)
throws NamingException Description copied from interface: Context
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.
Any attributes associated with the name are removed. Intermediate contexts are not changed.
unbind in interface Context
name - the name to unbind; may not be emptyNameNotFoundException - if an intermediate context does not existNamingException - if a naming exception is encounteredContext.unbind(String)public void rename(String oldName,
String newName)
throws NamingException Description copied from interface: Context
Binds a new name to the object bound to an old name, and unbinds the old name. See Context.rename(Name, Name) for details.
rename in interface Context
oldName - the name of the existing binding; may not be emptynewName - the name of the new binding; may not be emptyNameAlreadyBoundException - if newName is already boundNamingException - if a naming exception is encounteredpublic void rename(Name oldName,
Name newName)
throws NamingException Description copied from interface: Context
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.
rename in interface Context
oldName - the name of the existing binding; may not be emptynewName - the name of the new binding; may not be emptyNameAlreadyBoundException - if newName is already boundNamingException - if a naming exception is encounteredContext.rename(String, String), Context.bind(Name, Object), Context.rebind(Name, Object)
public NamingEnumeration<NameClassPair> list(String name)
throws NamingException Description copied from interface: Context
Enumerates the names bound in the named context, along with the class names of objects bound to them. See Context.list(Name) for details.
list in interface Context
name - the name of the context to listNameClassPair.NamingException - if a naming exception is encounteredpublic NamingEnumeration<NameClassPair> list(Name name)
throws NamingException Description copied from interface: Context
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.
list in interface Context
name - the name of the context to listNameClassPair.NamingException - if a naming exception is encounteredContext.list(String), Context.listBindings(Name), NameClassPair
public NamingEnumeration<Binding> listBindings(String name)
throws NamingException Description copied from interface: Context
Enumerates the names bound in the named context, along with the objects bound to them. See Context.listBindings(Name) for details.
listBindings in interface Context
name - the name of the context to listBinding.NamingException - if a naming exception is encounteredpublic NamingEnumeration<Binding> listBindings(Name name)
throws NamingException Description copied from interface: Context
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.
listBindings in interface Context
name - the name of the context to listBinding.NamingException - if a naming exception is encounteredContext.listBindings(String), Context.list(Name), Binding
public void destroySubcontext(String name)
throws NamingException Description copied from interface: Context
Destroys the named context and removes it from the namespace. See Context.destroySubcontext(Name) for details.
destroySubcontext in interface Context
name - the name of the context to be destroyed; may not be emptyNameNotFoundException - if an intermediate context does not existNotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate typeContextNotEmptyException - if the named context is not emptyNamingException - if a naming exception is encounteredpublic void destroySubcontext(Name name)
throws NamingException Description copied from interface: Context
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.
destroySubcontext in interface Context
name - the name of the context to be destroyed; may not be emptyNameNotFoundException - if an intermediate context does not existNotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate typeContextNotEmptyException - if the named context is not emptyNamingException - if a naming exception is encounteredContext.destroySubcontext(String)public Context createSubcontext(String name)
throws NamingException Description copied from interface: Context
Creates and binds a new context. See Context.createSubcontext(Name) for details.
createSubcontext in interface Context
name - the name of the context to create; may not be emptyNameAlreadyBoundException - if name is already boundInvalidAttributesException - if creation of the subcontext requires specification of mandatory attributesNamingException - if a naming exception is encounteredpublic Context createSubcontext(Name name)
throws NamingException Description copied from interface: Context
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.
createSubcontext in interface Context
name - the name of the context to create; may not be emptyNameAlreadyBoundException - if name is already boundInvalidAttributesException - if creation of the subcontext requires specification of mandatory attributesNamingException - if a naming exception is encounteredContext.createSubcontext(String), DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes)
public Object lookupLink(String name)
throws NamingException Description copied from interface: Context
Retrieves the named object, following links except for the terminal atomic component of the name. See Context.lookupLink(Name) for details.
lookupLink in interface Context
name - the name of the object to look upname, not following the terminal link (if any)NamingException - if a naming exception is encounteredpublic Object lookupLink(Name name)
throws NamingException Description copied from interface: Context
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.
lookupLink in interface Context
name - the name of the object to look upname, not following the terminal link (if any).NamingException - if a naming exception is encounteredContext.lookupLink(String)public NameParser getNameParser(String name)
throws NamingException Description copied from interface: Context
Retrieves the parser associated with the named context. See Context.getNameParser(Name) for details.
getNameParser in interface Context
name - the name of the context from which to get the parserNamingException - if a naming exception is encounteredpublic NameParser getNameParser(Name name)
throws NamingException Description copied from interface: Context
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).
getNameParser in interface Context
name - the name of the context from which to get the parserNamingException - if a naming exception is encounteredContext.getNameParser(String), CompoundName
public String composeName(String name,
String prefix)
throws NamingException 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 ("").
composeName in interface Context
name - a name relative to this contextprefix - the name of this context relative to one of its ancestorsprefix and name
NamingException - if a naming exception is encounteredpublic Name composeName(Name name,
Name prefix)
throws NamingException 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.
composeName in interface Context
name - a name relative to this contextprefix - the name of this context relative to one of its ancestorsprefix and name
NamingException - if a naming exception is encounteredContext.composeName(String, String)public Object addToEnvironment(String propName,
Object propVal)
throws NamingException Description copied from interface: Context
Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten. See class description for more details on environment properties.
addToEnvironment in interface Context
propName - the name of the environment property to add; may not be nullpropVal - the value of the property to add; may not be nullNamingException - if a naming exception is encounteredContext.getEnvironment(), Context.removeFromEnvironment(String)
public Object removeFromEnvironment(String propName)
throws NamingException Description copied from interface: Context
Removes an environment property from the environment of this context. See class description for more details on environment properties.
removeFromEnvironment in interface Context
propName - the name of the environment property to remove; may not be nullNamingException - if a naming exception is encounteredContext.getEnvironment(), Context.addToEnvironment(String, Object)
public Hashtable<?,?> getEnvironment()
throws NamingException Description copied from interface: Context
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().
getEnvironment in interface Context
NamingException - if a naming exception is encounteredContext.addToEnvironment(String, Object), Context.removeFromEnvironment(String)
public void close()
throws NamingException Description copied from interface: Context
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.
close in interface Context
NamingException - if a naming exception is encounteredpublic String getNameInNamespace()
throws NamingException Description copied from interface: Context
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.
getNameInNamespace in interface Context
OperationNotSupportedException - if the naming system does not have the notion of a full nameNamingException - if a naming exception is encountered
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.