org.jboss.deployers.vfs.spi.structure
Interface StructureDeployer

All Superinterfaces:

org.jboss.deployers.spi.Ordered

All Known Implementing Classes:

AbstractStructureDeployer

public interface StructureDeployer
extends org.jboss.deployers.spi.Ordered

A StructureDeployer translates a deployment virtual file root into StructureMetaData representing the deployment contexts.

Version:

$Revision: 1.1 $

Author:

Adrian Brock

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.deployers.spi.Ordered

org.jboss.deployers.spi.Ordered.OrderedComparator

Field Summary

Fields inherited from interface org.jboss.deployers.spi.Ordered

COMPARATOR

Method Summary

boolean

determineStructure(org.jboss.virtual.VirtualFile root, org.jboss.virtual.VirtualFile parent, org.jboss.virtual.VirtualFile file, org.jboss.deployers.spi.structure.StructureMetaData metaData, VFSStructuralDeployers deployers) Determine the structure of a deployment

Methods inherited from interface org.jboss.deployers.spi.Ordered

getRelativeOrder, setRelativeOrder

Method Detail

determineStructure

boolean determineStructure(org.jboss.virtual.VirtualFile root,
                           org.jboss.virtual.VirtualFile parent,
                           org.jboss.virtual.VirtualFile file,
                           org.jboss.deployers.spi.structure.StructureMetaData metaData,
                           VFSStructuralDeployers deployers)
                           throws org.jboss.deployers.spi.DeploymentException

Determine the structure of a deployment

Parameters:

root - the root file

parent - the parent file

file - the candidate file of the deployment

metaData - the structure metadata to build

deployers - the available structure deployers

Returns:

true when it is recognised

Throws:

org.jboss.deployers.spi.DeploymentException - for any error