File	Doc	Category	Size	Date	Package
BaseDirContext.java	API Doc	Glassfish v2 API	47716	Fri May 04 22:33:00 BST 2007	org.apache.naming.resources

BaseDirContext

• java.lang.Object

Fields Summary
protected int	debug The debugging detail level for this component.
protected String	docBase The document base path.
protected Hashtable	env Environment.
protected org.apache.naming.StringManager	sm The string manager for this package.
protected final NameParser	nameParser Name parser for this context.
protected boolean	cached Cached.
protected int	cacheTTL Cache TTL.
protected int	cacheMaxSize Max size of resources which will have their content cached.

Constructors Summary
public BaseDirContext() Builds a base directory context. this.env = new Hashtable();
public BaseDirContext(Hashtable env) Builds a base directory context using the given environment. this.env = env;

Methods Summary
public java.lang.Object	addToEnvironment(java.lang.String propName, java.lang.Object propVal) Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten. param propName the name of the environment property to add; may not be null param propVal the value of the property to add; may not be null exception NamingException if a naming exception is encountered return env.put(propName, propVal);
public void	allocate() Allocate resources for this directory context. ; // No action taken by the default implementation
public void	bind(javax.naming.Name name, java.lang.Object obj) Binds a name to an object. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist. param name the name to bind; may not be empty param 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(name.toString(), obj);
public void	bind(java.lang.String name, java.lang.Object obj) Binds a name to an object. param name the name to bind; may not be empty param 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(name, obj, null);
public void	bind(javax.naming.Name name, java.lang.Object obj, javax.naming.directory.Attributes attrs) Binds a name to an object, along with associated attributes. If attrs is null, the resulting binding will have the attributes associated with obj if obj is a DirContext, and no attributes otherwise. If attrs is non-null, the resulting binding will have attrs as its attributes; any attributes associated with obj are ignored. param name the name to bind; may not be empty param obj the object to bind; possibly null param 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(name.toString(), obj, attrs);
public abstract void	bind(java.lang.String name, java.lang.Object obj, javax.naming.directory.Attributes attrs) Binds a name to an object, along with associated attributes. param name the name to bind; may not be empty param obj the object to bind; possibly null param 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
public void	close() 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 env.clear();
public javax.naming.Name	composeName(javax.naming.Name name, javax.naming.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. 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. param name a name relative to this context param prefix the name of this context relative to one of its ancestors return the composition of prefix and name exception NamingException if a naming exception is encountered prefix = (Name) prefix.clone(); return prefix.addAll(name);
public java.lang.String	composeName(java.lang.String name, java.lang.String prefix) Composes the name of this context with a name relative to this context. param name a name relative to this context param prefix the name of this context relative to one of its ancestors return the composition of prefix and name exception NamingException if a naming exception is encountered return prefix + "/" + name;
public javax.naming.Context	createSubcontext(javax.naming.Name name) 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. param name the name of the context to create; may not be empty return 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 return createSubcontext(name.toString());
public javax.naming.Context	createSubcontext(java.lang.String name) Creates and binds a new context. param name the name of the context to create; may not be empty return 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 return createSubcontext(name, null);
public javax.naming.directory.DirContext	createSubcontext(javax.naming.Name name, javax.naming.directory.Attributes attrs) Creates and binds a new context, along with associated attributes. This method creates a new subcontext with the given name, binds it in the target context (that named by all but terminal atomic component of the name), and associates the supplied attributes with the newly created object. All intermediate and target contexts must already exist. If attrs is null, this method is equivalent to Context.createSubcontext(). param name the name of the context to create; may not be empty param attrs the attributes to associate with the newly created context return 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 return createSubcontext(name.toString(), attrs);
public abstract javax.naming.directory.DirContext	createSubcontext(java.lang.String name, javax.naming.directory.Attributes attrs) Creates and binds a new context, along with associated attributes. param name the name of the context to create; may not be empty param attrs the attributes to associate with the newly created context return 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
public void	destroySubcontext(javax.naming.Name name) 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. param 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(name.toString());
public abstract void	destroySubcontext(java.lang.String name) Destroys the named context and removes it from the namespace. param 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
public javax.naming.directory.Attributes	getAttributes(javax.naming.Name name) Retrieves all of the attributes associated with a named object. return the set of attributes associated with name. Returns an empty attribute set if name has no attributes; never null. param name the name of the object from which to retrieve attributes exception NamingException if a naming exception is encountered return getAttributes(name.toString());
public javax.naming.directory.Attributes	getAttributes(java.lang.String name) Retrieves all of the attributes associated with a named object. return the set of attributes associated with name param name the name of the object from which to retrieve attributes exception NamingException if a naming exception is encountered return getAttributes(name, null);
public javax.naming.directory.Attributes	getAttributes(javax.naming.Name name, java.lang.String[] attrIds) Retrieves selected attributes associated with a named object. See the class description regarding attribute models, attribute type names, and operational attributes. return the requested attributes; never null param name the name of the object from which to retrieve attributes param 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 return getAttributes(name.toString(), attrIds);
public abstract javax.naming.directory.Attributes	getAttributes(java.lang.String name, java.lang.String[] attrIds) Retrieves selected attributes associated with a named object. return the requested attributes; never null param name the name of the object from which to retrieve attributes param 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
public int	getCacheMaxSize() Return the maximum size of the cache in KB. return cacheMaxSize;
public int	getCacheTTL() Get cache TTL. return cacheTTL;
public int	getDebug() Return the debugging detail level for this component. // 10 MB // ------------------------------------------------------------- Properties return (this.debug);
public java.lang.String	getDocBase() Return the document root for this component. return (this.docBase);
public java.util.Hashtable	getEnvironment() 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(). return the environment of this context; never null exception NamingException if a naming exception is encountered return env;
public abstract java.lang.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. 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. return 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
public javax.naming.NameParser	getNameParser(javax.naming.Name name) 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). param name the name of the context from which to get the parser return a name parser that can parse compound names into their atomic components exception NamingException if a naming exception is encountered return new NameParserImpl();
public javax.naming.NameParser	getNameParser(java.lang.String name) Retrieves the parser associated with the named context. param name the name of the context from which to get the parser return a name parser that can parse compound names into their atomic components exception NamingException if a naming exception is encountered return new NameParserImpl();
public javax.naming.directory.DirContext	getSchema(javax.naming.Name name) 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. param name the name of the object whose schema is to be retrieved return the schema associated with the context; never null exception OperationNotSupportedException if schema not supported exception NamingException if a naming exception is encountered return getSchema(name.toString());
public abstract javax.naming.directory.DirContext	getSchema(java.lang.String name) Retrieves the schema associated with the named object. param name the name of the object whose schema is to be retrieved return the schema associated with the context; never null exception OperationNotSupportedException if schema not supported exception NamingException if a naming exception is encountered
public javax.naming.directory.DirContext	getSchemaClassDefinition(javax.naming.Name name) Retrieves a context containing the schema objects of the named object's class definitions. param name the name of the object whose object class definition is to be retrieved return 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 return getSchemaClassDefinition(name.toString());
public abstract javax.naming.directory.DirContext	getSchemaClassDefinition(java.lang.String name) Retrieves a context containing the schema objects of the named object's class definitions. param name the name of the object whose object class definition is to be retrieved return 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
public boolean	isCached() Is cached ? return cached;
public javax.naming.NamingEnumeration	list(javax.naming.Name name) Enumerates the names bound in the named context, along with the class names of objects bound to them. The contents of any subcontexts are not included. If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined. param name the name of the context to list return 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 return list(name.toString());
public abstract javax.naming.NamingEnumeration	list(java.lang.String name) Enumerates the names bound in the named context, along with the class names of objects bound to them. param name the name of the context to list return 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
public javax.naming.NamingEnumeration	listBindings(javax.naming.Name name) 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. param name the name of the context to list return 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 return listBindings(name.toString());
public abstract javax.naming.NamingEnumeration	listBindings(java.lang.String name) Enumerates the names bound in the named context, along with the objects bound to them. param name the name of the context to list return 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
public java.lang.Object	lookup(javax.naming.Name name) 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). param name the name of the object to look up return the object bound to name exception NamingException if a naming exception is encountered return lookup(name.toString());
public abstract java.lang.Object	lookup(java.lang.String name) Retrieves the named object. param name the name of the object to look up return the object bound to name exception NamingException if a naming exception is encountered
public java.lang.Object	lookupLink(javax.naming.Name name) 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. param name the name of the object to look up return the object bound to name, not following the terminal link (if any). exception NamingException if a naming exception is encountered return lookupLink(name.toString());
public abstract java.lang.Object	lookupLink(java.lang.String name) Retrieves the named object, following links except for the terminal atomic component of the name. param name the name of the object to look up return the object bound to name, not following the terminal link (if any). exception NamingException if a naming exception is encountered
public void	modifyAttributes(javax.naming.Name name, int mod_op, javax.naming.directory.Attributes attrs) Modifies the attributes associated with a named object. The order of the modifications is not specified. Where possible, the modifications are performed atomically. param name the name of the object whose attributes will be updated param mod_op the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE param attrs the attributes to be used for the modification; may not be null exception AttributeModificationException if the modification cannot be completed successfully exception NamingException if a naming exception is encountered modifyAttributes(name.toString(), mod_op, attrs);
public abstract void	modifyAttributes(java.lang.String name, int mod_op, javax.naming.directory.Attributes attrs) Modifies the attributes associated with a named object. param name the name of the object whose attributes will be updated param mod_op the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE param attrs the attributes to be used for the modification; may not be null exception AttributeModificationException if the modification cannot be completed successfully exception NamingException if a naming exception is encountered
public void	modifyAttributes(javax.naming.Name name, javax.naming.directory.ModificationItem[] mods) Modifies the attributes associated with a named object using an an ordered list of modifications. The modifications are performed in the order specified. Each modification specifies a modification operation code and an attribute on which to operate. Where possible, the modifications are performed atomically. param name the name of the object whose attributes will be updated param mods an ordered sequence of modifications to be performed; may not be null exception AttributeModificationException if the modification cannot be completed successfully exception NamingException if a naming exception is encountered modifyAttributes(name.toString(), mods);
public abstract void	modifyAttributes(java.lang.String name, javax.naming.directory.ModificationItem[] mods) Modifies the attributes associated with a named object using an an ordered list of modifications. param name the name of the object whose attributes will be updated param mods an ordered sequence of modifications to be performed; may not be null exception AttributeModificationException if the modification cannot be completed successfully exception NamingException if a naming exception is encountered
public void	rebind(javax.naming.Name name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist. If the object is a DirContext, any existing attributes associated with the name are replaced with those of the object. Otherwise, any existing attributes associated with the name remain unchanged. param name the name to bind; may not be empty param 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(name.toString(), obj);
public void	rebind(java.lang.String name, java.lang.Object obj) Binds a name to an object, overwriting any existing binding. param name the name to bind; may not be empty param 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(name, obj, null);
public void	rebind(javax.naming.Name name, java.lang.Object obj, javax.naming.directory.Attributes attrs) Binds a name to an object, along with associated attributes, overwriting any existing binding. If attrs is null and obj is a DirContext, the attributes from obj are used. If attrs is null and obj is not a DirContext, any existing attributes associated with the object already bound in the directory remain unchanged. If attrs is non-null, any existing attributes associated with the object already bound in the directory are removed and attrs is associated with the named object. If obj is a DirContext and attrs is non-null, the attributes of obj are ignored. param name the name to bind; may not be empty param obj the object to bind; possibly null param 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(name.toString(), obj, attrs);
public abstract void	rebind(java.lang.String name, java.lang.Object obj, javax.naming.directory.Attributes attrs) Binds a name to an object, along with associated attributes, overwriting any existing binding. param name the name to bind; may not be empty param obj the object to bind; possibly null param 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
public void	release() Release any resources allocated for this directory context. ; // No action taken by the default implementation
public java.lang.Object	removeFromEnvironment(java.lang.String propName) Removes an environment property from the environment of this context. param propName the name of the environment property to remove; may not be null exception NamingException if a naming exception is encountered return env.remove(propName);
public void	rename(javax.naming.Name oldName, javax.naming.Name newName) Binds a new name to the object bound to an old name, and unbinds the old name. Both names are relative to this context. Any attributes associated with the old name become associated with the new name. Intermediate contexts of the old name are not changed. param oldName the name of the existing binding; may not be empty param 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(oldName.toString(), newName.toString());
public abstract void	rename(java.lang.String oldName, java.lang.String newName) Binds a new name to the object bound to an old name, and unbinds the old name. param oldName the name of the existing binding; may not be empty param 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
public javax.naming.NamingEnumeration	search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn) Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes. The search is performed using the default SearchControls settings. param name the name of the context to search param matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned. param attributesToReturn the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned. return 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 return search(name.toString(), matchingAttributes, attributesToReturn);
public abstract javax.naming.NamingEnumeration	search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn) Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes. param name the name of the context to search param matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned. param attributesToReturn the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned. return 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
public javax.naming.NamingEnumeration	search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes) Searches in a single context for objects that contain a specified set of attributes. This method returns all the attributes of such objects. It is equivalent to supplying null as the atributesToReturn parameter to the method search(Name, Attributes, String[]). param name the name of the context to search param matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned. return 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 return search(name.toString(), matchingAttributes);
public abstract javax.naming.NamingEnumeration	search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes) Searches in a single context for objects that contain a specified set of attributes. param name the name of the context to search param matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned. return 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
public javax.naming.NamingEnumeration	search(javax.naming.Name name, java.lang.String filter, javax.naming.directory.SearchControls cons) Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls. param name the name of the context or object to search param filter the filter expression to use for the search; may not be null param cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). return 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 return search(name.toString(), filter, cons);
public abstract javax.naming.NamingEnumeration	search(java.lang.String name, java.lang.String filter, javax.naming.directory.SearchControls cons) Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls. param name the name of the context or object to search param filter the filter expression to use for the search; may not be null param cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). return 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
public javax.naming.NamingEnumeration	search(javax.naming.Name name, java.lang.String filterExpr, java.lang.Object[] filterArgs, javax.naming.directory.SearchControls cons) Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls. param name the name of the context or object to search param 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. param 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. param cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). return 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 return search(name.toString(), filterExpr, filterArgs, cons);
public abstract javax.naming.NamingEnumeration	search(java.lang.String name, java.lang.String filterExpr, java.lang.Object[] filterArgs, javax.naming.directory.SearchControls cons) Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls. param name the name of the context or object to search param 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. param 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. param cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). return 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
public void	setCacheMaxSize(int cacheMaxSize) Set the maximum size of the cache in KB. this.cacheMaxSize = cacheMaxSize;
public void	setCacheTTL(int cacheTTL) Set cache TTL. this.cacheTTL = cacheTTL;
public void	setCached(boolean cached) Set cached. this.cached = cached;
public void	setDebug(int debug) Set the debugging detail level for this component. param debug The new debugging detail level this.debug = debug;
public void	setDocBase(java.lang.String docBase) Set the document root for this component. param docBase The new document root exception IllegalArgumentException if the specified value is not supported by this implementation exception IllegalArgumentException if this would create a malformed URL // Validate the format of the proposed document root if (docBase == null) throw new IllegalArgumentException (sm.getString("resources.null")); // Change the document root property this.docBase = docBase;
public void	unbind(javax.naming.Name name) 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. param 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(name.toString());
public abstract void	unbind(java.lang.String name) Unbinds the named object. param 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