org.jboss.deployers.vfs.plugins.structure.war
Class WARStructure

java.lang.Object
  extended by org.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
      extended by org.jboss.deployers.vfs.plugins.structure.AbstractVFSStructureDeployer
          extended by org.jboss.deployers.vfs.plugins.structure.war.WARStructure
All Implemented Interfaces:
Ordered, StructureDeployer

public class WARStructure
extends AbstractVFSStructureDeployer

WARStructure.

Version:
$Revision: 83811 $
Author:
Adrian Brock, Ales Justin

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jboss.deployers.spi.Ordered
Ordered.OrderedComparator
 
Field Summary
static org.jboss.virtual.VirtualFileFilter DEFAULT_WEB_INF_LIB_FILTER
          The default filter which allows jars/jar directories
 
Fields inherited from class org.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
log
 
Fields inherited from interface org.jboss.deployers.spi.Ordered
COMPARATOR
 
Constructor Summary
WARStructure()
          Sets the default relative order 1000.
 
Method Summary
 boolean determineStructure(StructureContext structureContext)
          Determine the structure of a deployment
 org.jboss.virtual.VirtualFileFilter getWebInfLibFilter()
          Get the webInfLibFilter.
 org.jboss.virtual.VirtualFileFilter getWebInfLibMetaDataFilter()
          Get webInfLibMetaDataFilter
 void setIncludeWebInfInClasspath(boolean includeWebInfInClasspath)
          Should we include web-inf in classpath.
 void setWebInfLibFilter(org.jboss.virtual.VirtualFileFilter webInfLibFilter)
          Set the webInfLibFilter.
 void setWebInfLibMetaDataFilter(org.jboss.virtual.VirtualFileFilter webInfLibMetaDataFilter)
          Set the webInfLibMetaDataFilter.
 
Methods inherited from class org.jboss.deployers.vfs.plugins.structure.AbstractVFSStructureDeployer
createAnnotationEnvironment, setExcluded, setFilter, setIncluded, setRecurseFilter
 
Methods inherited from class org.jboss.deployers.vfs.spi.structure.helpers.AbstractStructureDeployer
addAllChildren, addAllChildren, addCandidateAnnotation, addChildren, addChildren, addClassPath, applyContextInfo, applyMetadataPath, applyMetadataPaths, applyStructure, checkCandidateAnnotations, createContext, createContext, createContext, getCandidateAnnotations, getCandidateStructureVisitorFactory, getRelativeOrder, getRelativePath, getRelativePath, isLeaf, isSupportsCandidateAnnotations, setCandidateAnnotations, setCandidateStructureVisitorFactory, setContextInfoOrder, setRelativeOrder, setSupportsCandidateAnnotations
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_WEB_INF_LIB_FILTER

public static final org.jboss.virtual.VirtualFileFilter DEFAULT_WEB_INF_LIB_FILTER
The default filter which allows jars/jar directories

Constructor Detail

WARStructure

public WARStructure()
Sets the default relative order 1000.

Method Detail

getWebInfLibFilter

public org.jboss.virtual.VirtualFileFilter getWebInfLibFilter()
Get the webInfLibFilter.

Returns:
the webInfLibFilter.

setWebInfLibFilter

public void setWebInfLibFilter(org.jboss.virtual.VirtualFileFilter webInfLibFilter)
Set the webInfLibFilter.

Parameters:
webInfLibFilter - the webInfLibFilter.
Throws:
IllegalArgumentException - for a null filter

getWebInfLibMetaDataFilter

public org.jboss.virtual.VirtualFileFilter getWebInfLibMetaDataFilter()
Get webInfLibMetaDataFilter

Returns:
the webInfLibMetaDataFilter

setWebInfLibMetaDataFilter

public void setWebInfLibMetaDataFilter(org.jboss.virtual.VirtualFileFilter webInfLibMetaDataFilter)
Set the webInfLibMetaDataFilter.

Parameters:
webInfLibMetaDataFilter - the webInfLibFilter.

setIncludeWebInfInClasspath

public void setIncludeWebInfInClasspath(boolean includeWebInfInClasspath)
Should we include web-inf in classpath.

Parameters:
includeWebInfInClasspath - the include web-inf flag

determineStructure

public boolean determineStructure(StructureContext structureContext)
                           throws DeploymentException
Description copied from interface: StructureDeployer
Determine the structure of a deployment

Parameters:
structureContext - the structure context
Returns:
true when it recognised the context
Throws:
DeploymentException - for an error


Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.