InitialContext (Java SE 15 & JDK 15) (original) (raw)
All Implemented Interfaces:
[Context](Context.html "interface in javax.naming")
Direct Known Subclasses:
[InitialDirContext](directory/InitialDirContext.html "class in javax.naming.directory")
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 anyapplication resource files.
JNDI determines each property's value by merging the values from the following two sources, in order:
- The first occurrence of the property from the constructor's environment parameter and system properties.
- 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 "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 aCompositeName
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() 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 callingNamingManager.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.
Since:
1.3, JNDI 1.1
See Also:
Context, NamingManager.setInitialContextFactoryBuilder
Field Summary
Fields
Modifier and Type | Field | Description |
---|---|---|
protected Context | defaultInitCtx | Field holding the result of calling NamingManager.getInitialContext(). |
protected boolean | gotDefault | Field indicating whether the initial context has been obtained by calling NamingManager.getInitialContext(). |
protected Hashtable<Object,Object> | myProps | The environment associated with this InitialContext. |
Fields declared in interface javax.naming.Context
[APPLET](Context.html#APPLET), [AUTHORITATIVE](Context.html#AUTHORITATIVE), [BATCHSIZE](Context.html#BATCHSIZE), [DNS_URL](Context.html#DNS%5FURL), [INITIAL_CONTEXT_FACTORY](Context.html#INITIAL%5FCONTEXT%5FFACTORY), [LANGUAGE](Context.html#LANGUAGE), [OBJECT_FACTORIES](Context.html#OBJECT%5FFACTORIES), [PROVIDER_URL](Context.html#PROVIDER%5FURL), [REFERRAL](Context.html#REFERRAL), [SECURITY_AUTHENTICATION](Context.html#SECURITY%5FAUTHENTICATION), [SECURITY_CREDENTIALS](Context.html#SECURITY%5FCREDENTIALS), [SECURITY_PRINCIPAL](Context.html#SECURITY%5FPRINCIPAL), [SECURITY_PROTOCOL](Context.html#SECURITY%5FPROTOCOL), [STATE_FACTORIES](Context.html#STATE%5FFACTORIES), [URL_PKG_PREFIXES](Context.html#URL%5FPKG%5FPREFIXES)
Constructor Summary
Constructors
Modifier | Constructor | Description |
---|---|---|
InitialContext() | Constructs an initial context. | |
protected | InitialContext(boolean lazy) | Constructs an initial context with the option of not initializing it. |
InitialContext(Hashtable environment) | Constructs an initial context using the supplied environment. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
String | composeName(String name,String prefix) | Composes the name of this context with a name relative to this context. |
Name | composeName(Name name,Name prefix) | Composes the name of this context with a name relative to this context. |
static T | doLookup(String name) | A static method to retrieve the named object. |
static T | doLookup(Name name) | A static method to retrieve the named object. |
protected Context | getDefaultInitCtx() | Retrieves the initial context by callingNamingManager.getInitialContext() and cache it in defaultInitCtx. |
protected Context | getURLOrDefaultInitCtx(String name) | Retrieves a context for resolving the string name name. |
protected Context | getURLOrDefaultInitCtx(Name name) | Retrieves a context for resolving name. |
protected void | init(Hashtable environment) | Initializes the initial context using the supplied environment. |
Methods declared in class java.lang.Object
[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)
Methods declared in interface javax.naming.Context
[addToEnvironment](Context.html#addToEnvironment%28java.lang.String,java.lang.Object%29), [bind](Context.html#bind%28java.lang.String,java.lang.Object%29), [bind](Context.html#bind%28javax.naming.Name,java.lang.Object%29), [close](Context.html#close%28%29), [createSubcontext](Context.html#createSubcontext%28java.lang.String%29), [createSubcontext](Context.html#createSubcontext%28javax.naming.Name%29), [destroySubcontext](Context.html#destroySubcontext%28java.lang.String%29), [destroySubcontext](Context.html#destroySubcontext%28javax.naming.Name%29), [getEnvironment](Context.html#getEnvironment%28%29), [getNameInNamespace](Context.html#getNameInNamespace%28%29), [getNameParser](Context.html#getNameParser%28java.lang.String%29), [getNameParser](Context.html#getNameParser%28javax.naming.Name%29), [list](Context.html#list%28java.lang.String%29), [list](Context.html#list%28javax.naming.Name%29), [listBindings](Context.html#listBindings%28java.lang.String%29), [listBindings](Context.html#listBindings%28javax.naming.Name%29), [lookup](Context.html#lookup%28java.lang.String%29), [lookup](Context.html#lookup%28javax.naming.Name%29), [lookupLink](Context.html#lookupLink%28java.lang.String%29), [lookupLink](Context.html#lookupLink%28javax.naming.Name%29), [rebind](Context.html#rebind%28java.lang.String,java.lang.Object%29), [rebind](Context.html#rebind%28javax.naming.Name,java.lang.Object%29), [removeFromEnvironment](Context.html#removeFromEnvironment%28java.lang.String%29), [rename](Context.html#rename%28java.lang.String,java.lang.String%29), [rename](Context.html#rename%28javax.naming.Name,javax.naming.Name%29), [unbind](Context.html#unbind%28java.lang.String%29), [unbind](Context.html#unbind%28javax.naming.Name%29)
Field Details
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.
See Also:
Context.addToEnvironment(java.lang.String, java.lang.Object), Context.removeFromEnvironment(java.lang.String), Context.getEnvironment()defaultInitCtx
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.
See Also:
getDefaultInitCtx()gotDefault
protected boolean gotDefault
Field indicating whether the initial context has been obtained by calling NamingManager.getInitialContext(). If true, its result is indefaultInitCtx
.Constructor Details
InitialContext
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 theInitialContext
constructor is called. The subclass's constructor will call this constructor, compute the value of the environment, and then callinit()
before returning.
Parameters:
lazy
- true means do not initialize the initial context; false is equivalent to callingnew InitialContext()
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encountered
Since:
1.3
See Also:
init(Hashtable)InitialContext
Constructs an initial context. No environment properties are supplied. Equivalent to
new InitialContext(null)
.
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encountered
See Also:
InitialContext(Hashtable)InitialContext
Constructs an initial context using the supplied environment. Environment properties are discussed in the class description.
This constructor will not modifyenvironment
or save a reference to it, but may save a clone. Caller should not modify mutable keys and values inenvironment
after it has been passed to the constructor.
Parameters:
environment
- environment used to create the initial context. Null indicates an empty environment.
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encounteredMethod Details
init
Initializes the initial context using the supplied environment. Environment properties are discussed in the class description.
This method will modifyenvironment
and save a reference to it. The caller may no longer modify it.
Parameters:
environment
- environment used to create the initial context. Null indicates an empty environment.
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encountered
Since:
1.3
See Also:
InitialContext(boolean)doLookup
A static method to retrieve the named object. This is a shortcut method equivalent to invoking:
InitialContext ic = new InitialContext(); Object obj = ic.lookup();
Ifname
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).
Type Parameters:
T
- the type of the returned object
Parameters:
name
- the name of the object to look up
Returns:
the object bound toname
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encountered
Since:
1.6
See Also:
doLookup(String), Context.lookup(Name)doLookup
A static method to retrieve the named object. See doLookup(Name) for details.
Type Parameters:
T
- the type of the returned object
Parameters:
name
- the name of the object to look up
Returns:
the object bound toname
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encountered
Since:
1.6getDefaultInitCtx
Retrieves the initial context by calling
NamingManager.getInitialContext()
and cache it in defaultInitCtx. SetgotDefault
so that we know we've tried this before.
Returns:
The non-null cached initial context.
Throws:
[NoInitialContextException](NoInitialContextException.html "class in javax.naming")
- If cannot find an initial context.
[NamingException](NamingException.html "class in javax.naming")
- If a naming exception was encountered.getURLOrDefaultInitCtx
Retrieves a context for resolving the string name
name
. Ifname
name is a URL string, then attempt to find a URL context for it. If none is found, or ifname
is not a URL string, then returngetDefaultInitCtx()
.
See getURLOrDefaultInitCtx(Name) for description of how a subclass should use this method.
Parameters:
name
- The non-null name for which to get the context.
Returns:
A URL context forname
or the cached initial context. The result cannot be null.
Throws:
[NoInitialContextException](NoInitialContextException.html "class in javax.naming")
- If cannot find an initial context.
[NamingException](NamingException.html "class in javax.naming")
- In a naming exception is encountered.
See Also:
NamingManager.getURLContext(java.lang.String, java.util.Hashtable)getURLOrDefaultInitCtx
Retrieves a context for resolving
name
. If the first component ofname
name is a URL string, then attempt to find a URL context for it. If none is found, or if the first component ofname
is not a URL string, then returngetDefaultInitCtx()
.
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, ...);
}Parameters:
name
- The non-null name for which to get the context.
Returns:
A URL context forname
or the cached initial context. The result cannot be null.
Throws:
[NoInitialContextException](NoInitialContextException.html "class in javax.naming")
- If cannot find an initial context.
[NamingException](NamingException.html "class in javax.naming")
- In a naming exception is encountered.
See Also:
NamingManager.getURLContext(java.lang.String, java.util.Hashtable)composeName
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 (""
).
Specified by:
[composeName](Context.html#composeName%28java.lang.String,java.lang.String%29)
in interface[Context](Context.html "interface in javax.naming")
Parameters:
name
- a name relative to this context
prefix
- the name of this context relative to one of its ancestors
Returns:
the composition ofprefix
andname
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encounteredcomposeName
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.
Specified by:
[composeName](Context.html#composeName%28javax.naming.Name,javax.naming.Name%29)
in interface[Context](Context.html "interface in javax.naming")
Parameters:
name
- a name relative to this context
prefix
- the name of this context relative to one of its ancestors
Returns:
the composition ofprefix
andname
Throws:
[NamingException](NamingException.html "class in javax.naming")
- if a naming exception is encountered
See Also:
Context.composeName(String, String)