|
Apache Tomcat 6.0.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.naming.NamingContext
public class NamingContext
Catalina JNDI Context implementation.
| Field Summary | |
|---|---|
protected java.util.HashMap |
bindings
Bindings in this Context. |
protected java.util.Hashtable |
env
Environment. |
protected java.lang.String |
name
Name of the associated Catalina Context. |
protected static javax.naming.NameParser |
nameParser
Name parser for this context. |
protected StringManager |
sm
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 | |
|---|---|
NamingContext(java.util.Hashtable env,
java.lang.String name)
Builds a naming context using the given environment. |
|
NamingContext(java.util.Hashtable env,
java.lang.String name,
java.util.HashMap bindings)
Builds a naming context using the given environment. |
|
| Method Summary | |
|---|---|
java.lang.Object |
addToEnvironment(java.lang.String propName,
java.lang.Object propVal)
Adds a new environment property to the environment of this context. |
void |
bind(javax.naming.Name name,
java.lang.Object obj)
Binds a name to an object. |
protected void |
bind(javax.naming.Name name,
java.lang.Object obj,
boolean rebind)
Binds a name to an object. |
void |
bind(java.lang.String name,
java.lang.Object obj)
Binds a name to an object. |
protected void |
checkWritable()
Throws a naming exception is Context is not writable. |
void |
close()
Closes this context. |
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. |
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. |
javax.naming.Context |
createSubcontext(javax.naming.Name name)
Creates and binds a new context. |
javax.naming.Context |
createSubcontext(java.lang.String name)
Creates and binds a new context. |
void |
destroySubcontext(javax.naming.Name name)
Destroys the named context and removes it from the namespace. |
void |
destroySubcontext(java.lang.String name)
Destroys the named context and removes it from the namespace. |
java.util.Hashtable |
getEnvironment()
Retrieves the environment in effect for this context. |
java.lang.String |
getNameInNamespace()
Retrieves the full name of this context within its own namespace. |
javax.naming.NameParser |
getNameParser(javax.naming.Name name)
Retrieves the parser associated with the named context. |
javax.naming.NameParser |
getNameParser(java.lang.String name)
Retrieves the parser associated with the named context. |
protected boolean |
isWritable()
Returns true if writing is allowed on this context. |
javax.naming.NamingEnumeration |
list(javax.naming.Name name)
Enumerates the names bound in the named context, along with the class names of objects bound to them. |
javax.naming.NamingEnumeration |
list(java.lang.String name)
Enumerates the names bound in the named context, along with the class names of objects bound to them. |
javax.naming.NamingEnumeration |
listBindings(javax.naming.Name name)
Enumerates the names bound in the named context, along with the objects bound to them. |
javax.naming.NamingEnumeration |
listBindings(java.lang.String name)
Enumerates the names bound in the named context, along with the objects bound to them. |
java.lang.Object |
lookup(javax.naming.Name name)
Retrieves the named object. |
protected java.lang.Object |
lookup(javax.naming.Name name,
boolean resolveLinks)
Retrieves the named object. |
java.lang.Object |
lookup(java.lang.String name)
Retrieves the named object. |
java.lang.Object |
lookupLink(javax.naming.Name name)
Retrieves the named object, following links except for the terminal atomic component of the name. |
java.lang.Object |
lookupLink(java.lang.String name)
Retrieves the named object, following links except for the terminal atomic component of the name. |
void |
rebind(javax.naming.Name name,
java.lang.Object obj)
Binds a name to an object, overwriting any existing binding. |
void |
rebind(java.lang.String name,
java.lang.Object obj)
Binds a name to an object, overwriting any existing binding. |
java.lang.Object |
removeFromEnvironment(java.lang.String propName)
Removes an environment property from the environment of this context. |
void |
rename(javax.naming.Name oldName,
javax.naming.Name newName)
Binds a new name to the object bound to an old name, and unbinds the old name. |
void |
rename(java.lang.String oldName,
java.lang.String newName)
Binds a new name to the object bound to an old name, and unbinds the old name. |
void |
unbind(javax.naming.Name name)
Unbinds the named object. |
void |
unbind(java.lang.String name)
Unbinds the named object. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static final javax.naming.NameParser nameParser
protected java.util.Hashtable env
protected StringManager sm
protected java.util.HashMap bindings
protected java.lang.String name
| Constructor Detail |
|---|
public NamingContext(java.util.Hashtable env,
java.lang.String name)
throws javax.naming.NamingException
javax.naming.NamingException
public NamingContext(java.util.Hashtable env,
java.lang.String name,
java.util.HashMap bindings)
throws javax.naming.NamingException
javax.naming.NamingException| Method Detail |
|---|
public java.lang.Object lookup(javax.naming.Name name)
throws javax.naming.NamingException
lookup in interface javax.naming.Contextname - the name of the object to look up
javax.naming.NamingException - if a naming exception is encountered
public java.lang.Object lookup(java.lang.String name)
throws javax.naming.NamingException
lookup in interface javax.naming.Contextname - the name of the object to look up
javax.naming.NamingException - if a naming exception is encountered
public void bind(javax.naming.Name name,
java.lang.Object obj)
throws javax.naming.NamingException
bind in interface javax.naming.Contextname - the name to bind; may not be emptyobj - the object to bind; possibly null
javax.naming.NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if object did not supply all
mandatory attributes
javax.naming.NamingException - if a naming exception is encountered
public void bind(java.lang.String name,
java.lang.Object obj)
throws javax.naming.NamingException
bind in interface javax.naming.Contextname - the name to bind; may not be emptyobj - the object to bind; possibly null
javax.naming.NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if object did not supply all
mandatory attributes
javax.naming.NamingException - if a naming exception is encountered
public void rebind(javax.naming.Name name,
java.lang.Object obj)
throws javax.naming.NamingException
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 javax.naming.Contextname - the name to bind; may not be emptyobj - the object to bind; possibly null
InvalidAttributesException - if object did not supply all
mandatory attributes
javax.naming.NamingException - if a naming exception is encountered
public void rebind(java.lang.String name,
java.lang.Object obj)
throws javax.naming.NamingException
rebind in interface javax.naming.Contextname - the name to bind; may not be emptyobj - the object to bind; possibly null
InvalidAttributesException - if object did not supply all
mandatory attributes
javax.naming.NamingException - if a naming exception is encountered
public void unbind(javax.naming.Name name)
throws javax.naming.NamingException
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.
unbind in interface javax.naming.Contextname - the name to bind; may not be empty
javax.naming.NameNotFoundException - if an intermediate context does not
exist
javax.naming.NamingException - if a naming exception is encountered
public void unbind(java.lang.String name)
throws javax.naming.NamingException
unbind in interface javax.naming.Contextname - the name to bind; may not be empty
javax.naming.NameNotFoundException - if an intermediate context does not
exist
javax.naming.NamingException - if a naming exception is encountered
public void rename(javax.naming.Name oldName,
javax.naming.Name newName)
throws javax.naming.NamingException
rename in interface javax.naming.ContextoldName - the name of the existing binding; may not be emptynewName - the name of the new binding; may not be empty
javax.naming.NameAlreadyBoundException - if newName is already bound
javax.naming.NamingException - if a naming exception is encountered
public void rename(java.lang.String oldName,
java.lang.String newName)
throws javax.naming.NamingException
rename in interface javax.naming.ContextoldName - the name of the existing binding; may not be emptynewName - the name of the new binding; may not be empty
javax.naming.NameAlreadyBoundException - if newName is already bound
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.NamingEnumeration list(javax.naming.Name name)
throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
list in interface javax.naming.Contextname - the name of the context to list
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.NamingEnumeration list(java.lang.String name)
throws javax.naming.NamingException
list in interface javax.naming.Contextname - the name of the context to list
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.NamingEnumeration listBindings(javax.naming.Name name)
throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
listBindings in interface javax.naming.Contextname - the name of the context to list
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.NamingEnumeration listBindings(java.lang.String name)
throws javax.naming.NamingException
listBindings in interface javax.naming.Contextname - the name of the context to list
javax.naming.NamingException - if a naming exception is encountered
public void destroySubcontext(javax.naming.Name name)
throws javax.naming.NamingException
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 javax.naming.Contextname - the name of the context to be destroyed; may not be empty
javax.naming.NameNotFoundException - if an intermediate context does not
exist
javax.naming.NotContextException - if the name is bound but does not name
a context, or does not name a context of the appropriate type
javax.naming.NamingException
public void destroySubcontext(java.lang.String name)
throws javax.naming.NamingException
destroySubcontext in interface javax.naming.Contextname - the name of the context to be destroyed; may not be empty
javax.naming.NameNotFoundException - if an intermediate context does not
exist
javax.naming.NotContextException - if the name is bound but does not name
a context, or does not name a context of the appropriate type
javax.naming.NamingException
public javax.naming.Context createSubcontext(javax.naming.Name name)
throws javax.naming.NamingException
createSubcontext in interface javax.naming.Contextname - the name of the context to create; may not be empty
javax.naming.NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if creation of the subcontext
requires specification of mandatory attributes
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.Context createSubcontext(java.lang.String name)
throws javax.naming.NamingException
createSubcontext in interface javax.naming.Contextname - the name of the context to create; may not be empty
javax.naming.NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if creation of the subcontext
requires specification of mandatory attributes
javax.naming.NamingException - if a naming exception is encountered
public java.lang.Object lookupLink(javax.naming.Name name)
throws javax.naming.NamingException
lookupLink in interface javax.naming.Contextname - the name of the object to look up
javax.naming.NamingException - if a naming exception is encountered
public java.lang.Object lookupLink(java.lang.String name)
throws javax.naming.NamingException
lookupLink in interface javax.naming.Contextname - the name of the object to look up
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.NameParser getNameParser(javax.naming.Name name)
throws javax.naming.NamingException
getNameParser in interface javax.naming.Contextname - the name of the context from which to get the parser
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.NameParser getNameParser(java.lang.String name)
throws javax.naming.NamingException
getNameParser in interface javax.naming.Contextname - the name of the context from which to get the parser
javax.naming.NamingException - if a naming exception is encountered
public javax.naming.Name composeName(javax.naming.Name name,
javax.naming.Name prefix)
throws javax.naming.NamingException
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.
composeName in interface javax.naming.Contextname - a name relative to this contextprefix - the name of this context relative to one of its ancestors
javax.naming.NamingException - if a naming exception is encountered
public java.lang.String composeName(java.lang.String name,
java.lang.String prefix)
throws javax.naming.NamingException
composeName in interface javax.naming.Contextname - a name relative to this contextprefix - the name of this context relative to one of its ancestors
javax.naming.NamingException - if a naming exception is encountered
public java.lang.Object addToEnvironment(java.lang.String propName,
java.lang.Object propVal)
throws javax.naming.NamingException
addToEnvironment in interface javax.naming.ContextpropName - the name of the environment property to add; may not
be nullpropVal - the value of the property to add; may not be null
javax.naming.NamingException - if a naming exception is encountered
public java.lang.Object removeFromEnvironment(java.lang.String propName)
throws javax.naming.NamingException
removeFromEnvironment in interface javax.naming.ContextpropName - the name of the environment property to remove;
may not be null
javax.naming.NamingException - if a naming exception is encountered
public java.util.Hashtable getEnvironment()
throws javax.naming.NamingException
getEnvironment in interface javax.naming.Contextjavax.naming.NamingException - if a naming exception is encountered
public void close()
throws javax.naming.NamingException
close in interface javax.naming.Contextjavax.naming.NamingException - if a naming exception is encountered
public java.lang.String getNameInNamespace()
throws javax.naming.NamingException
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 javax.naming.Contextjavax.naming.OperationNotSupportedException - if the naming system does
not have the notion of a full name
javax.naming.NamingException - if a naming exception is encountered
protected java.lang.Object lookup(javax.naming.Name name,
boolean resolveLinks)
throws javax.naming.NamingException
name - the name of the object to look upresolveLinks - If true, the links will be resolved
javax.naming.NamingException - if a naming exception is encountered
protected void bind(javax.naming.Name name,
java.lang.Object obj,
boolean rebind)
throws javax.naming.NamingException
name - the name to bind; may not be emptyobj - the object to bind; possibly nullrebind - if true, then perform a rebind (ie, overwrite)
javax.naming.NameAlreadyBoundException - if name is already bound
InvalidAttributesException - if object did not supply all
mandatory attributes
javax.naming.NamingException - if a naming exception is encounteredprotected boolean isWritable()
protected void checkWritable()
throws javax.naming.NamingException
javax.naming.NamingException
|
Apache Tomcat 6.0.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||