KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > deployers > spi > structure > vfs > StructureDeployer


1 /*
2  * JBoss, Home of Professional Open Source
3  * Copyright 2006, Red Hat Middleware LLC, and individual contributors
4  * by the @authors tag. See the copyright.txt in the distribution for a
5  * full listing of individual contributors.
6  *
7  * This is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22 package org.jboss.deployers.spi.structure.vfs;
23
24 import org.jboss.deployers.spi.OrderedDeployer;
25 import org.jboss.virtual.VirtualFile;
26
27 /**
28  * A StructureDeployer translates a deployment virtual file root into
29  * StructureMetaData representing the deployment contexts.
30  *
31  * @author <a HREF="adrian@jboss.com">Adrian Brock</a>
32  * @version $Revision: 1.1 $
33  */
34 public interface StructureDeployer extends OrderedDeployer
35 {
36    /**
37     * Determine the structure of a deployment
38     *
39     * @param file - the candidate root file of the deployment
40     * @param metaData - the structure metadata to build
41     * @param deployers - the available structure deployers
42     * @return true when it is recongnised
43     */
44    boolean determineStructure(VirtualFile file, StructureMetaData metaData, StructuredDeployers deployers);
45
46 }
47
Popular Tags