Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * JBoss, Home of Professional Open Source.
   * Copyright 2012 Red Hat, Inc., and individual contributors
   * as indicated by the @author tags.
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.apache.naming.resources;
 
 import static org.jboss.web.NamingMessages.MESSAGES;
 
 import java.util.Date;
 
 
JAR Directory Context implementation, variant of WAR dir context. It uses a JarFile directly, as well as a path prefix.

Author(s):
Remy Maucherat
Version:
$Revision: 515 $ $Date: 2008-03-17 22:02:23 +0100 (Mon, 17 Mar 2008) $
 
 
 public class JARDirContext extends BaseDirContext {
 
     // ----------------------------------------------------------- Constructors
 

    
Builds a WAR directory context using the given environment.
 
     public JARDirContext() {
         super();
     }


    
Builds a WAR directory context using the given environment.
 
     public JARDirContext(Hashtable env) {
         super(env);
     }


    
Constructor used for returning fake subcontexts.
 
     protected JARDirContext(JarFile baseEntry entries) {
         this. = base;
         this. = entries;
     }
 
 
     // ----------------------------------------------------- Instance Variables
 

    
The Jar file.
 
    protected JarFile base = null;


    
WAR entries.
    protected Entry entries = null;


    
Path prefix.
    protected String prefix = null;
    // ------------------------------------------------------------- Properties


    
Set the JAR file from which data will be read.

Parameters:
jarFile The JAR file
    public void setJarFile(JarFile jarFileString prefix) {
        // Validate the format of the proposed document root
        if (jarFile == null)
            throw .invalidNullDocumentBase();
        this. = prefix;
        if (prefix.startsWith("/")) {
            this. = prefix.substring(1);
        }
        this. = jarFile;
        
        loadEntries();
    }
    
    // --------------------------------------------------------- Public Methods


    
Release any resources allocated for this directory context.
    public void release() {
         = null;
        // Base is not closed as it is supposed to be managed through 
        // a repository
         = null;
        super.release();
    }
    // -------------------------------------------------------- Context Methods


    
Retrieves the named object.

Parameters:
name the name of the object to look up
Returns:
the object bound to name
Throws:
javax.naming.NamingException if a naming exception is encountered
    public Object lookup(String name)
        throws NamingException {
        return lookup(new CompositeName(name));
    }


    
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).

Parameters:
name the name of the object to look up
Returns:
the object bound to name
Throws:
javax.naming.NamingException if a naming exception is encountered
    public Object lookup(Name name)
        throws NamingException {
        if (name.isEmpty())
            return this;
        Entry entry = treeLookup(name);
        if (entry == null)
            throw new NamingException
                (.resourceNotFound(name.toString()));
        ZipEntry zipEntry = entry.getEntry();
        if (zipEntry.isDirectory())
            return new JARDirContext(entry);
        else
            return new JARResource(entry.getEntry());
    }


    
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
Throws:
javax.naming.NameNotFoundException if an intermediate context does not exist
javax.naming.NamingException if a naming exception is encountered
    public void unbind(String name)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
newName the name of the new binding; may not be empty
Throws:
javax.naming.NameAlreadyBoundException if newName is already bound
javax.naming.NamingException if a naming exception is encountered
    public void rename(String oldNameString newName)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
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:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration list(String name)
        throws NamingException {
        return list(new CompositeName(name));
    }


    
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
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:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration list(Name name)
        throws NamingException {
        if (name.isEmpty())
            return new NamingContextEnumeration(list().iterator());
        Entry entry = treeLookup(name);
        if (entry == null)
            throw new NamingException
                (.resourceNotFound(name.toString()));
        return new NamingContextEnumeration(list(entry).iterator());
    }


    
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
Returns:
an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration listBindings(String name)
        throws NamingException {
        return listBindings(new CompositeName(name));
    }


    
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
Returns:
an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration listBindings(Name name)
        throws NamingException {
        if (name.isEmpty())
            return new NamingContextBindingsEnumeration(list().iterator(),
                    this);
        Entry entry = treeLookup(name);
        if (entry == null)
            throw new NamingException
                (.resourceNotFound(name.toString()));
        return new NamingContextBindingsEnumeration(list(entry).iterator(),
                this);
    }


    
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
Throws:
javax.naming.NameNotFoundException if an intermediate context does not exist
javax.naming.NotContextException if the name is bound but does not name a context, or does not name a context of the appropriate type
    public void destroySubcontext(String name)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
Returns:
the object bound to name, not following the terminal link (if any).
Throws:
javax.naming.NamingException if a naming exception is encountered
    public Object lookupLink(String name)
        throws NamingException {
        // Note : Links are not supported
        return lookup(name);
    }


    
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.

Returns:
this context's name in its own namespace; never null
Throws:
javax.naming.OperationNotSupportedException if the naming system does not have the notion of a full name
javax.naming.NamingException if a naming exception is encountered
    public String getNameInNamespace()
        throws NamingException {
        return ;
    }
    // ----------------------------------------------------- DirContext Methods


    
Retrieves selected attributes associated with a named object. See the class description regarding attribute models, attribute type names, and operational attributes.

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:
javax.naming.NamingException if a naming exception is encountered
    public Attributes getAttributes(String nameString[] attrIds)
        throws NamingException {
        return getAttributes(new CompositeName(name), attrIds);
    }


    
Retrieves all of the attributes associated with a named object.

Parameters:
name the name of the object from which to retrieve attributes
Returns:
the set of attributes associated with name. Returns an empty attribute set if name has no attributes; never null.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public Attributes getAttributes(Name nameString[] attrIds)
        throws NamingException {
        
        Entry entry = null;
        if (name.isEmpty())
            entry = ;
        else
            entry = treeLookup(name);
        if (entry == null)
            throw new NamingException
                (.resourceNotFound(name.toString()));
        
        ZipEntry zipEntry = entry.getEntry();
        ResourceAttributes attrs = new ResourceAttributes();
        attrs.setCreationDate(new Date(zipEntry.getTime()));
        attrs.setName(entry.getName());
        if (!zipEntry.isDirectory())
            attrs.setResourceType("");
        attrs.setContentLength(zipEntry.getSize());
        attrs.setLastModified(zipEntry.getTime());
        
        return attrs;
        
    }


    
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
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:
javax.naming.directory.AttributeModificationException if the modification cannot be completed successfully
javax.naming.NamingException if a naming exception is encountered
    public void modifyAttributes(String nameint mod_opAttributes attrs)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
mods an ordered sequence of modifications to be performed; may not be null
Throws:
javax.naming.directory.AttributeModificationException if the modification cannot be completed successfully
javax.naming.NamingException if a naming exception is encountered
    public void modifyAttributes(String nameModificationItem[] mods)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
obj the object to bind; possibly null
attrs the attributes to associate with the binding
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if some "mandatory" attributes of the binding are not supplied
javax.naming.NamingException if a naming exception is encountered
    public void bind(String nameObject objAttributes attrs)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
obj the object to bind; possibly null
attrs the attributes to associate with the binding
Throws:
javax.naming.directory.InvalidAttributesException if some "mandatory" attributes of the binding are not supplied
javax.naming.NamingException if a naming exception is encountered
    public void rebind(String nameObject objAttributes attrs)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
attrs the attributes to associate with the newly created context
Returns:
the newly created context
Throws:
javax.naming.NameAlreadyBoundException if the name is already bound
javax.naming.directory.InvalidAttributesException if attrs does not contain all the mandatory attributes required for creation
javax.naming.NamingException if a naming exception is encountered
    public DirContext createSubcontext(String nameAttributes attrs)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
Returns:
the schema associated with the context; never null
Throws:
javax.naming.OperationNotSupportedException if schema not supported
javax.naming.NamingException if a naming exception is encountered
    public DirContext getSchema(String name)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
Returns:
the DirContext containing the named object's class definitions; never null
Throws:
javax.naming.OperationNotSupportedException if schema not supported
javax.naming.NamingException if a naming exception is encountered
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
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:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration search(String nameAttributes matchingAttributes,
                                    String[] attributesToReturn)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
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:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration search(String nameAttributes matchingAttributes)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
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:
javax.naming.directory.InvalidSearchFilterException if the search filter specified is not supported or understood by the underlying directory
javax.naming.directory.InvalidSearchControlsException if the search controls contain invalid settings
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration search(String nameString filter
                                    SearchControls cons)
        throws NamingException {
        throw new OperationNotSupportedException();
    }


    
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
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:
java.lang.ArrayIndexOutOfBoundsException if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs
javax.naming.directory.InvalidSearchControlsException if cons contains invalid settings
javax.naming.directory.InvalidSearchFilterException if filterExpr with filterArgs represents an invalid search filter
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration search(String nameString filterExpr
                                    Object[] filterArgsSearchControls cons)
        throws NamingException {
        throw new OperationNotSupportedException();
    }
    // ------------------------------------------------------ Protected Methods


    
Normalize the name of an entry read from the Zip.
    protected String normalize(ZipEntry entry) {
        String result = "/" + entry.getName();
        if (entry.isDirectory()) {
            result = result.substring(0, result.length() - 1);
        }
        return result;
    }


    
Constructs a tree of the entries contained in a WAR file.
    protected void loadEntries() {
        try {
            Enumeration<JarEntryentryList = .entries();
             = new Entry("/"new JarEntry( + "/"));
            
            while (entryList.hasMoreElements()) {
                
                JarEntry entry = entryList.nextElement();
                String name = normalize(entry);
                if ( != null && (!name.startsWith())) {
                    // Don't create entries for everything in the JAR if there is a prefix
                    continue;
                }
                int pos = name.lastIndexOf('/');
                // Check that parent entries exist and, if not, create them.
                // This fixes a bug for war files that don't record separate
                // zip entries for the directories.
                int currentPos = -1;
                int lastPos = 0;
                while ((currentPos = name.indexOf('/'lastPos)) != -1) {
                    Name parentName = new CompositeName(name.substring(.length(), lastPos));
                    Name childName = new CompositeName(name.substring(.length(), currentPos));
                    String entryName = name.substring(lastPoscurrentPos);
                    // Parent should have been created in last cycle through
                    // this loop
                    Entry parent = treeLookup(parentName);
                    Entry child = treeLookup(childName);
                    if (child == null) {
                        // Create a new entry for missing entry and strip off
                        // the leading '/' character and appended on by the
                        // normalize method and add '/' character to end to
                        // signify that it is a directory entry
                        String zipName = name.substring(1, currentPos) + "/";
                        child = new Entry(entryNamenew JarEntry(zipName));
                        if (parent != null)
                            parent.addChild(child);
                    }
                    // Increment lastPos
                    lastPos = currentPos + 1;
                }
                String entryName = name.substring(pos + 1, name.length());
                Name compositeName = new CompositeName(name.substring(0, pos));
                Entry parent = treeLookup(compositeName);
                Entry child = new Entry(entryNameentry);
                if (parent != null)
                    parent.addChild(child);
                
            }
        } catch (Exception e) {
        }
    }


    
Entry tree lookup.
    protected Entry treeLookup(Name name) {
        if (name.isEmpty())
            return ;
        Entry currentEntry = ;
        for (int i = 0; i < name.size(); i++) {
            if (name.get(i).length() == 0)
                continue;
            currentEntry = currentEntry.getChild(name.get(i));
            if (currentEntry == null)
                return null;
        }
        return currentEntry;
    }


    
List children as objects.
    protected ArrayList list(Entry entry) {
        
        ArrayList entries = new ArrayList();
        Entry[] children = entry.getChildren();
        Arrays.sort(children);
        NamingEntry namingEntry = null;
        
        for (int i = 0; i < children.lengthi++) {
            JarEntry current = children[i].getEntry();
            Object object = null;
            if (current.isDirectory()) {
                object = new JARDirContext(children[i]);
            } else {
                object = new JARResource(current);
            }
            namingEntry = new NamingEntry
                (children[i].getName(), object.);
            entries.add(namingEntry);
        }
        
        return entries;
        
    }
    // ---------------------------------------------------- Entries Inner Class


    
Entries structure.
    protected class Entry implements Comparable {
        // -------------------------------------------------------- Constructor
        
        
        public Entry(String nameJarEntry entry) {
            this. = name;
            this. = entry;
        }
        
        
        // --------------------------------------------------- Member Variables
        
        
        protected String name = null;
        
        
        protected JarEntry entry = null;
        
        
        protected Entry children[] = new Entry[0];
        
        
        // ----------------------------------------------------- Public Methods
        
        
        public int compareTo(Object o) {
            if (!(o instanceof Entry))
                return (+1);
            return (.compareTo(((Entryo).getName()));
        }
        public JarEntry getEntry() {
            return ;
        }
        
        
        public String getName() {
            return ;
        }
        
        
        public void addChild(Entry entry) {
            Entry[] newChildren = new Entry[. + 1];
            for (int i = 0; i < .i++)
                newChildren[i] = [i];
            newChildren[.] = entry;
             = newChildren;
        }
        public Entry[] getChildren() {
            return ;
        }
        public Entry getChild(String name) {
            for (int i = 0; i < .i++) {
                if ([i]..equals(name)) {
                    return [i];
                }
            }
            return null;
        }
    }
    // ------------------------------------------------ WARResource Inner Class


    
This specialized resource implementation avoids opening the IputStream to the JAR right away.
    protected class JARResource extends Resource {
        
        
        // -------------------------------------------------------- Constructor
        
        
        public JARResource(JarEntry entry) {
            this. = entry;
        }
        
        
        // --------------------------------------------------- Member Variables
        
        
        protected JarEntry entry;
        
        
        // ----------------------------------------------------- Public Methods
        
        
        
Content accessor.

Returns:
InputStream
        public InputStream streamContent()
            throws IOException {
            try {
                if ( == null) {
                     = .getInputStream();
                }
            } catch (ZipException e) {
                throw new IOException(e.getMessage());
            }
            return super.streamContent();
        }
        
        
    }
New to GrepCode? Check out our FAQ X