| java.lang.Object
 org.apache.naming.core.BaseNaming
org.apache.naming.core.BaseContext
All known Subclasses: org.apache.naming.core.BaseDirContext, org.apache.naming.modules.java.SelectorContext,
| BaseContext | | public class BaseContext extends BaseNaming implements Context(Code) | | Base Context implementation. Use it if the source doesn't support attributes.
Implements all JNDI methods with reasonable defaults or UnsuportedOperation.
IMPORTANT: all contexts should use setters/getters for configuration, instead
of the Hashtable. The default constructor will use introspection to configure
and may provide ( via a hook ? ) JMX management on all contexts.
All methods use Name variant. They should expect an arbitrary implementation, but
it's recommended to check if ServerName is used - and take advantage of the
specific features ( MessageBytes, etc ).
author:
Remy Maucherat
author:
Costin Manolache |
| Method Summary | |
| public Object | addToEnvironment(String propName, Object propVal)
Adds a new environment property to the environment of this context. | | public void | bind(Name name, Object obj)
Binds a name to an object. | | public void | bind(String name, Object obj)
Binds a name to an object. | | public void | close()
Closes this context. | | public Name | composeName(Name name, Name prefix)
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. | | public String | composeName(String name, String prefix)
Composes the name of this context with a name relative to this context. | | public Context | createSubcontext(Name name)
Creates and binds a new context. | | public Context | createSubcontext(String name)
| | public void | destroySubcontext(Name name)
Destroys the named context and removes it from the namespace. | | public void | destroySubcontext(String name)
Destroys the named context and removes it from the namespace. | | public Hashtable | getEnvironment()
Retrieves the environment in effect for this context. | | public String | 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. | | public NameParser | getNameParser(Name name)
Retrieves the parser associated with the named context. | | public NameParser | getNameParser(String name)
Retrieves the parser associated with the named context. | | public NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them. | | public NamingEnumeration | list(Name name)
| | public NamingEnumeration | listBindings(Name name)
Enumerates the names bound in the named context, along with the
objects bound to them. | | public NamingEnumeration | listBindings(String name)
| | public Object | lookup(Name name)
Retrieves the named object. | | public Object | lookup(String name)
Retrieves the named object. | | public Object | lookupLink(Name name)
Retrieves the named object, following links except for the terminal
atomic component of the name. | | public Object | lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name. | | public void | rebind(Name name, Object obj)
Binds a name to an object, overwriting any existing binding. | | public void | rebind(String name, Object obj)
Binds a name to an object, overwriting any existing binding. | | public Object | removeFromEnvironment(String propName)
Removes an environment property from the environment of this context. | | public void | rename(String oldName, String newName)
Binds a new name to the object bound to an old name, and unbinds the
old name. | | public void | rename(Name oldName, Name newName)
| | public NamingEnumeration | search(Name name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | public NamingEnumeration | search(String name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | public NamingEnumeration | search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | public NamingEnumeration | search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | public void | unbind(Name name)
Unbinds the named object. | | public void | unbind(String name)
|
| BaseContext | | public BaseContext()(Code) | | |
| addToEnvironment | | public Object addToEnvironment(String propName, Object propVal) throws NamingException(Code) | | Adds a new environment property to the environment of this context. If
the property already exists, its value is overwritten.
Parameters:
propName - the name of the environment property to add; may notbe null
Parameters:
propVal - the value of the property to add; may not be null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| bind | | public void bind(Name name, Object obj) throws NamingException(Code) | | 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 empty
Parameters:
obj - the object to bind; possibly null
exception:
javax.naming.NameAlreadyBoundException - if name is already bound
exception:
javax.naming.NamingException - if a naming exception is encountered |
| close | | public void close() throws NamingException(Code) | | 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.
exception:
javax.naming.NamingException - if a naming exception is encountered |
| composeName | | public Name composeName(Name name, Name prefix) throws NamingException(Code) | | 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.
Parameters:
name - a name relative to this context
Parameters:
prefix - the name of this context relative to one of its ancestors the composition of prefix and name
exception:
javax.naming.NamingException - if a naming exception is encountered |
| composeName | | public String composeName(String name, String prefix) throws NamingException(Code) | | Composes the name of this context with a name relative to this context.
Parameters:
name - a name relative to this context
Parameters:
prefix - the name of this context relative to one of its ancestors the composition of prefix and name
exception:
javax.naming.NamingException - if a naming exception is encountered |
| createSubcontext | | public Context createSubcontext(Name name) throws NamingException(Code) | | 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.
Parameters:
name - the name of the context to create; may not be empty the newly created context
exception:
javax.naming.NameAlreadyBoundException - if name is already bound
exception:
javax.naming.NamingException - if a naming exception is encountered |
| destroySubcontext | | public void destroySubcontext(Name name) throws NamingException(Code) | | 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.
Parameters:
name - the name of the context to be destroyed; may not be empty
exception:
javax.naming.NameNotFoundException - if an intermediate context does notexist
exception:
javax.naming.NotContextException - if the name is bound but does not namea context, or does not name a context of the appropriate type |
| getEnvironment | | public Hashtable getEnvironment() throws NamingException(Code) | | 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().
the environment of this context; never null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| getNameInNamespace | | public String getNameInNamespace() throws NamingException(Code) | | 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.
this context's name in its own namespace; never null
exception:
javax.naming.OperationNotSupportedException - if the naming system doesnot have the notion of a full name
exception:
javax.naming.NamingException - if a naming exception is encountered |
| getNameParser | | public NameParser getNameParser(Name name) throws NamingException(Code) | | 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).
Parameters:
name - the name of the context from which to get the parser a name parser that can parse compound names into their atomiccomponents
exception:
javax.naming.NamingException - if a naming exception is encountered |
| getNameParser | | public NameParser getNameParser(String name) throws NamingException(Code) | | Retrieves the parser associated with the named context.
Parameters:
name - the name of the context from which to get the parser a name parser that can parse compound names into their atomiccomponents
exception:
javax.naming.NamingException - if a naming exception is encountered |
| list | | public NamingEnumeration list(String name) throws NamingException(Code) | | 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.
Parameters:
name - the name of the context to list an enumeration of the names and class names of the bindings inthis context. Each element of the enumeration is of type NameClassPair.
exception:
javax.naming.NamingException - if a naming exception is encountered |
| listBindings | | public NamingEnumeration listBindings(Name name) throws NamingException(Code) | | 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.
Parameters:
name - the name of the context to list an enumeration of the bindings in this context.Each element of the enumeration is of type Binding.
exception:
javax.naming.NamingException - if a naming exception is encountered |
| lookup | | public Object lookup(Name name) throws NamingException(Code) | | 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).
Parameters:
name - the name of the object to look up the object bound to name
exception:
javax.naming.NamingException - if a naming exception is encountered |
| lookupLink | | public Object lookupLink(Name name) throws NamingException(Code) | | 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.
Parameters:
name - the name of the object to look up the object bound to name, not following the terminal link(if any).
exception:
javax.naming.NamingException - if a naming exception is encountered |
| lookupLink | | public Object lookupLink(String name) throws NamingException(Code) | | Retrieves the named object, following links except for the terminal
atomic component of the name.
Parameters:
name - the name of the object to look up the object bound to name, not following the terminal link(if any).
exception:
javax.naming.NamingException - if a naming exception is encountered |
| rebind | | public void rebind(Name name, Object obj) throws NamingException(Code) | | 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.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| rebind | | public void rebind(String name, Object obj) throws NamingException(Code) | | Binds a name to an object, overwriting any existing binding.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| removeFromEnvironment | | public Object removeFromEnvironment(String propName) throws NamingException(Code) | | Removes an environment property from the environment of this context.
Parameters:
propName - the name of the environment property to remove;may not be null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| rename | | public void rename(String oldName, String newName) throws NamingException(Code) | | 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.
Parameters:
oldName - the name of the existing binding; may not be empty
Parameters:
newName - the name of the new binding; may not be empty
exception:
javax.naming.NameAlreadyBoundException - if newName is already bound
exception:
javax.naming.NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(Name name, String filter, SearchControls cons) throws NamingException(Code) | | Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls.
Parameters:
name - the name of the context or object to search
Parameters:
filter - the filter expression to use for the search; may not benull
Parameters:
cons - the search controls that control the search. If null,the default search controls are used (equivalent to(new SearchControls())). an enumeration of SearchResults of the objects that satisfythe filter; never null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(String name, String filter, SearchControls cons) throws NamingException(Code) | | Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls.
Parameters:
name - the name of the context or object to search
Parameters:
filter - the filter expression to use for the search; may not benull
Parameters:
cons - the search controls that control the search. If null,the default search controls are used (equivalent to(new SearchControls())). an enumeration of SearchResults of the objects that satisfythe filter; never null
exception:
javax.naming.NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException(Code) | | Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls.
Parameters:
name - the name of the context or object to search
Parameters:
filterExpr - the filter expression to use for the search.The expression may contain variables of the form "{i}" where i is anonnegative integer. May not be null.
Parameters:
filterArgs - the array of arguments to substitute for thevariables in filterExpr. The value of filterArgs[i] will replace eachoccurrence of "{i}". If null, equivalent to an empty array.
Parameters:
cons - the search controls that control the search. If null, thedefault search controls are used (equivalent to (new SearchControls())). an enumeration of SearchResults of the objects that satisy thefilter; never null
exception:
java.lang.ArrayIndexOutOfBoundsException - if filterExpr contains {i}expressions where i is outside the bounds of the array filterArgs
exception:
javax.naming.NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException(Code) | | Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls.
Parameters:
name - the name of the context or object to search
Parameters:
filterExpr - the filter expression to use for the search.The expression may contain variables of the form "{i}" where i is anonnegative integer. May not be null.
Parameters:
filterArgs - the array of arguments to substitute for thevariables in filterExpr. The value of filterArgs[i] will replace eachoccurrence of "{i}". If null, equivalent to an empty array.
Parameters:
cons - the search controls that control the search. If null, thedefault search controls are used (equivalent to (new SearchControls())). an enumeration of SearchResults of the objects that satisy thefilter; never null
exception:
java.lang.ArrayIndexOutOfBoundsException - if filterExpr contains {i}expressions where i is outside the bounds of the array filterArgs
exception:
javax.naming.NamingException - if a naming exception is encountered |
| unbind | | public void unbind(Name name) throws NamingException(Code) | | 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.
Parameters:
name - the name to bind; may not be empty
exception:
javax.naming.NameNotFoundException - if an intermediate context does notexist
exception:
javax.naming.NamingException - if a naming exception is encountered |
|
|