|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.naming.resources.BaseDirContext | +--org.apache.naming.resources.FileDirContext
Filesystem Directory Context implementation helper class.
Inner 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). |
Field Summary | |
protected java.lang.String |
absoluteBase
Absolute normalized filename of the base. |
protected java.io.File |
base
The document base directory. |
protected static int |
BUFFER_SIZE
The descriptive information string for this implementation. |
protected boolean |
caseSensitive
Case sensitivity. |
Fields inherited from class org.apache.naming.resources.BaseDirContext |
cached, cacheTTL, debug, docBase, env, nameParser, sm |
Fields inherited from interface javax.naming.directory.DirContext |
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE |
Fields inherited from interface javax.naming.Context |
APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES |
Constructor Summary | |
FileDirContext()
Builds a file directory context using the given environment. |
|
FileDirContext(java.util.Hashtable env)
Builds a file directory context using the given environment. |
Method Summary | |
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. |
javax.naming.directory.DirContext |
createSubcontext(java.lang.String name,
javax.naming.directory.Attributes attrs)
Creates and binds a new context, along with associated attributes. |
void |
destroySubcontext(java.lang.String name)
Destroys the named context and removes it from the namespace. |
protected java.io.File |
file(java.lang.String name)
Return a File object representing the specified normalized context-relative path if it exists and is readable. |
javax.naming.directory.Attributes |
getAttributes(java.lang.String name,
java.lang.String[] attrIds)
Retrieves selected attributes associated with a named object. |
java.lang.String |
getNameInNamespace()
Retrieves the full name of this context within its own namespace. |
javax.naming.directory.DirContext |
getSchema(java.lang.String name)
Retrieves the schema associated with the named object. |
javax.naming.directory.DirContext |
getSchemaClassDefinition(java.lang.String name)
Retrieves a context containing the schema objects of the named object's class definitions. |
boolean |
isCaseSensitive()
Is case sensitive ? |
protected java.util.Vector |
list(java.io.File file)
List the resources which are members of a collection. |
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. |
javax.naming.NamingEnumeration |
listBindings(java.lang.String name)
Enumerates the names bound in the named context, along with the objects bound to them. |
java.lang.Object |
lookup(java.lang.String name)
Retrieves the named object. |
java.lang.Object |
lookupLink(java.lang.String name)
Retrieves the named object, following links except for the terminal atomic component of the name. |
void |
modifyAttributes(java.lang.String name,
int mod_op,
javax.naming.directory.Attributes attrs)
Modifies the attributes associated with a named object. |
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. |
protected java.lang.String |
normalize(java.lang.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(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. |
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. |
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. |
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. |
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. |
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. |
void |
setCaseSensitive(boolean caseSensitive)
Set case sensitivity. |
void |
setDocBase(java.lang.String docBase)
Set the document root. |
void |
unbind(java.lang.String name)
Unbinds the named object. |
Methods inherited from class org.apache.naming.resources.BaseDirContext |
addToEnvironment, bind, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, createSubcontext, destroySubcontext, getAttributes, getAttributes, getAttributes, getCacheTTL, getDebug, getDocBase, getEnvironment, getNameParser, getNameParser, getSchema, getSchemaClassDefinition, isCached, list, listBindings, lookup, lookupLink, modifyAttributes, modifyAttributes, rebind, rebind, rebind, removeFromEnvironment, rename, search, search, search, search, setCached, setCacheTTL, setDebug, unbind |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final int BUFFER_SIZE
protected java.io.File base
protected java.lang.String absoluteBase
protected boolean caseSensitive
Constructor Detail |
public FileDirContext()
public FileDirContext(java.util.Hashtable env)
Method Detail |
public void setDocBase(java.lang.String docBase)
setDocBase
in class BaseDirContext
docBase
- The new document rootjava.lang.IllegalArgumentException
- if the specified value is not
supported by this implementationjava.lang.IllegalArgumentException
- if this would create a
malformed URLpublic void setCaseSensitive(boolean caseSensitive)
public boolean isCaseSensitive()
public java.lang.Object lookup(java.lang.String name) throws javax.naming.NamingException
lookup
in class BaseDirContext
name
- the name of the object to look upjavax.naming.NamingException
- if a naming exception is encounteredpublic void unbind(java.lang.String name) throws javax.naming.NamingException
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.
unbind
in class BaseDirContext
name
- the name to bind; may not be emptyNameNotFoundException
- if an intermediate context does not
existjavax.naming.NamingException
- if a naming exception is encounteredpublic void rename(java.lang.String oldName, java.lang.String newName) throws javax.naming.NamingException
rename
in class BaseDirContext
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyjavax.naming.NameAlreadyBoundException
- if newName is already boundjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration list(java.lang.String name) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
list
in class BaseDirContext
name
- the name of the context to listjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration listBindings(java.lang.String name) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
listBindings
in class BaseDirContext
name
- the name of the context to listjavax.naming.NamingException
- if a naming exception is encounteredpublic void destroySubcontext(java.lang.String name) throws javax.naming.NamingException
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.
destroySubcontext
in class BaseDirContext
name
- the name of the context to be destroyed; may not be emptyNameNotFoundException
- if an intermediate context does not
existNotContextException
- if the name is bound but does not name
a context, or does not name a context of the appropriate typepublic java.lang.Object lookupLink(java.lang.String name) throws javax.naming.NamingException
lookupLink
in class BaseDirContext
name
- the name of the object to look upjavax.naming.NamingException
- if a naming exception is encounteredpublic java.lang.String getNameInNamespace() throws javax.naming.NamingException
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.
getNameInNamespace
in class BaseDirContext
javax.naming.OperationNotSupportedException
- if the naming system does
not have the notion of a full namejavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.directory.Attributes getAttributes(java.lang.String name, java.lang.String[] attrIds) throws javax.naming.NamingException
getAttributes
in class BaseDirContext
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 retrievedjavax.naming.NamingException
- if a naming exception is encounteredpublic void modifyAttributes(java.lang.String name, int mod_op, javax.naming.directory.Attributes attrs) throws javax.naming.NamingException
modifyAttributes
in class BaseDirContext
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 nullAttributeModificationException
- if the modification cannot be
completed successfullyjavax.naming.NamingException
- if a naming exception is encounteredpublic void modifyAttributes(java.lang.String name, javax.naming.directory.ModificationItem[] mods) throws javax.naming.NamingException
modifyAttributes
in class BaseDirContext
name
- the name of the object whose attributes will be updatedmods
- an ordered sequence of modifications to be performed; may
not be nullAttributeModificationException
- if the modification cannot be
completed successfullyjavax.naming.NamingException
- if a naming exception is encounteredpublic void bind(java.lang.String name, java.lang.Object obj, javax.naming.directory.Attributes attrs) throws javax.naming.NamingException
bind
in class BaseDirContext
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the bindingjavax.naming.NameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if some "mandatory" attributes
of the binding are not suppliedjavax.naming.NamingException
- if a naming exception is encounteredpublic void rebind(java.lang.String name, java.lang.Object obj, javax.naming.directory.Attributes attrs) throws javax.naming.NamingException
rebind
in class BaseDirContext
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullattrs
- the attributes to associate with the bindingInvalidAttributesException
- if some "mandatory" attributes
of the binding are not suppliedjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.directory.DirContext createSubcontext(java.lang.String name, javax.naming.directory.Attributes attrs) throws javax.naming.NamingException
createSubcontext
in class BaseDirContext
name
- the name of the context to create; may not be emptyattrs
- the attributes to associate with the newly created contextjavax.naming.NameAlreadyBoundException
- if the name is already boundInvalidAttributesException
- if attrs does not contain all
the mandatory attributes required for creationjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.directory.DirContext getSchema(java.lang.String name) throws javax.naming.NamingException
getSchema
in class BaseDirContext
name
- the name of the object whose schema is to be retrievedjavax.naming.OperationNotSupportedException
- if schema not supportedjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.directory.DirContext getSchemaClassDefinition(java.lang.String name) throws javax.naming.NamingException
getSchemaClassDefinition
in class BaseDirContext
name
- the name of the object whose object class definition is to
be retrievedjavax.naming.OperationNotSupportedException
- if schema not supportedjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn) throws javax.naming.NamingException
search
in class BaseDirContext
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.javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes) throws javax.naming.NamingException
search
in class BaseDirContext
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.javax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration search(java.lang.String name, java.lang.String filter, javax.naming.directory.SearchControls cons) throws javax.naming.NamingException
search
in class BaseDirContext
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())).InvalidSearchFilterException
- if the search filter specified
is not supported or understood by the underlying directoryInvalidSearchControlsException
- if the search controls
contain invalid settingsjavax.naming.NamingException
- if a naming exception is encounteredpublic javax.naming.NamingEnumeration search(java.lang.String name, java.lang.String filterExpr, java.lang.Object[] filterArgs, javax.naming.directory.SearchControls cons) throws javax.naming.NamingException
search
in class BaseDirContext
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())).ArrayIndexOutOfBoundsException
- if filterExpr contains {i}
expressions where i is outside the bounds of the array filterArgsInvalidSearchControlsException
- if cons contains invalid
settingsInvalidSearchFilterException
- if filterExpr with filterArgs
represents an invalid search filterjavax.naming.NamingException
- if a naming exception is encounteredprotected java.lang.String normalize(java.lang.String path)
null
instead.path
- Path to be normalizedprotected java.io.File file(java.lang.String name)
null
.name
- Normalized context-relative path (with leading '/')protected java.util.Vector list(java.io.File file)
file
- Collection
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |