| java.lang.Object
 org.apache.naming.resources.BaseDirContext
All known Subclasses: org.apache.naming.resources.FileDirContext, org.apache.naming.resources.WARDirContext,
| BaseDirContext | | abstract public class BaseDirContext implements DirContext(Code) | | Directory Context implementation helper class.
author:
Remy Maucherat
version:
$Revision: 1.4 $ $Date: 2004/02/27 14:58:54 $ |
| Method Summary | |
| public Object | addToEnvironment(String propName, Object propVal)
Adds a new environment property to the environment of this context. | | public void | allocate()
Allocate resources for this directory 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 | bind(Name name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes. | | abstract public void | bind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes. | | 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)
Creates and binds a new context. | | public DirContext | createSubcontext(Name name, Attributes attrs)
Creates and binds a new context, along with associated attributes. | | abstract public DirContext | createSubcontext(String name, Attributes attrs)
Creates and binds a new context, along with associated attributes. | | public void | destroySubcontext(Name name)
Destroys the named context and removes it from the namespace. | | abstract public void | destroySubcontext(String name)
Destroys the named context and removes it from the namespace. | | public Attributes | getAttributes(Name name)
Retrieves all of the attributes associated with a named object. | | public Attributes | getAttributes(String name)
Retrieves all of the attributes associated with a named object. | | public Attributes | getAttributes(Name name, String[] attrIds)
Retrieves selected attributes associated with a named object. | | abstract public Attributes | getAttributes(String name, String[] attrIds)
Retrieves selected attributes associated with a named object.
the requested attributes; never null
Parameters:
name - the name of the object from which to retrieve attributes
Parameters:
attrIds - the identifiers of the attributes to retrieve. | | public int | getCacheMaxSize()
Return the maximum size of the cache in KB. | | public int | getCacheTTL()
Get cache TTL. | | public int | getDebug()
Return the debugging detail level for this component. | | public String | getDocBase()
Return the document root for this component. | | public Hashtable | getEnvironment()
Retrieves the environment in effect for this context. | | abstract 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 DirContext | getSchema(Name name)
Retrieves the schema associated with the named object. | | abstract public DirContext | getSchema(String name)
Retrieves the schema associated with the named object. | | public DirContext | getSchemaClassDefinition(Name name)
Retrieves a context containing the schema objects of the named
object's class definitions. | | abstract public DirContext | getSchemaClassDefinition(String name)
Retrieves a context containing the schema objects of the named
object's class definitions. | | public boolean | isCached()
| | public NamingEnumeration | list(Name name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them. | | abstract public NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them.
Parameters:
name - the name of the context to list an enumeration of the names and class names of the bindings in this context. | | public NamingEnumeration | listBindings(Name name)
Enumerates the names bound in the named context, along with the
objects bound to them. | | abstract public NamingEnumeration | listBindings(String name)
Enumerates the names bound in the named context, along with the
objects bound to them.
Parameters:
name - the name of the context to list an enumeration of the bindings in this context. | | public Object | lookup(Name name)
Retrieves the named object. | | abstract 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. | | abstract public Object | lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name. | | public void | modifyAttributes(Name name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object. | | abstract public void | modifyAttributes(String name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object. | | public void | modifyAttributes(Name name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an
ordered list of modifications. | | abstract public void | modifyAttributes(String name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an
ordered list of modifications. | | 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 void | rebind(Name name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes,
overwriting any existing binding. | | abstract public void | rebind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes,
overwriting any existing binding. | | public void | release()
Release any resources allocated for this directory context. | | public Object | removeFromEnvironment(String propName)
Removes an environment property from the environment of this context. | | public void | rename(Name oldName, Name newName)
Binds a new name to the object bound to an old name, and unbinds the
old name. | | abstract 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 NamingEnumeration | search(Name name, Attributes matchingAttributes, String[] attributesToReturn)
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes. | | abstract public NamingEnumeration | search(String name, Attributes matchingAttributes, String[] attributesToReturn)
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes.
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. | | public NamingEnumeration | search(Name name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes. | | abstract public NamingEnumeration | search(String name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes.
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. | | public NamingEnumeration | search(Name name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | abstract 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. | | abstract 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 | setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB. | | public void | setCacheTTL(int cacheTTL)
Set cache TTL. | | public void | setCached(boolean cached)
Set cached. | | public void | setDebug(int debug)
Set the debugging detail level for this component. | | public void | setDocBase(String docBase)
Set the document root for this component. | | public void | unbind(Name name)
Unbinds the named object. | | abstract public void | unbind(String name)
Unbinds the named object. |
| cacheMaxSize | | protected int cacheMaxSize(Code) | | Max size of resources which will have their content cached.
|
| cacheTTL | | protected int cacheTTL(Code) | | Cache TTL.
|
| cached | | protected boolean cached(Code) | | Cached.
|
| debug | | protected int debug(Code) | | The debugging detail level for this component.
|
| docBase | | protected String docBase(Code) | | The document base path.
|
| nameParser | | final protected NameParser nameParser(Code) | | Name parser for this context.
|
| BaseDirContext | | public BaseDirContext()(Code) | | Builds a base directory context.
|
| BaseDirContext | | public BaseDirContext(Hashtable env)(Code) | | Builds a base directory context using the given environment.
|
| 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 not be null
Parameters:
propVal - the value of the property to add; may not be null
exception:
NamingException - if a naming exception is encountered |
| allocate | | public void allocate()(Code) | | Allocate resources for this directory context.
|
| 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:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if object did not supply all mandatory attributes
exception:
NamingException - if a naming exception is encountered |
| bind | | public void bind(String name, Object obj) throws NamingException(Code) | | Binds a name to an object.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
exception:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if object did not supply all mandatory attributes
exception:
NamingException - if a naming exception is encountered |
| bind | | public void bind(Name name, Object obj, Attributes attrs) throws NamingException(Code) | | 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.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
Parameters:
attrs - the attributes to associate with the binding
exception:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
exception:
NamingException - if a naming exception is encountered |
| bind | | abstract public void bind(String name, Object obj, Attributes attrs) throws NamingException(Code) | | Binds a name to an object, along with associated attributes.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
Parameters:
attrs - the attributes to associate with the binding
exception:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
exception:
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:
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:
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:
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:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes
exception:
NamingException - if a naming exception is encountered |
| createSubcontext | | public Context createSubcontext(String name) throws NamingException(Code) | | Creates and binds a new context.
Parameters:
name - the name of the context to create; may not be empty the newly created context
exception:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if creation of the subcontext requires specification of mandatory attributes
exception:
NamingException - if a naming exception is encountered |
| createSubcontext | | public DirContext createSubcontext(Name name, Attributes attrs) throws NamingException(Code) | | 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().
Parameters:
name - the name of the context to create; may not be empty
Parameters:
attrs - the attributes to associate with the newly created context the newly created context
exception:
NameAlreadyBoundException - if the name is already bound
exception:
InvalidAttributesException - if attrs does not contain all the mandatory attributes required for creation
exception:
NamingException - if a naming exception is encountered |
| createSubcontext | | abstract public DirContext createSubcontext(String name, Attributes attrs) throws NamingException(Code) | | Creates and binds a new context, along with associated attributes.
Parameters:
name - the name of the context to create; may not be empty
Parameters:
attrs - the attributes to associate with the newly created context the newly created context
exception:
NameAlreadyBoundException - if the name is already bound
exception:
InvalidAttributesException - if attrs does not contain all the mandatory attributes required for creation
exception:
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:
NameNotFoundException - if an intermediate context does not exist
exception:
NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type |
| destroySubcontext | | abstract public void destroySubcontext(String name) throws NamingException(Code) | | Destroys the named context and removes it from the namespace.
Parameters:
name - the name of the context to be destroyed; may not be empty
exception:
NameNotFoundException - if an intermediate context does not exist
exception:
NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type |
| getAttributes | | public Attributes getAttributes(Name name) throws NamingException(Code) | | Retrieves all of the attributes associated with a named object.
the set of attributes associated with name. Returns an empty attribute set if name has no attributes; never null.
Parameters:
name - the name of the object from which to retrieve attributes
exception:
NamingException - if a naming exception is encountered |
| getAttributes | | public Attributes getAttributes(String name) throws NamingException(Code) | | Retrieves all of the attributes associated with a named object.
the set of attributes associated with name
Parameters:
name - the name of the object from which to retrieve attributes
exception:
NamingException - if a naming exception is encountered |
| getAttributes | | public Attributes getAttributes(Name name, String[] attrIds) throws NamingException(Code) | | Retrieves selected attributes associated with a named object.
See the class description regarding attribute models, attribute type
names, and operational attributes.
the requested attributes; never null
Parameters:
name - the name of the object from which to retrieve attributes
Parameters:
attrIds - the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved
exception:
NamingException - if a naming exception is encountered |
| getAttributes | | abstract public Attributes getAttributes(String name, String[] attrIds) throws NamingException(Code) | | Retrieves selected attributes associated with a named object.
the requested attributes; never null
Parameters:
name - the name of the object from which to retrieve attributes
Parameters:
attrIds - the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved
exception:
NamingException - if a naming exception is encountered |
| getCacheMaxSize | | public int getCacheMaxSize()(Code) | | Return the maximum size of the cache in KB.
|
| getCacheTTL | | public int getCacheTTL()(Code) | | Get cache TTL.
|
| getDebug | | public int getDebug()(Code) | | Return the debugging detail level for this component.
|
| getDocBase | | public String getDocBase()(Code) | | Return the document root for this component.
|
| 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:
NamingException - if a naming exception is encountered |
| getNameInNamespace | | abstract 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:
OperationNotSupportedException - if the naming system does not have the notion of a full name
exception:
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 atomic components
exception:
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 atomic components
exception:
NamingException - if a naming exception is encountered |
| getSchema | | public DirContext getSchema(Name name) throws NamingException(Code) | | 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.
Parameters:
name - the name of the object whose schema is to be retrieved the schema associated with the context; never null
exception:
OperationNotSupportedException - if schema not supported
exception:
NamingException - if a naming exception is encountered |
| getSchema | | abstract public DirContext getSchema(String name) throws NamingException(Code) | | Retrieves the schema associated with the named object.
Parameters:
name - the name of the object whose schema is to be retrieved the schema associated with the context; never null
exception:
OperationNotSupportedException - if schema not supported
exception:
NamingException - if a naming exception is encountered |
| getSchemaClassDefinition | | public DirContext getSchemaClassDefinition(Name name) throws NamingException(Code) | | Retrieves a context containing the schema objects of the named
object's class definitions.
Parameters:
name - the name of the object whose object class definition is to be retrieved the DirContext containing the named object's class definitions; never null
exception:
OperationNotSupportedException - if schema not supported
exception:
NamingException - if a naming exception is encountered |
| getSchemaClassDefinition | | abstract public DirContext getSchemaClassDefinition(String name) throws NamingException(Code) | | Retrieves a context containing the schema objects of the named
object's class definitions.
Parameters:
name - the name of the object whose object class definition is to be retrieved the DirContext containing the named object's class definitions; never null
exception:
OperationNotSupportedException - if schema not supported
exception:
NamingException - if a naming exception is encountered |
| isCached | | public boolean isCached()(Code) | | Is cached ?
|
| list | | public NamingEnumeration list(Name 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 in this context. Each element of the enumeration is of type NameClassPair.
exception:
NamingException - if a naming exception is encountered |
| list | | abstract 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.
Parameters:
name - the name of the context to list an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
exception:
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:
NamingException - if a naming exception is encountered |
| listBindings | | abstract public NamingEnumeration listBindings(String name) throws NamingException(Code) | | Enumerates the names bound in the named context, along with the
objects bound to them.
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:
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:
NamingException - if a naming exception is encountered |
| lookup | | abstract public Object lookup(String name) throws NamingException(Code) | | Retrieves the named object.
Parameters:
name - the name of the object to look up the object bound to name
exception:
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:
NamingException - if a naming exception is encountered |
| lookupLink | | abstract 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:
NamingException - if a naming exception is encountered |
| modifyAttributes | | public void modifyAttributes(Name name, int mod_op, Attributes attrs) throws NamingException(Code) | | Modifies the attributes associated with a named object. The order of
the modifications is not specified. Where possible, the modifications
are performed atomically.
Parameters:
name - the name of the object whose attributes will be updated
Parameters:
mod_op - the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE
Parameters:
attrs - the attributes to be used for the modification; may not be null
exception:
AttributeModificationException - if the modification cannot becompleted successfully
exception:
NamingException - if a naming exception is encountered |
| modifyAttributes | | abstract public void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException(Code) | | Modifies the attributes associated with a named object.
Parameters:
name - the name of the object whose attributes will be updated
Parameters:
mod_op - the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE
Parameters:
attrs - the attributes to be used for the modification; may not be null
exception:
AttributeModificationException - if the modification cannot becompleted successfully
exception:
NamingException - if a naming exception is encountered |
| modifyAttributes | | public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException(Code) | | 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.
Parameters:
name - the name of the object whose attributes will be updated
Parameters:
mods - an ordered sequence of modifications to be performed; may not be null
exception:
AttributeModificationException - if the modification cannot becompleted successfully
exception:
NamingException - if a naming exception is encountered |
| modifyAttributes | | abstract public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException(Code) | | Modifies the attributes associated with a named object using an an
ordered list of modifications.
Parameters:
name - the name of the object whose attributes will be updated
Parameters:
mods - an ordered sequence of modifications to be performed; may not be null
exception:
AttributeModificationException - if the modification cannot becompleted successfully
exception:
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:
InvalidAttributesException - if object did not supply all mandatory attributes
exception:
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:
InvalidAttributesException - if object did not supply all mandatory attributes
exception:
NamingException - if a naming exception is encountered |
| rebind | | public void rebind(Name name, Object obj, Attributes attrs) throws NamingException(Code) | | 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.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
Parameters:
attrs - the attributes to associate with the binding
exception:
InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
exception:
NamingException - if a naming exception is encountered |
| rebind | | abstract public void rebind(String name, Object obj, Attributes attrs) throws NamingException(Code) | | Binds a name to an object, along with associated attributes,
overwriting any existing binding.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
Parameters:
attrs - the attributes to associate with the binding
exception:
InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
exception:
NamingException - if a naming exception is encountered |
| release | | public void release()(Code) | | Release any resources allocated for this directory context.
|
| 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:
NamingException - if a naming exception is encountered |
| rename | | public void rename(Name oldName, Name 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:
NameAlreadyBoundException - if newName is already bound
exception:
NamingException - if a naming exception is encountered |
| rename | | abstract 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.
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:
NameAlreadyBoundException - if newName is already bound
exception:
NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(Name name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException(Code) | | 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.
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. If empty or null, all objects in the target context are returned.
Parameters:
attributesToReturn - the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned. a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
exception:
NamingException - if a naming exception is encountered |
| search | | abstract public NamingEnumeration search(String name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException(Code) | | Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes.
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. If empty or null, all objects in the target context are returned.
Parameters:
attributesToReturn - the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned. a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
exception:
NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(Name name, Attributes matchingAttributes) throws NamingException(Code) | | 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[]).
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. If empty or null, all objects in the target context are returned. a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
exception:
NamingException - if a naming exception is encountered |
| search | | abstract public NamingEnumeration search(String name, Attributes matchingAttributes) throws NamingException(Code) | | Searches in a single context for objects that contain a specified set
of attributes.
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. If empty or null, all objects in the target context are returned. a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
exception:
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 be null
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 satisfy the filter; never null
exception:
InvalidSearchFilterException - if the search filter specified is not supported or understood by the underlying directory
exception:
InvalidSearchControlsException - if the search controls contain invalid settings
exception:
NamingException - if a naming exception is encountered |
| search | | abstract 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 be null
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 satisfy the filter; never null
exception:
InvalidSearchFilterException - if the search filter specified is not supported or understood by the underlying directory
exception:
InvalidSearchControlsException - if the search controls contain invalid settings
exception:
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 a nonnegative integer. May not be null.
Parameters:
filterArgs - the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array.
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 satisy the filter; never null
exception:
ArrayIndexOutOfBoundsException - if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs
exception:
InvalidSearchControlsException - if cons contains invalid settings
exception:
InvalidSearchFilterException - if filterExpr with filterArgs represents an invalid search filter
exception:
NamingException - if a naming exception is encountered |
| search | | abstract 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 a nonnegative integer. May not be null.
Parameters:
filterArgs - the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array.
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 satisy the filter; never null
exception:
ArrayIndexOutOfBoundsException - if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs
exception:
InvalidSearchControlsException - if cons contains invalid settings
exception:
InvalidSearchFilterException - if filterExpr with filterArgs represents an invalid search filter
exception:
NamingException - if a naming exception is encountered |
| setCacheMaxSize | | public void setCacheMaxSize(int cacheMaxSize)(Code) | | Set the maximum size of the cache in KB.
|
| setCacheTTL | | public void setCacheTTL(int cacheTTL)(Code) | | Set cache TTL.
|
| setCached | | public void setCached(boolean cached)(Code) | | Set cached.
|
| setDebug | | public void setDebug(int debug)(Code) | | Set the debugging detail level for this component.
Parameters:
debug - The new debugging detail level |
| setDocBase | | public void setDocBase(String docBase)(Code) | | Set the document root for this component.
Parameters:
docBase - The new document root
exception:
IllegalArgumentException - if the specified value is notsupported by this implementation
exception:
IllegalArgumentException - if this would create amalformed URL |
| 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:
NameNotFoundException - if an intermediate context does not exist
exception:
NamingException - if a naming exception is encountered |
| unbind | | abstract public void unbind(String name) throws NamingException(Code) | | Unbinds the named object.
Parameters:
name - the name to bind; may not be empty
exception:
NameNotFoundException - if an intermediate context does not exist
exception:
NamingException - if a naming exception is encountered |
|
|