Class NamingContext
- All Implemented Interfaces:
Context
- Author:
- Remy Maucherat
-
Field Summary
Modifier and TypeFieldDescriptionprotected final HashMap<String,
NamingEntry> Bindings in this Context.Environment.protected final String
Name of the associated Catalina Context.protected static final NameParser
Name parser for this context.protected static final StringManager
The string manager for this package.Fields inherited from interface javax.naming.Context
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
-
Constructor Summary
ConstructorDescriptionNamingContext
(Hashtable<String, Object> env, String name) Builds a naming context.NamingContext
(Hashtable<String, Object> env, String name, HashMap<String, NamingEntry> bindings) Builds a naming context. -
Method Summary
Modifier and TypeMethodDescriptionaddToEnvironment
(String propName, Object propVal) Adds a new environment property to the environment of this context.void
Binds a name to an object.void
Binds a name to an object.protected void
Binds a name to an object.protected boolean
Throws a naming exception is Context is not writable.void
close()
Closes this context.composeName
(String name, String prefix) Composes the name of this context with a name relative to this context.composeName
(Name name, Name prefix) Composes the name of this context with a name relative to this context.createSubcontext
(String name) Creates and binds a new context.createSubcontext
(Name name) Creates and binds a new context.void
destroySubcontext
(String name) Destroys the named context and removes it from the namespace.void
destroySubcontext
(Name name) Destroys the named context and removes it from the namespace.Hashtable<?,
?> Retrieves the environment in effect for this context.boolean
Retrieves the full name of this context within its own namespace.getNameParser
(String name) Retrieves the parser associated with the named context.getNameParser
(Name name) Retrieves the parser associated with the named context.protected boolean
Enumerates the names bound in the named context, along with the class names of objects bound to them.Enumerates the names bound in the named context, along with the class names of objects bound to them.listBindings
(String name) Enumerates the names bound in the named context, along with the objects bound to them.listBindings
(Name name) Enumerates the names bound in the named context, along with the objects bound to them.Retrieves the named object.Retrieves the named object.protected Object
Retrieves the named object.lookupLink
(String name) Retrieves the named object, following links except for the terminal atomic component of the name.lookupLink
(Name name) Retrieves the named object, following links except for the terminal atomic component of the name.void
Binds a name to an object, overwriting any existing binding.void
Binds a name to an object, overwriting any existing binding.removeFromEnvironment
(String propName) Removes an environment property from the environment of this context.void
Binds a new name to the object bound to an old name, and unbinds the old name.void
Binds a new name to the object bound to an old name, and unbinds the old name.void
setExceptionOnFailedWrite
(boolean exceptionOnFailedWrite) void
Unbinds the named object.void
Unbinds the named object.
-
Field Details
-
nameParser
Name parser for this context. -
env
Environment. -
sm
The string manager for this package. -
bindings
Bindings in this Context. -
name
Name of the associated Catalina Context.
-
-
Constructor Details
-
NamingContext
Builds a naming context.- Parameters:
env
- The environment to use to construct the naming contextname
- The name of the associated Catalina Context
-
NamingContext
public NamingContext(Hashtable<String, Object> env, String name, HashMap<String, NamingEntry> bindings) Builds a naming context.- Parameters:
env
- The environment to use to construct the naming contextname
- The name of the associated Catalina Contextbindings
- The initial bindings for the naming context
-
-
Method Details
-
getExceptionOnFailedWrite
public boolean getExceptionOnFailedWrite() -
setExceptionOnFailedWrite
public void setExceptionOnFailedWrite(boolean exceptionOnFailedWrite) -
lookup
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).- Specified by:
lookup
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name
- Throws:
NamingException
- if a naming exception is encountered
-
lookup
Retrieves the named object.- Specified by:
lookup
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name
- Throws:
NamingException
- if a naming exception is encountered
-
bind
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.- Specified by:
bind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
bind
Binds a name to an object.- Specified by:
bind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
rebind
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.
- Specified by:
rebind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
InvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
rebind
Binds a name to an object, overwriting any existing binding.- Specified by:
rebind
in interfaceContext
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null- Throws:
InvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
unbind
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.
- Specified by:
unbind
in interfaceContext
- Parameters:
name
- the name to bind; may not be empty- Throws:
NameNotFoundException
- if an intermediate context does not existNamingException
- if a naming exception is encountered
-
unbind
Unbinds the named object.- Specified by:
unbind
in interfaceContext
- Parameters:
name
- the name to bind; may not be empty- Throws:
NameNotFoundException
- if an intermediate context does not existNamingException
- if a naming exception is encountered
-
rename
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.- Specified by:
rename
in interfaceContext
- Parameters:
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty- Throws:
NameAlreadyBoundException
- if newName is already boundNamingException
- if a naming exception is encountered
-
rename
Binds a new name to the object bound to an old name, and unbinds the old name.- Specified by:
rename
in interfaceContext
- Parameters:
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty- Throws:
NameAlreadyBoundException
- if newName is already boundNamingException
- if a naming exception is encountered
-
list
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.
- Specified by:
list
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
- Throws:
NamingException
- if a naming exception is encountered
-
list
Enumerates the names bound in the named context, along with the class names of objects bound to them.- Specified by:
list
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
- Throws:
NamingException
- if a naming exception is encountered
-
listBindings
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.
- Specified by:
listBindings
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
- Throws:
NamingException
- if a naming exception is encountered
-
listBindings
Enumerates the names bound in the named context, along with the objects bound to them.- Specified by:
listBindings
in interfaceContext
- Parameters:
name
- the name of the context to list- Returns:
- an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
- Throws:
NamingException
- if a naming exception is encountered
-
destroySubcontext
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.
- Specified by:
destroySubcontext
in interfaceContext
- Parameters:
name
- the name of the context to be destroyed; may not be empty- Throws:
NameNotFoundException
- 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 typeNamingException
-
destroySubcontext
Destroys the named context and removes it from the namespace.- Specified by:
destroySubcontext
in interfaceContext
- Parameters:
name
- the name of the context to be destroyed; may not be empty- Throws:
NameNotFoundException
- 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 typeNamingException
-
createSubcontext
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.- Specified by:
createSubcontext
in interfaceContext
- Parameters:
name
- the name of the context to create; may not be empty- Returns:
- the newly created context
- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of the sub-context requires specification of mandatory attributesNamingException
- if a naming exception is encountered
-
createSubcontext
Creates and binds a new context.- Specified by:
createSubcontext
in interfaceContext
- Parameters:
name
- the name of the context to create; may not be empty- Returns:
- the newly created context
- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of the sub-context requires specification of mandatory attributesNamingException
- if a naming exception is encountered
-
lookupLink
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.- Specified by:
lookupLink
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name, not following the terminal link (if any).
- Throws:
NamingException
- if a naming exception is encountered
-
lookupLink
Retrieves the named object, following links except for the terminal atomic component of the name.- Specified by:
lookupLink
in interfaceContext
- Parameters:
name
- the name of the object to look up- Returns:
- the object bound to name, not following the terminal link (if any).
- Throws:
NamingException
- if a naming exception is encountered
-
getNameParser
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).- Specified by:
getNameParser
in interfaceContext
- Parameters:
name
- the name of the context from which to get the parser- Returns:
- a name parser that can parse compound names into their atomic components
- Throws:
NamingException
- if a naming exception is encountered
-
getNameParser
Retrieves the parser associated with the named context.- Specified by:
getNameParser
in interfaceContext
- Parameters:
name
- the name of the context from which to get the parser- Returns:
- a name parser that can parse compound names into their atomic components
- Throws:
NamingException
- if a naming exception is encountered
-
composeName
Composes the name of this context with a name relative to this context.Given a name (name) relative to this context, and the name (prefix) of this context relative to one of its ancestors, this method returns the composition of the two names using the syntax appropriate for the naming system(s) involved. That is, if name names an object relative to this context, the result is the name of the same object, but relative to the ancestor context. None of the names may be null.
- Specified by:
composeName
in interfaceContext
- Parameters:
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors- Returns:
- the composition of prefix and name
- Throws:
NamingException
- if a naming exception is encountered
-
composeName
Composes the name of this context with a name relative to this context.- Specified by:
composeName
in interfaceContext
- Parameters:
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors- Returns:
- the composition of prefix and name
-
addToEnvironment
Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.- Specified by:
addToEnvironment
in interfaceContext
- Parameters:
propName
- the name of the environment property to add; may not be nullpropVal
- the value of the property to add; may not be null
-
removeFromEnvironment
Removes an environment property from the environment of this context.- Specified by:
removeFromEnvironment
in interfaceContext
- Parameters:
propName
- the name of the environment property to remove; may not be null
-
getEnvironment
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().- Specified by:
getEnvironment
in interfaceContext
- Returns:
- the environment of this context; never null
-
close
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.- Specified by:
close
in interfaceContext
- Throws:
NamingException
- if a naming exception is encountered
-
getNameInNamespace
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.
- Specified by:
getNameInNamespace
in interfaceContext
- Returns:
- this context's name in its own namespace; never null
- Throws:
OperationNotSupportedException
- if the naming system does not have the notion of a full nameNamingException
- if a naming exception is encountered
-
lookup
Retrieves the named object.- Parameters:
name
- the name of the object to look upresolveLinks
- If true, the links will be resolved- Returns:
- the object bound to name
- Throws:
NamingException
- if a naming exception is encountered
-
bind
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.- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullrebind
- if true, then perform a rebind (ie, overwrite)- Throws:
NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if object did not supply all mandatory attributesNamingException
- if a naming exception is encountered
-
isWritable
protected boolean isWritable()- Returns:
true
if writing is allowed on this context.
-
checkWritable
Throws a naming exception is Context is not writable.- Returns:
true
if the Context is writable- Throws:
NamingException
- if the Context is not writable andexceptionOnFailedWrite
istrue
-