org.apache.naming.resources
public class FileDirContext extends BaseDirContext
Version: $Revision: 769338 $ $Date: 2009-04-28 13:25:01 +0200 (Tue, 28 Apr 2009) $
Nested Class Summary | |
---|---|
protected class | FileDirContext.FileResource
This specialized resource implementation avoids opening the IputStream
to the file right away (which would put a lock on the file). |
protected class | FileDirContext.FileResourceAttributes
This specialized resource attribute implementation does some lazy
reading (to speed up simple checks, like checking the last modified
date). |
Field Summary | |
---|---|
protected String | absoluteBase
Absolute normalized filename of the base. |
protected boolean | allowLinking
Allow linking. |
protected File | base
The document base directory. |
protected static int | BUFFER_SIZE
The descriptive information string for this implementation. |
protected boolean | caseSensitive
Case sensitivity. |
Constructor Summary | |
---|---|
FileDirContext()
Builds a file directory context using the given environment. | |
FileDirContext(Hashtable env)
Builds a file directory context using the given environment. |
Method Summary | |
---|---|
void | bind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes. |
DirContext | createSubcontext(String name, Attributes attrs)
Creates and binds a new context, along with associated attributes.
|
void | destroySubcontext(String name)
Destroys the named context and removes it from the namespace. |
protected File | file(String name)
Return a File object representing the specified normalized
context-relative path if it exists and is readable. |
boolean | getAllowLinking()
Is linking allowed. |
Attributes | getAttributes(String name, String[] attrIds)
Retrieves selected attributes associated with a named object.
|
String | getNameInNamespace()
Retrieves the full name of this context within its own namespace.
|
DirContext | getSchema(String name)
Retrieves the schema associated with the named object. |
DirContext | getSchemaClassDefinition(String name)
Retrieves a context containing the schema objects of the named
object's class definitions.
|
boolean | isCaseSensitive()
Is case sensitive ? |
NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them. |
protected ArrayList | list(File file)
List the resources which are members of a collection.
|
NamingEnumeration | listBindings(String name)
Enumerates the names bound in the named context, along with the
objects bound to them. |
Object | lookup(String name)
Retrieves the named object.
|
Object | lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name. |
void | modifyAttributes(String name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object. |
void | modifyAttributes(String name, ModificationItem[] mods)
Modifies the attributes associated with a named object using an an
ordered list of modifications. |
protected String | normalize(String path)
Return a context-relative path, beginning with a "/", that represents
the canonical version of the specified path after ".." and "." elements
are resolved out. |
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. |
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(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(String name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes. |
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(String name, String filterExpr, Object[] filterArgs, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. |
void | setAllowLinking(boolean allowLinking)
Set allow linking. |
void | setCaseSensitive(boolean caseSensitive)
Set case sensitivity. |
void | setDocBase(String docBase)
Set the document root.
|
void | unbind(String name)
Unbinds the named object. |
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 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
null
.
Parameters: name Normalized context-relative path (with leading '/')
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
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 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
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: file Collection
Returns: Vector containg NamingEntry objects
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 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 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
null
instead.
Parameters: path Path to be normalized
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: 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.
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 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