KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > deployers > spi > deployer > Deployer


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2006, JBoss Inc., and individual contributors as indicated
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.deployer;
23
24 import java.util.Comparator JavaDoc;
25
26 import org.jboss.deployers.spi.DeploymentException;
27 import org.jboss.deployers.spi.OrderedDeployer;
28
29 /**
30  * Deployer.
31  *
32  * TODO contract for redeployment
33  *
34  * @author <a HREF="adrian@jboss.com">Adrian Brock</a>
35  * @version $Revision: 1.1 $
36  */
37 public interface Deployer extends OrderedDeployer
38 {
39    /** The parser order */
40    public static final int PARSER_DEPLOYER = 2000;
41
42    /** The class loader order */
43    public static final int CLASSLOADER_DEPLOYER = 4000;
44
45    /** The postprocessing class loader order (usage: AOP) */
46    public static final int POSTPROCESS_CLASSLOADING_DEPLOYER = 5000;
47    
48    /** The component order */
49    public static final int COMPONENT_DEPLOYER = 7000;
50
51    /** The real order */
52    public static final int REAL_DEPLOYER = 10000;
53    
54    /**
55     * Whether the deployer is relevant for this unit
56     *
57     * @param unit the unit
58     * @return true when relevant
59     */
60    boolean isRelevant(DeploymentUnit unit);
61    
62    /**
63     * Prepare a deployment
64     *
65     * @param unit the unit
66     * @throws DeploymentException for any error
67     */
68    void prepareDeploy(DeploymentUnit unit) throws DeploymentException;
69
70    /**
71     * Prepare an undeployment
72     *
73     * @param unit the unit
74     */
75    void prepareUndeploy(DeploymentUnit unit);
76    
77    /**
78     * Handoff a deployment
79     *
80     * @param from the from deployment
81     * @param to the to deployment
82     * @throws DeploymentException for any error
83     */
84    void handoff(DeploymentUnit from, DeploymentUnit to) throws DeploymentException;
85    
86    /**
87     * Commit a deployment
88     *
89     * @param unit the unit
90     * @throws DeploymentException for any error
91     */
92    void commitDeploy(DeploymentUnit unit) throws DeploymentException;
93
94    /**
95     * Prepare an undeployment
96     *
97     * @param unit the unit
98     */
99    void commitUndeploy(DeploymentUnit unit);
100
101 }
102
Popular Tags