/*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.deployers.vfs.plugins.structure.war;
import java.io.IOException;
import java.util.List;
import org.jboss.deployers.spi.DeploymentException;
import org.jboss.deployers.spi.structure.ContextInfo;
import org.jboss.deployers.vfs.plugins.structure.AbstractVFSStructureDeployer;
import org.jboss.deployers.vfs.spi.structure.StructureContext;
import org.jboss.virtual.VirtualFile;
import org.jboss.virtual.VirtualFileFilter;
import org.jboss.virtual.VisitorAttributes;
import org.jboss.virtual.plugins.vfs.helpers.SuffixMatchFilter;
/**
* WARStructure.
*
* @author <a href="adrian@jboss.com">Adrian Brock</a>
* @version $Revision: 1.1 $
*/
public class WARStructure extends AbstractVFSStructureDeployer
{
/** The default filter which allows jars/jar directories */
public static final VirtualFileFilter DEFAULT_WEB_INF_LIB_FILTER = new SuffixMatchFilter(".jar", VisitorAttributes.DEFAULT);
/** The web-inf/lib filter */
private VirtualFileFilter webInfLibFilter = DEFAULT_WEB_INF_LIB_FILTER;
/**
* Sets the default relative order 1000.
*
*/
public WARStructure()
{
setRelativeOrder(1000);
}
/**
* Get the webInfLibFilter.
*
* @return the webInfLibFilter.
*/
public VirtualFileFilter getWebInfLibFilter()
{
return webInfLibFilter;
}
/**
* Set the webInfLibFilter.
*
* @param webInfLibFilter the webInfLibFilter.
* @throws IllegalArgumentException for a null filter
*/
public void setWebInfLibFilter(VirtualFileFilter webInfLibFilter)
{
if (webInfLibFilter == null)
throw new IllegalArgumentException("Null filter");
this.webInfLibFilter = webInfLibFilter;
}
public boolean determineStructure(StructureContext structureContext) throws DeploymentException
{
ContextInfo context = null;
VirtualFile file = structureContext.getFile();
try
{
boolean trace = log.isTraceEnabled();
if (isLeaf(file) == false)
{
// We require either a WEB-INF or the name ends in .war
if (file.getName().endsWith(".war") == false)
{
try
{
VirtualFile child = file.getChild("WEB-INF");
if (child != null)
{
if (trace)
log.trace("... ok - directory has a WEB-INF subdirectory");
}
else
{
if (trace)
log.trace("... no - doesn't look like a war and no WEB-INF subdirectory.");
return false;
}
}
catch (IOException e)
{
log.warn("Exception while checking if file is a war: " + e);
return false;
}
}
else if (trace)
{
log.trace("... ok - name ends in .war.");
}
// Create a context for this war file with WEB-INF as the location for metadata
// Some wars also might have metadata in WEB-INF/classes/META-INF, e.g. persistence.xml
context = createContext(structureContext, new String[]{"WEB-INF", "WEB-INF/classes/META-INF"});
// Add the war manifest classpath entries
addClassPath(structureContext, file, false, true, context);
try
{
// The classpath is WEB-INF/classes
VirtualFile classes = file.getChild("WEB-INF/classes");
// Add the war manifest classpath entries
if (classes != null)
addClassPath(structureContext, classes, true, false, context);
else if (trace)
log.trace("No WEB-INF/classes for: " + file.getPathName());
}
catch(IOException e)
{
log.warn("Exception while looking for classes, " + file.getPathName() + ", " + e);
}
// and the top level jars in WEB-INF/lib
try
{
VirtualFile webinfLib = file.getChild("WEB-INF/lib");
if (webinfLib != null)
{
List<VirtualFile> archives = webinfLib.getChildren(webInfLibFilter);
for (VirtualFile jar : archives)
addClassPath(structureContext, jar, true, true, context);
}
else if (trace)
log.trace("No WEB-INF/lib for: " + file.getPathName());
}
catch (IOException e)
{
log.warn("Exception looking for WEB-INF/lib, " + file.getPathName() + ", " + e);
}
// There are no subdeployments for wars
return true;
}
else
{
if (trace)
log.trace("... no - not a directory or an archive.");
return false;
}
}
catch (Exception e)
{
// Remove the invalid context
if (context != null)
structureContext.removeChild(context);
throw DeploymentException.rethrowAsDeploymentException("Error determining structure: " + file.getName(), e);
}
}
}