public class InitialContext extends Objectimplements Context
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). 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:
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() 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.
Context,
NamingManager.setInitialContextFactoryBuilder
| Modifier and Type | Field and 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 |
myProps
The environment associated with this InitialContext.
|
APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES| Modifier | Constructor and Description |
|---|---|
|
InitialContext()
Constructs an initial context.
|
protected |
InitialContext(boolean lazy)
Constructs an initial context with the option of not initializing it.
|
|
InitialContext(Hashtable
Constructs an initial context using the supplied environment.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
addToEnvironment(String
Adds a new environment property to the environment of this context.
|
void |
bind(Name
Binds a name to an object.
|
void |
bind(String
Binds a name to an object.
|
void |
close()
Closes this context.
|
Name |
composeName(Name
Composes the name of this context with a name relative to this context.
|
String |
composeName(String
Composes the name of this context with a name relative to this context.
|
Context |
createSubcontext(Name
Creates and binds a new context.
|
Context |
createSubcontext(String
Creates and binds a new context.
|
void |
destroySubcontext(Name
Destroys the named context and removes it from the namespace.
|
void |
destroySubcontext(String
Destroys the named context and removes it from the namespace.
|
static <T> T |
doLookup(Name
A static method to retrieve the named object.
|
static <T> T |
doLookup(String
A static method to retrieve the named object.
|
protected Context |
getDefaultInitCtx()
Retrieves the initial context by calling
NamingManager.getInitialContext() and cache it in defaultInitCtx.
|
Hashtable |
getEnvironment()
Retrieves the environment in effect for this context.
|
String |
getNameInNamespace()
Retrieves the full name of this context within its own namespace.
|
NameParser |
getNameParser(Name
Retrieves the parser associated with the named context.
|
NameParser |
getNameParser(String
Retrieves the parser associated with the named context.
|
protected Context |
getURLOrDefaultInitCtx(Name
Retrieves a context for resolving
name.
|
protected Context |
getURLOrDefaultInitCtx(String
Retrieves a context for resolving the string name
name.
|
protected void |
init(Hashtable
Initializes the initial context using the supplied environment.
|
NamingEnumeration |
list(Name
Enumerates the names bound in the named context, along with the class names of objects bound to them.
|
NamingEnumeration |
list(String
Enumerates the names bound in the named context, along with the class names of objects bound to them.
|
NamingEnumeration |
listBindings(Name
Enumerates the names bound in the named context, along with the objects bound to them.
|
NamingEnumeration |
listBindings(String
Enumerates the names bound in the named context, along with the objects bound to them.
|
Object |
lookup(Name
Retrieves the named object.
|
Object |
lookup(String
Retrieves the named object.
|
Object |
lookupLink(Name
Retrieves the named object, following links except for the terminal atomic component of the name.
|
Object |
lookupLink(String
Retrieves the named object, following links except for the terminal atomic component of the name.
|
void |
rebind(Name
Binds a name to an object, overwriting any existing binding.
|
void |
rebind(String
Binds a name to an object, overwriting any existing binding.
|
Object |
removeFromEnvironment(String
Removes an environment property from the environment of this context.
|
void |
rename(Name
Binds a new name to the object bound to an old name, and unbinds the old name.
|
void |
rename(String
Binds a new name to the object bound to an old name, and unbinds the old name.
|
void |
unbind(Name
Unbinds the named object.
|
void |
unbind(String
Unbinds the named object.
|
protected Hashtable<Object ,Object > myProps
protected ContextdefaultInitCtx
getDefaultInitCtx()
protected boolean gotDefault
defaultInitCtx.
protected InitialContext(boolean lazy)
throws NamingException
lazy - true means do not initialize the initial context; false is equivalent to calling
new InitialContext()
NamingException - if a naming exception is encountered
init(Hashtable)
public InitialContext()
throws NamingException
NamingException - if a naming exception is encountered
InitialContext(Hashtable)
public InitialContext(Hashtable<? ,?> environment) throws NamingException
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 encountered
protected void init(Hashtable<? ,?> environment) throws NamingException
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 encountered
InitialContext(boolean)
public static <T> T doLookup(Namename) throws NamingException
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 object
name - the name of the object to look up
NamingException - if a naming exception is encountered
doLookup(String),
lookup(Name)
public static <T> T doLookup(Stringname) throws NamingException
doLookup(Name) for details.
T - the type of the returned object
name - the name of the object to look up
NamingException - if a naming exception is encountered
protected ContextgetDefaultInitCtx() throws NamingException
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 ContextgetURLOrDefaultInitCtx(String name) throws NamingException
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 ContextgetURLOrDefaultInitCtx(Name name) throws NamingException
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 Objectlookup(String name) throws NamingException
Context
Context.lookup(Name) for details.
lookup in interface
Context
name - the name of the object to look up
NamingException - if a naming exception is encountered
public Objectlookup(Name name) throws NamingException
Context
lookup in interface
Context
name - the name of the object to look up
NamingException - if a naming exception is encountered
Context.lookup(String) ,
Context.lookupLink(Name)
public void bind(Stringname, Object obj) throws NamingException
Context
Context.bind(Name, Object) for details.
bind in interface
Context
name - the name to bind; may not be empty
obj - the object to bind; possibly null
NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if object did not supply all mandatory attributes
NamingException - if a naming exception is encountered
public void bind(Namename, Object obj) throws NamingException
Context
bind in interface
Context
name - the name to bind; may not be empty
obj - the object to bind; possibly null
NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if object did not supply all mandatory attributes
NamingException - if a naming exception is encountered
Context.bind(String, Object) ,
Context.rebind(Name, Object) ,
DirContext.bind(Name, Object, javax.naming.directory.Attributes)
public void rebind(Stringname, Object obj) throws NamingException
Context
Context.rebind(Name, Object) for details.
rebind in interface
Context
name - the name to bind; may not be empty
obj - the object to bind; possibly null
InvalidAttributesException - if object did not supply all mandatory attributes
NamingException - if a naming exception is encountered
public void rebind(Namename, Object obj) throws NamingException
Context
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 empty
obj - the object to bind; possibly null
InvalidAttributesException - if object did not supply all mandatory attributes
NamingException - if a naming exception is encountered
Context.rebind(String, Object) ,
Context.bind(Name, Object) ,
DirContext.rebind(Name, Object, javax.naming.directory.Attributes) ,
DirContext
public void unbind(Stringname) throws NamingException
Context
Context.unbind(Name) for details.
unbind in interface
Context
name - the name to unbind; may not be empty
NameNotFoundException - if an intermediate context does not exist
NamingException - if a naming exception is encountered
public void unbind(Namename) throws NamingException
Context
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 empty
NameNotFoundException - if an intermediate context does not exist
NamingException - if a naming exception is encountered
Context.unbind(String)
public void rename(StringoldName, String newName) throws NamingException
Context
Context.rename(Name, Name) for details.
rename in interface
Context
oldName - the name of the existing binding; may not be empty
newName - the name of the new binding; may not be empty
NameAlreadyBoundException - if
newName is already bound
NamingException - if a naming exception is encountered
public void rename(NameoldName, Name newName) throws NamingException
Context
rename in interface
Context
oldName - the name of the existing binding; may not be empty
newName - the name of the new binding; may not be empty
NameAlreadyBoundException - if
newName is already bound
NamingException - if a naming exception is encountered
Context.rename(String, String) ,
Context.bind(Name, Object) ,
Context.rebind(Name, Object)
public NamingEnumeration<NameClassPair > list(String name) throws NamingException
Context
Context.list(Name) for details.
list in interface
Context
name - the name of the context to list
NamingException - if a naming exception is encountered
public NamingEnumeration<NameClassPair > list(Name name) throws NamingException
Context
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 list
NamingException - if a naming exception is encountered
Context.list(String) ,
Context.listBindings(Name) ,
NameClassPair
public NamingEnumeration<Binding > listBindings(String name) throws NamingException
Context
Context.listBindings(Name) for details.
listBindings in interface
Context
name - the name of the context to list
NamingException - if a naming exception is encountered
public NamingEnumeration<Binding > listBindings(Name name) throws NamingException
Context
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 list
NamingException - if a naming exception is encountered
Context.listBindings(String) ,
Context.list(Name) ,
Binding
public void destroySubcontext(Stringname) throws NamingException
Context
Context.destroySubcontext(Name) for details.
destroySubcontext in interface
Context
name - the name of the context to be destroyed; may not be empty
NameNotFoundException - if an intermediate context does not exist
NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type
ContextNotEmptyException - if the named context is not empty
NamingException - if a naming exception is encountered
public void destroySubcontext(Namename) throws NamingException
Context
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 empty
NameNotFoundException - if an intermediate context does not exist
NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type
ContextNotEmptyException - if the named context is not empty
NamingException - if a naming exception is encountered
Context.destroySubcontext(String)
public ContextcreateSubcontext(String name) throws NamingException
Context
Context.createSubcontext(Name) for details.
createSubcontext in interface
Context
name - the name of the context to create; may not be empty
NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes
NamingException - if a naming exception is encountered
public ContextcreateSubcontext(Name name) throws NamingException
Context
createSubcontext in interface
Context
name - the name of the context to create; may not be empty
NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes
NamingException - if a naming exception is encountered
Context.createSubcontext(String) ,
DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes)
public ObjectlookupLink(String name) throws NamingException
Context
Context.lookupLink(Name) for details.
lookupLink in interface
Context
name - the name of the object to look up
NamingException - if a naming exception is encountered
public ObjectlookupLink(Name name) throws NamingException
Context
lookupLink in interface
Context
name - the name of the object to look up
NamingException - if a naming exception is encountered
Context.lookupLink(String)
public NameParsergetNameParser(String name) throws NamingException
Context
Context.getNameParser(Name) for details.
getNameParser in interface
Context
name - the name of the context from which to get the parser
NamingException - if a naming exception is encountered
public NameParsergetNameParser(Name name) throws NamingException
Context
getNameParser in interface
Context
name - the name of the context from which to get the parser
NamingException - if a naming exception is encountered
Context.getNameParser(String) ,
CompoundName
public StringcomposeName(String name, String prefix) throws NamingException
composeName in interface
Context
name - a name relative to this context
prefix - the name of this context relative to one of its ancestors
prefix and
name
NamingException - if a naming exception is encountered
public NamecomposeName(Name name, Name prefix) throws NamingException
composeName in interface
Context
name - a name relative to this context
prefix - the name of this context relative to one of its ancestors
prefix and
name
NamingException - if a naming exception is encountered
Context.composeName(String, String)
public ObjectaddToEnvironment(String propName, Object propVal) throws NamingException
Context
addToEnvironment in interface
Context
propName - the name of the environment property to add; may not be null
propVal - the value of the property to add; may not be null
NamingException - if a naming exception is encountered
Context.getEnvironment() ,
Context.removeFromEnvironment(String)
public ObjectremoveFromEnvironment(String propName) throws NamingException
Context
removeFromEnvironment in interface
Context
propName - the name of the environment property to remove; may not be null
NamingException - if a naming exception is encountered
Context.getEnvironment() ,
Context.addToEnvironment(String, Object)
public Hashtable<? ,?> getEnvironment() throws NamingException
Context
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 encountered
Context.addToEnvironment(String, Object) ,
Context.removeFromEnvironment(String)
public void close()
throws NamingException
Context
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 encountered
public StringgetNameInNamespace() throws NamingException
Context
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 name
NamingException - if a naming exception is encountered