| java.lang.Object
 org.apache.naming.resources.BaseDirContext
org.apache.naming.resources.FileDirContext
| FileDirContext | | public class FileDirContext extends BaseDirContext (Code) | | Filesystem Directory Context implementation helper class.
author:
Remy Maucherat
version:
$Revision: 1.13 $ $Date: 2002/03/17 00:03:13 $ |
| Inner Class :protected class FileResource extends Resource | |
| Field Summary | |
| final protected static int | BUFFER_SIZE
The descriptive information string for this implementation. | | protected String | absoluteBase
Absolute normalized filename of the base. | | protected File | base
The document base directory. | | protected boolean | caseSensitive
Case sensitivity. |
| Constructor Summary | |
| public | FileDirContext()
Builds a file directory context using the given environment. | | public | FileDirContext(Hashtable env)
Builds a file directory context using the given environment. |
| Method Summary | |
| public void | bind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes. | | public DirContext | createSubcontext(String name, Attributes attrs)
Creates and binds a new context, along with associated attributes. | | public 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. | | public Attributes | getAttributes(String name, String[] attrIds)
Retrieves selected attributes associated with a named object. | | public String | getNameInNamespace()
Retrieves the full name of this context within its own namespace.
Many naming services have a notion of a "full name" for objects in
their respective namespaces. | | public DirContext | getSchema(String name)
Retrieves the schema associated with the named object. | | public DirContext | getSchemaClassDefinition(String name)
Retrieves a context containing the schema objects of the named
object's class definitions. | | public boolean | isCaseSensitive()
| | public NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them. | | protected Vector | list(File file)
List the resources which are members of a collection. | | public NamingEnumeration | listBindings(String name)
Enumerates the names bound in the named context, along with the
objects bound to them. | | public Object | lookup(String name)
Retrieves the named object. | | public Object | lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name. | | public void | modifyAttributes(String name, int mod_op, Attributes attrs)
Modifies the attributes associated with a named object. | | public 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. | | public void | rebind(String name, Object obj, Attributes attrs)
Binds a name to an object, along with associated attributes,
overwriting any existing binding. | | public void | release()
Release any resources allocated for this directory context. | | public void | rename(String oldName, String newName)
Binds a new name to the object bound to an old name, and unbinds the
old name. | | public NamingEnumeration | search(String name, Attributes matchingAttributes, String[] attributesToReturn)
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes. | | public NamingEnumeration | search(String name, Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes. | | public NamingEnumeration | search(String name, String filter, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | public NamingEnumeration | search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter. | | public void | setCaseSensitive(boolean caseSensitive)
Set case sensitivity. | | public void | setDocBase(String docBase)
Set the document root. | | public void | unbind(String name)
Unbinds the named object. |
| BUFFER_SIZE | | final protected static int BUFFER_SIZE(Code) | | The descriptive information string for this implementation.
|
| absoluteBase | | protected String absoluteBase(Code) | | Absolute normalized filename of the base.
|
| base | | protected File base(Code) | | The document base directory.
|
| caseSensitive | | protected boolean caseSensitive(Code) | | Case sensitivity.
|
| FileDirContext | | public FileDirContext()(Code) | | Builds a file directory context using the given environment.
|
| FileDirContext | | public FileDirContext(Hashtable env)(Code) | | Builds a file directory context using the given environment.
|
| bind | | public void bind(String name, Object obj, Attributes attrs) throws NamingException(Code) | | Binds a name to an object, along with associated attributes. If attrs
is null, the resulting binding will have the attributes associated
with obj if obj is a DirContext, and no attributes otherwise. If attrs
is non-null, the resulting binding will have attrs as its attributes;
any attributes associated with obj are ignored.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
Parameters:
attrs - the attributes to associate with the binding
exception:
NameAlreadyBoundException - if name is already bound
exception:
InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
exception:
NamingException - if a naming exception is encountered |
| createSubcontext | | public DirContext createSubcontext(String name, Attributes attrs) throws NamingException(Code) | | Creates and binds a new context, along with associated attributes.
This method creates a new subcontext with the given name, binds it in
the target context (that named by all but terminal atomic component of
the name), and associates the supplied attributes with the newly
created object. All intermediate and target contexts must already
exist. If attrs is null, this method is equivalent to
Context.createSubcontext().
Parameters:
name - the name of the context to create; may not be empty
Parameters:
attrs - the attributes to associate with the newly created context the newly created context
exception:
NameAlreadyBoundException - if the name is already bound
exception:
InvalidAttributesException - if attrs does not contain all the mandatory attributes required for creation
exception:
NamingException - if a naming exception is encountered |
| destroySubcontext | | public void destroySubcontext(String name) throws NamingException(Code) | | Destroys the named context and removes it from the namespace. Any
attributes associated with the name are also removed. Intermediate
contexts are not destroyed.
This method is idempotent. It succeeds even if the terminal atomic
name is not bound in the target context, but throws
NameNotFoundException if any of the intermediate contexts do not exist.
In a federated naming system, a context from one naming system may be
bound to a name in another. One can subsequently look up and perform
operations on the foreign context using a composite name. However, an
attempt destroy the context using this composite name will fail with
NotContextException, because the foreign context is not a "subcontext"
of the context in which it is bound. Instead, use unbind() to remove
the binding of the foreign context. Destroying the foreign context
requires that the destroySubcontext() be performed on a context from
the foreign context's "native" naming system.
Parameters:
name - the name of the context to be destroyed; may not be empty
exception:
NameNotFoundException - if an intermediate context does not exist
exception:
NotContextException - if the name is bound but does not name a context, or does not name a context of the appropriate type |
| file | | protected File file(String name)(Code) | | Return a File object representing the specified normalized
context-relative path if it exists and is readable. Otherwise,
return null.
Parameters:
name - Normalized context-relative path (with leading '/') |
| getAttributes | | public Attributes getAttributes(String name, String[] attrIds) throws NamingException(Code) | | Retrieves selected attributes associated with a named object.
See the class description regarding attribute models, attribute type
names, and operational attributes.
the requested attributes; never null
Parameters:
name - the name of the object from which to retrieve attributes
Parameters:
attrIds - the identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved
exception:
NamingException - if a naming exception is encountered |
| getNameInNamespace | | public String getNameInNamespace() throws NamingException(Code) | | Retrieves the full name of this context within its own namespace.
Many naming services have a notion of a "full name" for objects in
their respective namespaces. For example, an LDAP entry has a
distinguished name, and a DNS record has a fully qualified name. This
method allows the client application to retrieve this name. The string
returned by this method is not a JNDI composite name and should not be
passed directly to context methods. In naming systems for which the
notion of full name does not make sense,
OperationNotSupportedException is thrown.
this context's name in its own namespace; never null
exception:
OperationNotSupportedException - if the naming system does not have the notion of a full name
exception:
NamingException - if a naming exception is encountered |
| getSchema | | public DirContext getSchema(String name) throws NamingException(Code) | | Retrieves the schema associated with the named object. The schema
describes rules regarding the structure of the namespace and the
attributes stored within it. The schema specifies what types of
objects can be added to the directory and where they can be added;
what mandatory and optional attributes an object can have. The range
of support for schemas is directory-specific.
Parameters:
name - the name of the object whose schema is to be retrieved the schema associated with the context; never null
exception:
OperationNotSupportedException - if schema not supported
exception:
NamingException - if a naming exception is encountered |
| getSchemaClassDefinition | | public DirContext getSchemaClassDefinition(String name) throws NamingException(Code) | | Retrieves a context containing the schema objects of the named
object's class definitions.
Parameters:
name - the name of the object whose object class definition is to be retrieved the DirContext containing the named object's class definitions; never null
exception:
OperationNotSupportedException - if schema not supported
exception:
NamingException - if a naming exception is encountered |
| isCaseSensitive | | public boolean isCaseSensitive()(Code) | | Is case sensitive ?
|
| list | | public NamingEnumeration list(String name) throws NamingException(Code) | | Enumerates the names bound in the named context, along with the class
names of objects bound to them. The contents of any subcontexts are
not included.
If a binding is added to or removed from this context, its effect on
an enumeration previously returned is undefined.
Parameters:
name - the name of the context to list an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
exception:
NamingException - if a naming exception is encountered |
| list | | protected Vector list(File file)(Code) | | List the resources which are members of a collection.
Parameters:
file - Collection Vector containg NamingEntry objects |
| listBindings | | public NamingEnumeration listBindings(String name) throws NamingException(Code) | | Enumerates the names bound in the named context, along with the
objects bound to them. The contents of any subcontexts are not
included.
If a binding is added to or removed from this context, its effect on
an enumeration previously returned is undefined.
Parameters:
name - the name of the context to list an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
exception:
NamingException - if a naming exception is encountered |
| lookupLink | | public Object lookupLink(String name) throws NamingException(Code) | | Retrieves the named object, following links except for the terminal
atomic component of the name. If the object bound to name is not a
link, returns the object itself.
Parameters:
name - the name of the object to look up the object bound to name, not following the terminal link (if any).
exception:
NamingException - if a naming exception is encountered |
| modifyAttributes | | public void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException(Code) | | Modifies the attributes associated with a named object. The order of
the modifications is not specified. Where possible, the modifications
are performed atomically.
Parameters:
name - the name of the object whose attributes will be updated
Parameters:
mod_op - the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE
Parameters:
attrs - the attributes to be used for the modification; may not be null
exception:
AttributeModificationException - if the modification cannot becompleted successfully
exception:
NamingException - if a naming exception is encountered |
| modifyAttributes | | public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException(Code) | | Modifies the attributes associated with a named object using an an
ordered list of modifications. The modifications are performed in the
order specified. Each modification specifies a modification operation
code and an attribute on which to operate. Where possible, the
modifications are performed atomically.
Parameters:
name - the name of the object whose attributes will be updated
Parameters:
mods - an ordered sequence of modifications to be performed; may not be null
exception:
AttributeModificationException - if the modification cannot becompleted successfully
exception:
NamingException - if a naming exception is encountered |
| normalize | | protected String normalize(String path)(Code) | | Return a context-relative path, beginning with a "/", that represents
the canonical version of the specified path after ".." and "." elements
are resolved out. If the specified path attempts to go outside the
boundaries of the current context (i.e. too many ".." path elements
are present), return null instead.
Parameters:
path - Path to be normalized |
| rebind | | public void rebind(String name, Object obj, Attributes attrs) throws NamingException(Code) | | Binds a name to an object, along with associated attributes,
overwriting any existing binding. If attrs is null and obj is a
DirContext, the attributes from obj are used. If attrs is null and obj
is not a DirContext, any existing attributes associated with the object
already bound in the directory remain unchanged. If attrs is non-null,
any existing attributes associated with the object already bound in
the directory are removed and attrs is associated with the named
object. If obj is a DirContext and attrs is non-null, the attributes
of obj are ignored.
Parameters:
name - the name to bind; may not be empty
Parameters:
obj - the object to bind; possibly null
Parameters:
attrs - the attributes to associate with the binding
exception:
InvalidAttributesException - if some "mandatory" attributes of the binding are not supplied
exception:
NamingException - if a naming exception is encountered |
| release | | public void release()(Code) | | Release any resources allocated for this directory context.
|
| rename | | public void rename(String oldName, String newName) throws NamingException(Code) | | Binds a new name to the object bound to an old name, and unbinds the
old name. Both names are relative to this context. Any attributes
associated with the old name become associated with the new name.
Intermediate contexts of the old name are not changed.
Parameters:
oldName - the name of the existing binding; may not be empty
Parameters:
newName - the name of the new binding; may not be empty
exception:
NameAlreadyBoundException - if newName is already bound
exception:
NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(String name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException(Code) | | Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes. The search is
performed using the default SearchControls settings.
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. If empty or null, all objects in the target context are returned.
Parameters:
attributesToReturn - the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned. a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
exception:
NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(String name, Attributes matchingAttributes) throws NamingException(Code) | | Searches in a single context for objects that contain a specified set
of attributes. This method returns all the attributes of such objects.
It is equivalent to supplying null as the atributesToReturn parameter
to the method search(Name, Attributes, String[]).
Parameters:
name - the name of the context to search
Parameters:
matchingAttributes - the attributes to search for. If empty or null, all objects in the target context are returned. a non-null enumeration of SearchResult objects. Each SearchResult contains the attributes identified by attributesToReturn and the name of the corresponding object, named relative to the context named by name.
exception:
NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(String name, String filter, SearchControls cons) throws NamingException(Code) | | Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls.
Parameters:
name - the name of the context or object to search
Parameters:
filter - the filter expression to use for the search; may not be null
Parameters:
cons - the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). an enumeration of SearchResults of the objects that satisfy the filter; never null
exception:
InvalidSearchFilterException - if the search filter specified is not supported or understood by the underlying directory
exception:
InvalidSearchControlsException - if the search controls contain invalid settings
exception:
NamingException - if a naming exception is encountered |
| search | | public NamingEnumeration search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException(Code) | | Searches in the named context or object for entries that satisfy the
given search filter. Performs the search as specified by the search
controls.
Parameters:
name - the name of the context or object to search
Parameters:
filterExpr - the filter expression to use for the search. The expression may contain variables of the form "{i}" where i is a nonnegative integer. May not be null.
Parameters:
filterArgs - the array of arguments to substitute for the variables in filterExpr. The value of filterArgs[i] will replace each occurrence of "{i}". If null, equivalent to an empty array.
Parameters:
cons - the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())). an enumeration of SearchResults of the objects that satisy the filter; never null
exception:
ArrayIndexOutOfBoundsException - if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs
exception:
InvalidSearchControlsException - if cons contains invalid settings
exception:
InvalidSearchFilterException - if filterExpr with filterArgs represents an invalid search filter
exception:
NamingException - if a naming exception is encountered |
| setCaseSensitive | | public void setCaseSensitive(boolean caseSensitive)(Code) | | Set case sensitivity.
|
| unbind | | public void unbind(String name) throws NamingException(Code) | | Unbinds the named object. Removes the terminal atomic name in name
from the target context--that named by all but the terminal atomic
part of name.
This method is idempotent. It succeeds even if the terminal atomic
name is not bound in the target context, but throws
NameNotFoundException if any of the intermediate contexts do not exist.
Parameters:
name - the name to bind; may not be empty
exception:
NameNotFoundException - if an intermediate context does not exist
exception:
NamingException - if a naming exception is encountered |
| Methods inherited from org.apache.naming.resources.BaseDirContext | public Object addToEnvironment(String propName, Object propVal) throws NamingException(Code)(Java Doc)
public void allocate()(Code)(Java Doc)
public void bind(Name name, Object obj) throws NamingException(Code)(Java Doc)
public void bind(String name, Object obj) throws NamingException(Code)(Java Doc)
public void bind(Name name, Object obj, Attributes attrs) throws NamingException(Code)(Java Doc)
abstract public void bind(String name, Object obj, Attributes attrs) throws NamingException(Code)(Java Doc)
public void close() throws NamingException(Code)(Java Doc)
public Name composeName(Name name, Name prefix) throws NamingException(Code)(Java Doc)
public String composeName(String name, String prefix) throws NamingException(Code)(Java Doc)
public Context createSubcontext(Name name) throws NamingException(Code)(Java Doc)
public Context createSubcontext(String name) throws NamingException(Code)(Java Doc)
public DirContext createSubcontext(Name name, Attributes attrs) throws NamingException(Code)(Java Doc)
abstract public DirContext createSubcontext(String name, Attributes attrs) throws NamingException(Code)(Java Doc)
public void destroySubcontext(Name name) throws NamingException(Code)(Java Doc)
abstract public void destroySubcontext(String name) throws NamingException(Code)(Java Doc)
public Attributes getAttributes(Name name) throws NamingException(Code)(Java Doc)
public Attributes getAttributes(String name) throws NamingException(Code)(Java Doc)
public Attributes getAttributes(Name name, String[] attrIds) throws NamingException(Code)(Java Doc)
abstract public Attributes getAttributes(String name, String[] attrIds) throws NamingException(Code)(Java Doc)
public int getCacheObjectMaxSize()(Code)(Java Doc)
public int getCacheTTL()(Code)(Java Doc)
public int getDebug()(Code)(Java Doc)
public String getDocBase()(Code)(Java Doc)
public Hashtable getEnvironment() throws NamingException(Code)(Java Doc)
abstract public String getNameInNamespace() throws NamingException(Code)(Java Doc)
public NameParser getNameParser(Name name) throws NamingException(Code)(Java Doc)
public NameParser getNameParser(String name) throws NamingException(Code)(Java Doc)
public DirContext getSchema(Name name) throws NamingException(Code)(Java Doc)
abstract public DirContext getSchema(String name) throws NamingException(Code)(Java Doc)
public DirContext getSchemaClassDefinition(Name name) throws NamingException(Code)(Java Doc)
abstract public DirContext getSchemaClassDefinition(String name) throws NamingException(Code)(Java Doc)
public boolean isCached()(Code)(Java Doc)
public NamingEnumeration list(Name name) throws NamingException(Code)(Java Doc)
abstract public NamingEnumeration list(String name) throws NamingException(Code)(Java Doc)
public NamingEnumeration listBindings(Name name) throws NamingException(Code)(Java Doc)
abstract public NamingEnumeration listBindings(String name) throws NamingException(Code)(Java Doc)
public Object lookup(Name name) throws NamingException(Code)(Java Doc)
abstract public Object lookup(String name) throws NamingException(Code)(Java Doc)
public Object lookupLink(Name name) throws NamingException(Code)(Java Doc)
abstract public Object lookupLink(String name) throws NamingException(Code)(Java Doc)
public void modifyAttributes(Name name, int mod_op, Attributes attrs) throws NamingException(Code)(Java Doc)
abstract public void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException(Code)(Java Doc)
public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException(Code)(Java Doc)
abstract public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException(Code)(Java Doc)
public void rebind(Name name, Object obj) throws NamingException(Code)(Java Doc)
public void rebind(String name, Object obj) throws NamingException(Code)(Java Doc)
public void rebind(Name name, Object obj, Attributes attrs) throws NamingException(Code)(Java Doc)
abstract public void rebind(String name, Object obj, Attributes attrs) throws NamingException(Code)(Java Doc)
public void release()(Code)(Java Doc)
public Object removeFromEnvironment(String propName) throws NamingException(Code)(Java Doc)
public void rename(Name oldName, Name newName) throws NamingException(Code)(Java Doc)
abstract public void rename(String oldName, String newName) throws NamingException(Code)(Java Doc)
public NamingEnumeration search(Name name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException(Code)(Java Doc)
abstract public NamingEnumeration search(String name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException(Code)(Java Doc)
public NamingEnumeration search(Name name, Attributes matchingAttributes) throws NamingException(Code)(Java Doc)
abstract public NamingEnumeration search(String name, Attributes matchingAttributes) throws NamingException(Code)(Java Doc)
public NamingEnumeration search(Name name, String filter, SearchControls cons) throws NamingException(Code)(Java Doc)
abstract public NamingEnumeration search(String name, String filter, SearchControls cons) throws NamingException(Code)(Java Doc)
public NamingEnumeration search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException(Code)(Java Doc)
abstract public NamingEnumeration search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException(Code)(Java Doc)
public void setCacheObjectMaxSize(int cacheObjectMaxSize)(Code)(Java Doc)
public void setCacheTTL(int cacheTTL)(Code)(Java Doc)
public void setCached(boolean cached)(Code)(Java Doc)
public void setDebug(int debug)(Code)(Java Doc)
public void setDocBase(String docBase)(Code)(Java Doc)
public void unbind(Name name) throws NamingException(Code)(Java Doc)
abstract public void unbind(String name) throws NamingException(Code)(Java Doc)
|
|
|