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 ).
| Method from org.apache.naming.core.BaseContext Detail: |
public Object addToEnvironment(String propName,
Object propVal) throws NamingException {
return env.put(propName, propVal);
}
Adds a new environment property to the environment of this context. If
the property already exists, its value is overwritten. |
public void bind(Name name,
Object obj) throws NamingException {
bind(name, obj, null, false);
}
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. |
public void bind(String name,
Object obj) throws NamingException {
bind(string2Name(name), obj, null, false);
}
Binds a name to an object. |
public void close() throws NamingException {
// We don't own the env., but the clone
env.clear();
}
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. |
public Name composeName(Name name,
Name prefix) throws NamingException {
prefix = (Name) prefix.clone();
return prefix.addAll(name);
}
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. |
public String composeName(String name,
String prefix) throws NamingException {
return prefix + "/" + name;
}
Composes the name of this context with a name relative to this context. |
public Context createSubcontext(Name name) throws NamingException {
return createSubcontext(name, null);
}
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. |
public Context createSubcontext(String name) throws NamingException {
return createSubcontext(string2Name(name), null);
}
|
public void destroySubcontext(Name name) throws NamingException {
unbind(name, true);
}
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. |
public void destroySubcontext(String name) throws NamingException {
unbind(string2Name(name), true);
}
Destroys the named context and removes it from the namespace. |
public Hashtable getEnvironment() throws NamingException {
return env;
}
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(). |
public String getNameInNamespace() throws NamingException {
throw new OperationNotSupportedException();
}
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. |
public NameParser getNameParser(Name name) throws NamingException {
while ((!name.isEmpty()) && (name.get(0).length() == 0))
name = name.getSuffix(1);
if (name.isEmpty())
return nameParser;
if (name.size() > 1) {
Object obj = lookup(name.get(0));
if (obj instanceof Context) {
return ((Context) obj).getNameParser(name.getSuffix(1));
} else {
throw new NotContextException(name.toString());
}
}
return nameParser;
}
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). |
public NameParser getNameParser(String name) throws NamingException {
return getNameParser(new CompositeName(name));
}
Retrieves the parser associated with the named context. |
public NamingEnumeration list(String name) throws NamingException {
return list(string2Name(name));
}
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. |
public NamingEnumeration list(Name name) throws NamingException {
return new NamingContextEnumeration(getChildren(), this, false);
}
|
public NamingEnumeration listBindings(Name name) throws NamingException {
return new NamingContextEnumeration(getChildren(), this, true);
}
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. |
public NamingEnumeration listBindings(String name) throws NamingException {
return listBindings(string2Name(name));
}
|
public Object lookup(Name name) throws NamingException {
return lookup(name, true);
}
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). |
public Object lookup(String name) throws NamingException {
return lookup(string2Name(name), true);
}
Retrieves the named object. |
public Object lookupLink(Name name) throws NamingException {
return lookup(name, false);
}
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. |
public Object lookupLink(String name) throws NamingException {
return lookupLink(string2Name(name));
}
Retrieves the named object, following links except for the terminal
atomic component of the name. |
public void rebind(Name name,
Object obj) throws NamingException {
bind(name, obj, null, true);
}
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. |
public void rebind(String name,
Object obj) throws NamingException {
bind(string2Name(name), obj, null, true);
}
Binds a name to an object, overwriting any existing binding. |
public Object removeFromEnvironment(String propName) throws NamingException {
return env.remove(propName);
}
Removes an environment property from the environment of this context. |
public void rename(String oldName,
String newName) throws NamingException {
rename(string2Name(oldName), string2Name(newName));
}
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. |
public void rename(Name oldName,
Name newName) throws NamingException {
// Override if needed
Object value = lookup(oldName, false);
bind(newName, value, null, false);
unbind(oldName, true);
}
|
public NamingEnumeration search(Name name,
String filter,
SearchControls cons) throws NamingException {
return search(name.toString(), filter, cons);
}
Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls. |
public NamingEnumeration search(String name,
String filter,
SearchControls cons) throws NamingException {
throw new OperationNotSupportedException();
}
Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls. |
public NamingEnumeration search(Name name,
String filterExpr,
Object[] filterArgs,
SearchControls cons) throws NamingException {
return search(name.toString(), filterExpr, filterArgs, cons);
}
Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls. |
public NamingEnumeration search(String name,
String filterExpr,
Object[] filterArgs,
SearchControls cons) throws NamingException {
throw new OperationNotSupportedException();
}
Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls. |
public void unbind(Name name) throws NamingException {
unbind(name, false);
}
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. |
public void unbind(String name) throws NamingException {
unbind(string2Name(name), false);
}
|