public class WARDirContext extends BaseDirContext
| Modifier and Type | Class and Description |
|---|---|
protected static class |
WARDirContext.Entry
Entries structure.
|
protected class |
WARDirContext.WARResource
This specialized resource implementation avoids opening the IputStream
to the WAR right away.
|
| Modifier and Type | Field and Description |
|---|---|
protected java.util.zip.ZipFile |
base
The WAR file.
|
protected WARDirContext.Entry |
entries
WAR entries.
|
aliases, altDirContexts, cached, cacheMaxSize, cacheObjectMaxSize, cacheTTL, docBase, env, nameParser, sm| Modifier | Constructor and Description |
|---|---|
|
WARDirContext()
Builds a WAR directory context using the given environment.
|
|
WARDirContext(java.util.Hashtable<java.lang.String,java.lang.Object> env)
Builds a WAR directory context using the given environment.
|
protected |
WARDirContext(java.util.zip.ZipFile base,
WARDirContext.Entry entries)
Constructor used for returning fake sub-contexts or for accessing
META-INF/resources locations in bundled JAR files.
|
| Modifier and Type | Method and Description |
|---|---|
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 javax.naming.directory.Attributes |
doGetAttributes(java.lang.String name,
java.lang.String[] attrIds)
Retrieves selected attributes associated with a named object.
|
protected java.lang.String |
doGetRealPath(java.lang.String path)
Return the real path for a given virtual path, if possible; otherwise
return
null. |
protected java.util.List<NamingEntry> |
doListBindings(java.lang.String strName)
Enumerates the names bound in the named context, along with the
objects bound to them.
|
protected java.lang.Object |
doLookup(java.lang.String strName)
Retrieves the named object.
|
javax.naming.directory.Attributes |
getAttributes(javax.naming.Name name,
java.lang.String[] attrIds)
Retrieves all of the 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.
|
protected java.util.ArrayList<NamingEntry> |
list(WARDirContext.Entry entry)
List children as objects.
|
protected void |
loadEntries()
Constructs a tree of the entries contained in a WAR file.
|
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.util.zip.ZipEntry entry)
Normalize the name of an entry read from the Zip.
|
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 |
release()
Release any resources allocated for this directory context.
|
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<javax.naming.directory.SearchResult> |
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<javax.naming.directory.SearchResult> |
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<javax.naming.directory.SearchResult> |
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<javax.naming.directory.SearchResult> |
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 |
setDocBase(java.lang.String docBase)
Set the document root.
|
protected WARDirContext.Entry |
treeLookup(javax.naming.Name name)
Entry tree lookup.
|
void |
unbind(java.lang.String name)
Unbinds the named object.
|
addAlias, addAltDirContext, addResourcesJar, addToEnvironment, allocate, bind, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, createSubcontext, destroySubcontext, getAliases, getAttributes, getAttributes, getAttributes, getCacheMaxSize, getCacheObjectMaxSize, getCacheTTL, getDocBase, getEnvironment, getNameParser, getNameParser, getRealPath, getSchema, getSchemaClassDefinition, isCached, list, list, listBindings, listBindings, lookup, lookup, lookupLink, modifyAttributes, modifyAttributes, rebind, rebind, rebind, removeAlias, removeFromEnvironment, rename, search, search, search, search, setAliases, setCached, setCacheMaxSize, setCacheObjectMaxSize, setCacheTTL, unbindprotected java.util.zip.ZipFile base
protected WARDirContext.Entry entries
public WARDirContext()
public WARDirContext(java.util.Hashtable<java.lang.String,java.lang.Object> env)
protected WARDirContext(java.util.zip.ZipFile base,
WARDirContext.Entry entries)
public void setDocBase(java.lang.String docBase)
setDocBase in class BaseDirContextdocBase - 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 release()
release in class BaseDirContextprotected java.lang.String doGetRealPath(java.lang.String path)
null.doGetRealPath in class BaseDirContextpath - The path to the desired resourceprotected java.lang.Object doLookup(java.lang.String strName)
doLookup in class BaseDirContextstrName - the name of the object to look uppublic void unbind(java.lang.String name)
throws javax.naming.NamingException
unbind in interface javax.naming.Contextunbind in class BaseDirContextname - the name to bind; may not be emptyjavax.naming.OperationNotSupportedException - for this implementationjavax.naming.NameNotFoundException - 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 interface javax.naming.Contextrename in class BaseDirContextoldName - 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 encounteredprotected java.util.List<NamingEntry> doListBindings(java.lang.String strName) throws javax.naming.NamingException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
doListBindings in class BaseDirContextstrName - 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
destroySubcontext in interface javax.naming.ContextdestroySubcontext in class BaseDirContextname - the name of the context to be destroyed; may not be emptyjavax.naming.OperationNotSupportedException - for this implementationjavax.naming.NamingExceptionpublic java.lang.Object lookupLink(java.lang.String name)
throws javax.naming.NamingException
lookupLink in interface javax.naming.ContextlookupLink in class BaseDirContextname - 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 interface javax.naming.ContextgetNameInNamespace in class BaseDirContextjavax.naming.OperationNotSupportedException - if the naming system does
not have the notion of a full namejavax.naming.NamingException - if a naming exception is encounteredprotected javax.naming.directory.Attributes doGetAttributes(java.lang.String name,
java.lang.String[] attrIds)
throws javax.naming.NamingException
doGetAttributes in class BaseDirContextname - 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 javax.naming.directory.Attributes getAttributes(javax.naming.Name name,
java.lang.String[] attrIds)
throws javax.naming.NamingException
getAttributes in interface javax.naming.directory.DirContextgetAttributes in class BaseDirContextname - 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 interface javax.naming.directory.DirContextmodifyAttributes in class BaseDirContextname - 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 nulljavax.naming.directory.AttributeModificationException - 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 interface javax.naming.directory.DirContextmodifyAttributes in class BaseDirContextname - the name of the object whose attributes will be updatedmods - an ordered sequence of modifications to be performed; may
not be nulljavax.naming.directory.AttributeModificationException - 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 interface javax.naming.directory.DirContextbind in class BaseDirContextname - 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
boundjavax.naming.directory.InvalidAttributesException - 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 interface javax.naming.directory.DirContextrebind in class BaseDirContextname - the name to bind; may not be emptyobj - the object to bind; possibly nullattrs - the attributes to associate with the bindingjavax.naming.directory.InvalidAttributesException - 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 interface javax.naming.directory.DirContextcreateSubcontext in class BaseDirContextname - the name of the context to create; may not be emptyattrs - the attributes to associate with the newly created contextjavax.naming.NameAlreadyBoundException - if name is already
boundjavax.naming.directory.InvalidAttributesException - 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 interface javax.naming.directory.DirContextgetSchema in class BaseDirContextname - 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 interface javax.naming.directory.DirContextgetSchemaClassDefinition in class BaseDirContextname - 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<javax.naming.directory.SearchResult> search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
throws javax.naming.NamingException
search in interface javax.naming.directory.DirContextsearch in class BaseDirContextname - 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<javax.naming.directory.SearchResult> search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes)
throws javax.naming.NamingException
search in interface javax.naming.directory.DirContextsearch in class BaseDirContextname - 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<javax.naming.directory.SearchResult> search(java.lang.String name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
throws javax.naming.NamingException
search in interface javax.naming.directory.DirContextsearch in class BaseDirContextname - 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())).javax.naming.directory.InvalidSearchFilterException - if the
search filter specified is not supported or understood by the underlying
directoryjavax.naming.directory.InvalidSearchControlsException - if the
search controls contain invalid settingsjavax.naming.NamingException - if a naming exception is encounteredpublic javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> search(java.lang.String name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
throws javax.naming.NamingException
search in interface javax.naming.directory.DirContextsearch in class BaseDirContextname - 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())).java.lang.ArrayIndexOutOfBoundsException - if filterExpr contains {i}
expressions where i is outside the bounds of the array filterArgsjavax.naming.directory.InvalidSearchControlsException - if cons
contains invalid settingsjavax.naming.directory.InvalidSearchFilterException - if
filterExpr with filterArgs represents an invalid search filterjavax.naming.NamingException - if a naming exception is encounteredprotected java.lang.String normalize(java.util.zip.ZipEntry entry)
protected void loadEntries()
protected WARDirContext.Entry treeLookup(javax.naming.Name name)
protected java.util.ArrayList<NamingEntry> list(WARDirContext.Entry entry)
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.