Home » apache-tomcat-6.0.26-src » org.apache » naming » resources » [javadoc | source]
org.apache.naming.resources
public class: WARDirContext [javadoc | source]
java.lang.Object
   org.apache.naming.resources.BaseDirContext
      org.apache.naming.resources.WARDirContext

All Implemented Interfaces:
    DirContext

WAR Directory Context implementation.
Nested Class Summary:
protected class  WARDirContext.Entry  Entries structure. 
protected class  WARDirContext.WARResource  This specialized resource implementation avoids opening the IputStream to the WAR right away. 
Field Summary
protected  ZipFile base    The WAR file. 
protected  Entry entries    WAR entries. 
Fields inherited from org.apache.naming.resources.BaseDirContext:
docBase,  env,  sm,  nameParser,  cached,  cacheTTL,  cacheMaxSize,  cacheObjectMaxSize
Constructor:
 public WARDirContext() 
 public WARDirContext(Hashtable env) 
    Builds a WAR directory context using the given environment.
 protected WARDirContext(ZipFile base,
    Entry entries) 
    Constructor used for returning fake subcontexts.
Method from org.apache.naming.resources.WARDirContext Summary:
bind,   createSubcontext,   destroySubcontext,   getAttributes,   getAttributes,   getNameInNamespace,   getSchema,   getSchemaClassDefinition,   list,   list,   list,   listBindings,   listBindings,   loadEntries,   lookup,   lookup,   lookupLink,   modifyAttributes,   modifyAttributes,   normalize,   rebind,   release,   rename,   search,   search,   search,   search,   setDocBase,   treeLookup,   unbind
Methods from org.apache.naming.resources.BaseDirContext:
addToEnvironment,   allocate,   bind,   bind,   bind,   bind,   close,   composeName,   composeName,   createSubcontext,   createSubcontext,   createSubcontext,   createSubcontext,   destroySubcontext,   destroySubcontext,   getAttributes,   getAttributes,   getAttributes,   getAttributes,   getCacheMaxSize,   getCacheObjectMaxSize,   getCacheTTL,   getDocBase,   getEnvironment,   getNameInNamespace,   getNameParser,   getNameParser,   getSchema,   getSchema,   getSchemaClassDefinition,   getSchemaClassDefinition,   isCached,   list,   list,   listBindings,   listBindings,   lookup,   lookup,   lookupLink,   lookupLink,   modifyAttributes,   modifyAttributes,   modifyAttributes,   modifyAttributes,   rebind,   rebind,   rebind,   rebind,   release,   removeFromEnvironment,   rename,   rename,   search,   search,   search,   search,   search,   search,   search,   search,   setCacheMaxSize,   setCacheObjectMaxSize,   setCacheTTL,   setCached,   setDocBase,   unbind,   unbind
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.naming.resources.WARDirContext Detail:
 public  void bind(String name,
    Object obj,
    Attributes attrs) throws NamingException 
    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.
 public DirContext createSubcontext(String name,
    Attributes attrs) throws NamingException 
    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().
 public  void destroySubcontext(String name) throws NamingException 
    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.

 public Attributes getAttributes(String name,
    String[] attrIds) throws NamingException 
    Retrieves selected attributes associated with a named object. See the class description regarding attribute models, attribute type names, and operational attributes.
 public Attributes getAttributes(Name name,
    String[] attrIds) throws NamingException 
    Retrieves all of the attributes associated with a named object.
 public String getNameInNamespace() throws NamingException 
    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.

 public DirContext getSchema(String name) throws NamingException 
    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.
 public DirContext getSchemaClassDefinition(String name) throws NamingException 
    Retrieves a context containing the schema objects of the named object's class definitions.
 public NamingEnumeration list(String name) throws NamingException 
    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.

 public NamingEnumeration list(Name name) throws NamingException 
    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.

 protected ArrayList list(Entry entry) 
    List children as objects.
 public NamingEnumeration listBindings(String name) throws NamingException 
    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.

 public NamingEnumeration listBindings(Name name) throws NamingException 
    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.

 protected  void loadEntries() 
    Constructs a tree of the entries contained in a WAR file.
 public Object lookup(String name) throws NamingException 
    Retrieves the named object.
 public Object lookup(Name name) throws NamingException 
    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).
 public Object lookupLink(String name) throws NamingException 
    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.
 public  void modifyAttributes(String name,
    ModificationItem[] mods) throws NamingException 
    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.
 public  void modifyAttributes(String name,
    int mod_op,
    Attributes attrs) throws NamingException 
    Modifies the attributes associated with a named object. The order of the modifications is not specified. Where possible, the modifications are performed atomically.
 protected String normalize(ZipEntry entry) 
    Normalize the name of an entry read from the Zip.
 public  void rebind(String name,
    Object obj,
    Attributes attrs) throws NamingException 
    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.
 public  void release() 
    Release any resources allocated for this directory context.
 public  void rename(String oldName,
    String newName) throws NamingException 
    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.
 public NamingEnumeration search(String name,
    Attributes matchingAttributes) throws NamingException 
    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[]).
 public NamingEnumeration search(String name,
    Attributes matchingAttributes,
    String[] attributesToReturn) throws NamingException 
    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.
 public NamingEnumeration search(String name,
    String filter,
    SearchControls cons) throws NamingException 
    Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.
 public NamingEnumeration search(String name,
    String filterExpr,
    Object[] filterArgs,
    SearchControls cons) throws NamingException 
    Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.
 public  void setDocBase(String docBase) 
    Set the document root.
 protected Entry treeLookup(Name name) 
    Entry tree lookup.
 public  void unbind(String name) throws NamingException 
    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.