Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.naming.resources.BaseDirContext
public abstract class BaseDirContext
extends java.lang.Object
implements DirContext
Field Summary | |
protected int |
|
protected int |
|
protected boolean |
|
protected int |
|
protected String |
|
protected Hashtable |
|
protected NameParser |
|
protected StringManager |
|
Constructor Summary | |
| |
|
Method Summary | |
Object |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Name |
|
String |
|
Context |
|
DirContext |
|
Context |
|
DirContext |
|
void |
|
void |
|
Attributes |
|
Attributes |
|
Attributes |
|
Attributes |
|
int |
|
int |
|
int |
|
String |
|
Hashtable |
|
String |
|
NameParser |
|
NameParser |
|
DirContext |
|
DirContext |
|
DirContext |
|
DirContext |
|
boolean |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
Object |
|
Object |
|
Object |
|
Object |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Object |
|
void |
|
void |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
NamingEnumeration |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected int cacheMaxSize
Max size of resources which will have their content cached.
protected int cacheTTL
Cache TTL.
protected boolean cached
Cached.
protected int debug
The debugging detail level for this component.
protected String docBase
The document base path.
protected Hashtable env
Environment.
protected final NameParser nameParser
Name parser for this context.
public BaseDirContext()
Builds a base directory context.
public BaseDirContext(Hashtable env)
Builds a base directory context using the given environment.
public Object addToEnvironment(String propName, Object propVal) throws NamingException
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 nullpropVal
- the value of the property to add; may not be null
public void allocate()
Allocate resources for this directory context.
public void bind(Name name, Object obj) throws NamingException
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 emptyobj
- the object to bind; possibly null
public void bind(Name name, Object obj, Attributes attrs) throws NamingException
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 emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding
public void bind(String name, Object obj) throws NamingException
Binds a name to an object.
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
public void bind(String name, Object obj, Attributes attrs) throws NamingException
Binds a name to an object, along with associated attributes.
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding
public void close() throws NamingException
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
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 contextprefix
- the name of this context relative to one of its ancestors
- Returns:
- the composition of prefix and name
public String composeName(String name, String prefix) throws NamingException
Composes the name of this context with a name relative to this context.
- Parameters:
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors
- Returns:
- the composition of prefix and name
public Context createSubcontext(Name name) throws NamingException
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
- Returns:
- the newly created context
public DirContext createSubcontext(Name name, Attributes attrs) throws NamingException
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 emptyattrs
- the attributes to associate with the newly created context
- Returns:
- the newly created context
public Context createSubcontext(String name) throws NamingException
Creates and binds a new context.
- Parameters:
name
- the name of the context to create; may not be empty
- Returns:
- the newly created context
public DirContext createSubcontext(String name, Attributes attrs) throws NamingException
Creates and binds a new context, along with associated attributes.
- Parameters:
name
- the name of the context to create; may not be emptyattrs
- the attributes to associate with the newly created context
- Returns:
- the newly created context
public void destroySubcontext(Name name) throws NamingException
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
public void destroySubcontext(String name) throws NamingException
Destroys the named context and removes it from the namespace.
- Parameters:
name
- the name of the context to be destroyed; may not be empty
public Attributes getAttributes(Name name) throws NamingException
Retrieves all of the attributes associated with a named object.
- 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.
public Attributes getAttributes(Name name, String[] attrIds) throws NamingException
Retrieves selected attributes associated with a named object. See the class description regarding attribute models, attribute type names, and operational attributes.
- Parameters:
name
- the name of the object from which to retrieve attributesattrIds
- 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
public Attributes getAttributes(String name) throws NamingException
Retrieves all of the attributes associated with a named object.
- Parameters:
name
- the name of the object from which to retrieve attributes
- Returns:
- the set of attributes associated with name
public Attributes getAttributes(String name, String[] attrIds) throws NamingException
Retrieves selected attributes associated with a named object.
- Parameters:
name
- the name of the object from which to retrieve attributesattrIds
- 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
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() throws NamingException
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().
- Returns:
- the environment of this context; never null
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.
- Returns:
- this context's name in its own namespace; never null
public NameParser getNameParser(Name name) throws NamingException
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
- Returns:
- a name parser that can parse compound names into their atomic components
public NameParser getNameParser(String name) throws NamingException
Retrieves the parser associated with the named context.
- 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
public DirContext getSchema(Name name) throws NamingException
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
- Returns:
- the schema associated with the context; never null
public DirContext getSchema(String name) throws NamingException
Retrieves the schema associated with the named object.
- Parameters:
name
- the name of the object whose schema is to be retrieved
- Returns:
- the schema associated with the context; never null
public DirContext getSchemaClassDefinition(Name name) throws NamingException
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
- Returns:
- the DirContext containing the named object's class definitions; never null
public DirContext getSchemaClassDefinition(String name) throws NamingException
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
- Returns:
- the DirContext containing the named object's class definitions; never null
public boolean isCached()
Is cached ?
public NamingEnumeration list(Name name) throws NamingException
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
- Returns:
- an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
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.
- 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.
public NamingEnumeration listBindings(Name name) throws NamingException
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
- Returns:
- an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
public NamingEnumeration listBindings(String name) throws NamingException
Enumerates the names bound in the named context, along with the objects bound to them.
- 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.
public Object lookup(Name name) throws NamingException
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
- Returns:
- the object bound to name
public Object lookup(String name) throws NamingException
Retrieves the named object.
- Parameters:
name
- the name of the object to look up
- Returns:
- the object bound to name
public Object lookupLink(Name name) throws NamingException
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
- Returns:
- the object bound to name, not following the terminal link (if any).
public Object lookupLink(String name) throws NamingException
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
- Returns:
- the object bound to name, not following the terminal link (if any).
public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException
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 updatedmods
- an ordered sequence of modifications to be performed; may not be null
public void modifyAttributes(Name name, int mod_op, Attributes attrs) throws NamingException
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 updatedmod_op
- the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTEattrs
- the attributes to be used for the modification; may not be null
public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException
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 updatedmods
- an ordered sequence of modifications to be performed; may not be null
public void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException
Modifies the attributes associated with a named object.
- Parameters:
name
- the name of the object whose attributes will be updatedmod_op
- the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTEattrs
- the attributes to be used for the modification; may not be null
public void rebind(Name name, Object obj) throws NamingException
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 emptyobj
- the object to bind; possibly null
public void rebind(Name name, Object obj, Attributes attrs) throws NamingException
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 emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding
public void rebind(String name, Object obj) throws NamingException
Binds a name to an object, overwriting any existing binding.
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
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.
- Parameters:
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the binding
public void release()
Release any resources allocated for this directory context.
public Object removeFromEnvironment(String propName) throws NamingException
Removes an environment property from the environment of this context.
- Parameters:
propName
- the name of the environment property to remove; may not be null
public void rename(Name oldName, Name newName) throws NamingException
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 emptynewName
- the name of the new binding; may not be empty
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.
- Parameters:
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty
public NamingEnumeration search(Name name, Attributes matchingAttributes) throws NamingException
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 searchmatchingAttributes
- 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.
public NamingEnumeration search(Name 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. The search is performed using the default SearchControls settings.
- Parameters:
name
- the name of the context to searchmatchingAttributes
- 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.
public NamingEnumeration search(Name 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.
- Parameters:
name
- the name of the context or object to searchfilterExpr
- 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
public NamingEnumeration search(Name 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.
- Parameters:
name
- the name of the context or object to searchfilter
- the filter expression to use for the search; may not be nullcons
- 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
public NamingEnumeration search(String name, Attributes matchingAttributes) throws NamingException
Searches in a single context for objects that contain a specified set of attributes.
- Parameters:
name
- the name of the context to searchmatchingAttributes
- 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.
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.
- Parameters:
name
- the name of the context to searchmatchingAttributes
- 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.
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.
- Parameters:
name
- the name of the context or object to searchfilterExpr
- 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
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.
- Parameters:
name
- the name of the context or object to searchfilter
- the filter expression to use for the search; may not be nullcons
- 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
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.
- Parameters:
debug
- The new debugging detail level
public void setDocBase(String docBase)
Set the document root for this component.
- Parameters:
docBase
- The new document root
public void unbind(Name name) throws NamingException
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
public void unbind(String name) throws NamingException
Unbinds the named object.
- Parameters:
name
- the name to bind; may not be empty