| Method from org.apache.naming.resources.BaseDirContext 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 allocate() {
; // No action taken by the default implementation
}
Allocate resources for this directory context. |
public void bind(Name name,
Object obj) throws NamingException {
bind(name.toString(), obj);
}
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(name, obj, null);
}
Binds a name to an object. |
public void bind(Name name,
Object obj,
Attributes attrs) throws NamingException {
bind(name.toString(), obj, attrs);
}
Binds a name to an object, along with associated attributes. If attrs
is null, the resulting binding will have the attributes associated
with obj if obj is a DirContext, and no attributes otherwise. If attrs
is non-null, the resulting binding will have attrs as its attributes;
any attributes associated with obj are ignored. |
abstract public void bind(String name,
Object obj,
Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes. |
public void close() throws NamingException {
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.toString());
}
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(name, null);
}
Creates and binds a new context. |
public DirContext createSubcontext(Name name,
Attributes attrs) throws NamingException {
return createSubcontext(name.toString(), attrs);
}
Creates and binds a new context, along with associated attributes.
This method creates a new subcontext with the given name, binds it in
the target context (that named by all but terminal atomic component of
the name), and associates the supplied attributes with the newly
created object. All intermediate and target contexts must already
exist. If attrs is null, this method is equivalent to
Context.createSubcontext(). |
abstract public DirContext createSubcontext(String name,
Attributes attrs) throws NamingException
Creates and binds a new context, along with associated attributes. |
public void destroySubcontext(Name name) throws NamingException {
destroySubcontext(name.toString());
}
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. |
abstract public void destroySubcontext(String name) throws NamingException
Destroys the named context and removes it from the namespace. |
public Attributes getAttributes(Name name) throws NamingException {
return getAttributes(name.toString());
}
Retrieves all of the attributes associated with a named object. |
public Attributes getAttributes(String name) throws NamingException {
return getAttributes(name, null);
}
Retrieves all of the attributes associated with a named object. |
public Attributes getAttributes(Name name,
String[] attrIds) throws NamingException {
return getAttributes(name.toString(), attrIds);
}
Retrieves selected attributes associated with a named object.
See the class description regarding attribute models, attribute type
names, and operational attributes. |
abstract public Attributes getAttributes(String name,
String[] attrIds) throws NamingException
Retrieves selected attributes associated with a named object. |
public int getCacheMaxSize() {
return cacheMaxSize;
}
Return the maximum size of the cache in KB. |
public int getCacheTTL() {
return cacheTTL;
}
|
public String getDocBase() {
// 10 MB
// ------------------------------------------------------------- Properties
return (this.docBase);
}
Return the document root for this component. |
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(). |
abstract public String getNameInNamespace() throws NamingException
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 {
return new NameParserImpl();
}
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 new NameParserImpl();
}
Retrieves the parser associated with the named context. |
public DirContext getSchema(Name name) throws NamingException {
return getSchema(name.toString());
}
Retrieves the schema associated with the named object. The schema
describes rules regarding the structure of the namespace and the
attributes stored within it. The schema specifies what types of
objects can be added to the directory and where they can be added;
what mandatory and optional attributes an object can have. The range
of support for schemas is directory-specific. |
abstract public DirContext getSchema(String name) throws NamingException
Retrieves the schema associated with the named object. |
public DirContext getSchemaClassDefinition(Name name) throws NamingException {
return getSchemaClassDefinition(name.toString());
}
Retrieves a context containing the schema objects of the named
object's class definitions. |
abstract public DirContext getSchemaClassDefinition(String name) throws NamingException
Retrieves a context containing the schema objects of the named
object's class definitions. |
public boolean isCached() {
return cached;
}
|
public NamingEnumeration list(Name name) throws NamingException {
return list(name.toString());
}
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. |
abstract public NamingEnumeration list(String name) throws NamingException
Enumerates the names bound in the named context, along with the class
names of objects bound to them. |
public NamingEnumeration listBindings(Name name) throws NamingException {
return listBindings(name.toString());
}
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. |
abstract public NamingEnumeration listBindings(String name) throws NamingException
Enumerates the names bound in the named context, along with the
objects bound to them. |
public Object lookup(Name name) throws NamingException {
return lookup(name.toString());
}
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). |
abstract public Object lookup(String name) throws NamingException
Retrieves the named object. |
public Object lookupLink(Name name) throws NamingException {
return lookupLink(name.toString());
}
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. |
abstract public Object lookupLink(String name) throws NamingException
Retrieves the named object, following links except for the terminal
atomic component of the name. |
public void modifyAttributes(Name name,
ModificationItem[] mods) throws NamingException {
modifyAttributes(name.toString(), mods);
}
Modifies the attributes associated with a named object using an an
ordered list of modifications. The modifications are performed in the
order specified. Each modification specifies a modification operation
code and an attribute on which to operate. Where possible, the
modifications are performed atomically. |
abstract public void modifyAttributes(String name,
ModificationItem[] mods) throws NamingException
Modifies the attributes associated with a named object using an an
ordered list of modifications. |
public void modifyAttributes(Name name,
int mod_op,
Attributes attrs) throws NamingException {
modifyAttributes(name.toString(), mod_op, attrs);
}
Modifies the attributes associated with a named object. The order of
the modifications is not specified. Where possible, the modifications
are performed atomically. |
abstract public void modifyAttributes(String name,
int mod_op,
Attributes attrs) throws NamingException
Modifies the attributes associated with a named object. |
public void rebind(Name name,
Object obj) throws NamingException {
rebind(name.toString(), obj);
}
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 {
rebind(name, obj, null);
}
Binds a name to an object, overwriting any existing binding. |
public void rebind(Name name,
Object obj,
Attributes attrs) throws NamingException {
rebind(name.toString(), obj, attrs);
}
Binds a name to an object, along with associated attributes,
overwriting any existing binding. If attrs is null and obj is a
DirContext, the attributes from obj are used. If attrs is null and obj
is not a DirContext, any existing attributes associated with the object
already bound in the directory remain unchanged. If attrs is non-null,
any existing attributes associated with the object already bound in
the directory are removed and attrs is associated with the named
object. If obj is a DirContext and attrs is non-null, the attributes
of obj are ignored. |
abstract public void rebind(String name,
Object obj,
Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes,
overwriting any existing binding. |
public void release() {
; // No action taken by the default implementation
}
Release any resources allocated for this directory context. |
public Object removeFromEnvironment(String propName) throws NamingException {
return env.remove(propName);
}
Removes an environment property from the environment of this context. |
public void rename(Name oldName,
Name newName) throws NamingException {
rename(oldName.toString(), newName.toString());
}
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. |
abstract public void rename(String oldName,
String newName) throws NamingException
Binds a new name to the object bound to an old name, and unbinds the
old name. |
public NamingEnumeration search(Name name,
Attributes matchingAttributes) throws NamingException {
return search(name.toString(), matchingAttributes);
}
Searches in a single context for objects that contain a specified set
of attributes. This method returns all the attributes of such objects.
It is equivalent to supplying null as the atributesToReturn parameter
to the method search(Name, Attributes, String[]). |
abstract public NamingEnumeration search(String name,
Attributes matchingAttributes) throws NamingException
Searches in a single context for objects that contain a specified set
of attributes. |
public NamingEnumeration search(Name name,
Attributes matchingAttributes,
String[] attributesToReturn) throws NamingException {
return search(name.toString(), matchingAttributes, attributesToReturn);
}
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes. The search is
performed using the default SearchControls settings. |
abstract public NamingEnumeration search(String name,
Attributes matchingAttributes,
String[] attributesToReturn) throws NamingException
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes. |
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. |
abstract public NamingEnumeration search(String name,
String filter,
SearchControls cons) throws NamingException
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. |
abstract public NamingEnumeration search(String name,
String filterExpr,
Object[] filterArgs,
SearchControls cons) throws NamingException
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 setCacheMaxSize(int cacheMaxSize) {
this.cacheMaxSize = cacheMaxSize;
}
Set the maximum size of the cache in KB. |
public void setCacheTTL(int cacheTTL) {
this.cacheTTL = cacheTTL;
}
|
public void setCached(boolean cached) {
this.cached = cached;
}
|
public void setDocBase(String docBase) {
// Validate the format of the proposed document root
if (docBase == null)
throw new IllegalArgumentException
(sm.getString("resources.null"));
// Change the document root property
this.docBase = docBase;
}
Set the document root for this component. |
public void unbind(Name name) throws NamingException {
unbind(name.toString());
}
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. |
abstract public void unbind(String name) throws NamingException
Unbinds the named object. |