org.apache.naming.resources
public abstract class BaseDirContext extends Object implements DirContext
Version: $Revision: 708123 $ $Date: 2008-10-27 11:03:19 +0100 (Mon, 27 Oct 2008) $
Field Summary | |
---|---|
protected boolean | cached
Cached. |
protected int | cacheMaxSize
Max size of cache for resources. |
protected int | cacheObjectMaxSize
Max size of resources that will be content cached. |
protected int | cacheTTL
Cache TTL. |
protected String | docBase
The document base path. |
protected Hashtable | env
Environment. |
protected NameParser | nameParser
Name parser for this context. |
protected StringManager | sm
The string manager for this package. |
Constructor Summary | |
---|---|
BaseDirContext()
Builds a base directory context. | |
BaseDirContext(Hashtable env)
Builds a base directory context using the given environment. |
Method Summary | |
---|---|
Object | addToEnvironment(String propName, Object propVal)
Adds a new environment property to the environment of this context. |
void | allocate()
Allocate resources for this directory context. |
void | bind(Name name, Object obj)
Binds a name to an object. |
void | bind(String name, Object obj)
Binds a name to an object.
|
void | bind(Name name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes. |
abstract void | bind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes.
|
void | close()
Closes this context. |
Name | composeName(Name name, Name prefix)
Composes the name of this context with a name relative to this context.
|
String | composeName(String name, String prefix)
Composes the name of this context with a name relative to this context.
|
Context | createSubcontext(Name name)
Creates and binds a new context. |
Context | createSubcontext(String name)
Creates and binds a new context.
|
DirContext | createSubcontext(Name name, Attributes attrs)
Creates and binds a new context, along with associated attributes.
|
abstract DirContext | createSubcontext(String name, Attributes attrs)
Creates and binds a new context, along with associated attributes.
|
void | destroySubcontext(Name name)
Destroys the named context and removes it from the namespace. |
abstract void | destroySubcontext(String name)
Destroys the named context and removes it from the namespace.
|
Attributes | getAttributes(Name name)
Retrieves all of the attributes associated with a named object.
|
Attributes | getAttributes(String name)
Retrieves all of the attributes associated with a named object.
|
Attributes | getAttributes(Name name, String[] attrIds)
Retrieves selected attributes associated with a named object.
|
abstract Attributes | getAttributes(String name, String[] attrIds)
Retrieves selected attributes associated with a named object.
|
int | getCacheMaxSize()
Return the maximum size of the cache in KB. |
int | getCacheObjectMaxSize()
Return the maximum size of objects to be cached in KB. |
int | getCacheTTL()
Get cache TTL. |
String | getDocBase()
Return the document root for this component. |
Hashtable | getEnvironment()
Retrieves the environment in effect for this context. |
abstract String | getNameInNamespace()
Retrieves the full name of this context within its own namespace.
|
NameParser | getNameParser(Name name)
Retrieves the parser associated with the named context. |
NameParser | getNameParser(String name)
Retrieves the parser associated with the named context.
|
DirContext | getSchema(Name name)
Retrieves the schema associated with the named object. |
abstract DirContext | getSchema(String name)
Retrieves the schema associated with the named object.
|
DirContext | getSchemaClassDefinition(Name name)
Retrieves a context containing the schema objects of the named
object's class definitions.
|
abstract DirContext | getSchemaClassDefinition(String name)
Retrieves a context containing the schema objects of the named
object's class definitions.
|
boolean | isCached()
Is cached ? |
NamingEnumeration | list(Name name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them. |
abstract NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them.
|
NamingEnumeration | listBindings(Name name)
Enumerates the names bound in the named context, along with the
objects bound to them. |
abstract NamingEnumeration | listBindings(String name)
Enumerates the names bound in the named context, along with the
objects bound to them.
|
Object | lookup(Name name)
Retrieves the named object. |
abstract Object | lookup(String name)
Retrieves the named object.
|
Object | lookupLink(Name name)
Retrieves the named object, following links except for the terminal
atomic component of the name. |
abstract Object | lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name.
|
void | modifyAttributes(Name name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object. |
abstract void | modifyAttributes(String name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object.
|
void | modifyAttributes(Name name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an
ordered list of modifications. |
abstract void | modifyAttributes(String name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an
ordered list of modifications.
|
void | rebind(Name name, Object obj)
Binds a name to an object, overwriting any existing binding. |
void | rebind(String name, Object obj)
Binds a name to an object, overwriting any existing binding.
|
void | rebind(Name name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes,
overwriting any existing binding. |
abstract void | rebind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes,
overwriting any existing binding.
|
void | release()
Release any resources allocated for this directory context. |
Object | removeFromEnvironment(String propName)
Removes an environment property from the environment of this context.
|
void | rename(Name oldName, Name newName)
Binds a new name to the object bound to an old name, and unbinds the
old name. |
abstract void | rename(String oldName, String newName)
Binds a new name to the object bound to an old name, and unbinds the
old name.
|
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 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.
|
NamingEnumeration | search(Name name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes. |
abstract NamingEnumeration | search(String name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes.
|
NamingEnumeration | search(Name name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. |
abstract NamingEnumeration | search(String name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. |
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 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. |
void | setCached(boolean cached)
Set cached. |
void | setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB. |
void | setCacheObjectMaxSize(int cacheObjectMaxSize)
Set the maximum size of objects to be placed the cache in KB. |
void | setCacheTTL(int cacheTTL)
Set cache TTL. |
void | setDocBase(String docBase)
Set the document root for this component.
|
void | unbind(Name name)
Unbinds the named object. |
abstract void | unbind(String name)
Unbinds the named object.
|
Parameters: propName the name of the environment property to add; may not be null propVal the value of the property to add; may not be null
Throws: NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null attrs the attributes to associate with the binding
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if some "mandatory" attributes of the binding are not supplied NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null attrs the attributes to associate with the binding
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if some "mandatory" attributes of the binding are not supplied NamingException if a naming exception is encountered
Throws: NamingException if a naming exception is encountered
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 prefix the name of this context relative to one of its ancestors
Returns: the composition of prefix and name
Throws: NamingException if a naming exception is encountered
Parameters: name a name relative to this context prefix the name of this context relative to one of its ancestors
Returns: the composition of prefix and name
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context to create; may not be empty
Returns: the newly created context
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name of the context to create; may not be empty
Returns: the newly created context
Throws: NameAlreadyBoundException if name is already bound InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name of the context to create; may not be empty attrs the attributes to associate with the newly created context
Returns: the newly created context
Throws: NameAlreadyBoundException if the name is already bound InvalidAttributesException if attrs does not contain all the mandatory attributes required for creation NamingException if a naming exception is encountered
Parameters: name the name of the context to create; may not be empty attrs the attributes to associate with the newly created context
Returns: the newly created context
Throws: NameAlreadyBoundException if the name is already bound InvalidAttributesException if attrs does not contain all the mandatory attributes required for creation NamingException if a naming exception is encountered
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
Throws: NameNotFoundException if an intermediate context does not exist NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type
Parameters: name the name of the context to be destroyed; may not be empty
Throws: NameNotFoundException if an intermediate context does not exist NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type
Parameters: name the name of the object from which to retrieve attributes
Returns: the set of attributes associated with name. Returns an empty attribute set if name has no attributes; never null.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object from which to retrieve attributes
Returns: the set of attributes associated with name
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object from which to retrieve attributes 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
Returns: the requested attributes; never null
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object from which to retrieve attributes 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
Returns: the requested attributes; never null
Throws: NamingException if a naming exception is encountered
Returns: the environment of this context; never null
Throws: NamingException if a naming exception is encountered
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.
Returns: this context's name in its own namespace; never null
Throws: OperationNotSupportedException if the naming system does not have the notion of a full name NamingException if a naming exception is encountered
Parameters: name the name of the context from which to get the parser
Returns: a name parser that can parse compound names into their atomic components
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context from which to get the parser
Returns: a name parser that can parse compound names into their atomic components
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object whose schema is to be retrieved
Returns: the schema associated with the context; never null
Throws: OperationNotSupportedException if schema not supported NamingException if a naming exception is encountered
Parameters: name the name of the object whose schema is to be retrieved
Returns: the schema associated with the context; never null
Throws: OperationNotSupportedException if schema not supported NamingException if a naming exception is encountered
Parameters: name the name of the object whose object class definition is to be retrieved
Returns: the DirContext containing the named object's class definitions; never null
Throws: OperationNotSupportedException if schema not supported NamingException if a naming exception is encountered
Parameters: name the name of the object whose object class definition is to be retrieved
Returns: the DirContext containing the named object's class definitions; never null
Throws: OperationNotSupportedException if schema not supported NamingException if a naming exception is encountered
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
Returns: an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context to list
Returns: an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
Throws: NamingException if a naming exception is encountered
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
Returns: an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context to list
Returns: an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name, not following the terminal link (if any).
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object to look up
Returns: the object bound to name, not following the terminal link (if any).
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the object whose attributes will be updated mod_op the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE attrs the attributes to be used for the modification; may not be null
Throws: AttributeModificationException if the modification cannot be completed successfully NamingException if a naming exception is encountered
Parameters: name the name of the object whose attributes will be updated mod_op the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE attrs the attributes to be used for the modification; may not be null
Throws: AttributeModificationException if the modification cannot be completed successfully NamingException if a naming exception is encountered
Parameters: name the name of the object whose attributes will be updated mods an ordered sequence of modifications to be performed; may not be null
Throws: AttributeModificationException if the modification cannot be completed successfully NamingException if a naming exception is encountered
Parameters: name the name of the object whose attributes will be updated mods an ordered sequence of modifications to be performed; may not be null
Throws: AttributeModificationException if the modification cannot be completed successfully NamingException if a naming exception is encountered
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 obj the object to bind; possibly null
Throws: InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null
Throws: InvalidAttributesException if object did not supply all mandatory attributes NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null attrs the attributes to associate with the binding
Throws: InvalidAttributesException if some "mandatory" attributes of the binding are not supplied NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty obj the object to bind; possibly null attrs the attributes to associate with the binding
Throws: InvalidAttributesException if some "mandatory" attributes of the binding are not supplied NamingException if a naming exception is encountered
Parameters: propName the name of the environment property to remove; may not be null
Throws: NamingException if a naming exception is encountered
Parameters: oldName the name of the existing binding; may not be empty newName the name of the new binding; may not be empty
Throws: NameAlreadyBoundException if newName is already bound NamingException if a naming exception is encountered
Parameters: oldName the name of the existing binding; may not be empty newName the name of the new binding; may not be empty
Throws: NameAlreadyBoundException if newName is already bound NamingException if a naming exception is encountered
Parameters: name the name of the context to search matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned. attributesToReturn the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned.
Returns: 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.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context to search matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned. attributesToReturn the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned.
Returns: 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.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context to search matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned.
Returns: 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.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context to search matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned.
Returns: 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.
Throws: NamingException if a naming exception is encountered
Parameters: name the name of the context or object to search filter the filter expression to use for the search; may not be null cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns: an enumeration of SearchResults of the objects that satisfy the filter; never null
Throws: InvalidSearchFilterException if the search filter specified is not supported or understood by the underlying directory InvalidSearchControlsException if the search controls contain invalid settings NamingException if a naming exception is encountered
Parameters: name the name of the context or object to search filter the filter expression to use for the search; may not be null cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns: an enumeration of SearchResults of the objects that satisfy the filter; never null
Throws: InvalidSearchFilterException if the search filter specified is not supported or understood by the underlying directory InvalidSearchControlsException if the search controls contain invalid settings NamingException if a naming exception is encountered
Parameters: name the name of the context or object to search 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. 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. cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns: an enumeration of SearchResults of the objects that satisy the filter; never null
Throws: ArrayIndexOutOfBoundsException if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs InvalidSearchControlsException if cons contains invalid settings InvalidSearchFilterException if filterExpr with filterArgs represents an invalid search filter NamingException if a naming exception is encountered
Parameters: name the name of the context or object to search 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. 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. cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns: an enumeration of SearchResults of the objects that satisy the filter; never null
Throws: ArrayIndexOutOfBoundsException if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs InvalidSearchControlsException if cons contains invalid settings InvalidSearchFilterException if filterExpr with filterArgs represents an invalid search filter NamingException if a naming exception is encountered
Parameters: docBase The new document root
Throws: IllegalArgumentException if the specified value is not supported by this implementation IllegalArgumentException if this would create a malformed URL
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
Throws: NameNotFoundException if an intermediate context does not exist NamingException if a naming exception is encountered
Parameters: name the name to bind; may not be empty
Throws: NameNotFoundException if an intermediate context does not exist NamingException if a naming exception is encountered