WebAppParsingDeployer


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.deployment;
23  
24  import org.jboss.deployers.plugins.deployers.helpers.ObjectModelFactoryDeployer;
25  import org.jboss.deployers.spi.DeploymentException;
26  import org.jboss.deployers.spi.deployer.DeploymentUnit;
27  import org.jboss.metadata.WebMetaData;
28  import org.jboss.metadata.web.WebMetaDataObjectFactory;
29  import org.jboss.xb.binding.ObjectModelFactory;
30  
31  /**
32   * An ObjectModelFactoryDeployer for translating web.xml descriptors into
33   * WebMetaData instances.
34   * 
35   * @author Scott.Stark@jboss.org
36   * @version $Revision:$
37   */
38  public class WebAppParsingDeployer extends ObjectModelFactoryDeployer<WebMetaData>
39  {
40     /** The name of the web-app descriptor in the deployment context metadata path */
41     private String   webXmlPath = "web.xml";
42  
43     public WebAppParsingDeployer()
44     {
45        super(WebMetaData.class);
46     }
47  
48     /**
49      * Get the virtual file path for the web-app descriptor in the
50      * DeploymentContext.getMetaDataPath.
51      * 
52      * @return the current virtual file path for the web-app descriptor
53      */
54     public String   getWebXmlPath()
55     {
56        return webXmlPath;
57     }
58     /**
59      * Set the virtual file path for the web-app descriptor in the
60      * DeploymentContext.getMetaDataLocation. The standard path is web.xml
61      * to be found in the WEB-INF metdata path.
62      * 
63      * @param webXmlPath - new virtual file path for the web-app descriptor
64      */
65     public void setWebXmlPath(String   webXmlPath)
66     {
67        this.webXmlPath = webXmlPath;
68     }
69  
70     /**
71      * Return WebMetaDataObjectFactory as our ObjectModelFactory.
72      * @return a new WebMetaDataObjectFactory instance
73      */
74     @Override  
75     protected ObjectModelFactory getObjectModelFactory(WebMetaData root)
76     {
77        return new WebMetaDataObjectFactory();
78     }
79  
80     /**
81      * Overriden to invoke createMetaData(unit, webXmlPath, null) to parse any
82      * webXmlPath descriptor into a WebMetaData instance.
83      */
84     @Override  
85     public void deploy(DeploymentUnit unit) throws DeploymentException
86     {
87        createMetaData(unit, webXmlPath, null);
88     }
89  
90  }
91
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags