1 package org.apache.maven.plugins.ear;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.artifact.Artifact;
23 import org.apache.maven.plugin.MojoFailureException;
24 import org.codehaus.plexus.util.xml.XMLWriter;
25
26 import java.util.Set;
27
28 /**
29 * The {@link EarModule} implementation for a Web application module.
30 *
31 * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
32 */
33 public class WebModule
34 extends AbstractEarModule
35 {
36 private static final String WEB_MODULE = "web";
37
38 private static final String WEB_URI_FIELD = "web-uri";
39
40 private static final String CONTEXT_ROOT_FIELD = "context-root";
41
42 private String contextRoot;
43
44 /**
45 * Create an instance.
46 */
47 public WebModule()
48 {
49 }
50
51 /**
52 * @param a {@link Artifact}
53 */
54 public WebModule( Artifact a )
55 {
56 super( a );
57 this.contextRoot = getDefaultContextRoot( a );
58 }
59
60 /**
61 * {@inheritDoc}
62 */
63 public void appendModule( XMLWriter writer, String version, Boolean generateId )
64 {
65 startModuleElement( writer, generateId );
66 writer.startElement( WEB_MODULE );
67 writer.startElement( WEB_URI_FIELD );
68 writer.writeText( getUri() );
69 writer.endElement(); // web-uri
70
71 writer.startElement( CONTEXT_ROOT_FIELD );
72 writer.writeText( getContextRoot() );
73 writer.endElement(); // context-root
74
75 writer.endElement(); // web
76
77 writeAltDeploymentDescriptor( writer, version );
78
79 writer.endElement(); // module
80 }
81
82 /**
83 * {@inheritDoc}
84 */
85 public void resolveArtifact( Set<Artifact> artifacts )
86 throws EarPluginException, MojoFailureException
87 {
88 // Let's resolve the artifact
89 super.resolveArtifact( artifacts );
90
91 // Context root has not been customized - using default
92 if ( contextRoot == null )
93 {
94 contextRoot = getDefaultContextRoot( getArtifact() );
95 }
96 }
97
98 /**
99 * Returns the context root to use for the web module.
100 *
101 * Note that this might return <tt>null</tt> till the artifact has been resolved.
102 *
103 * @return the context root
104 */
105 public String getContextRoot()
106 {
107 return contextRoot;
108 }
109
110 /**
111 * {@inheritDoc}
112 */
113 public String getType()
114 {
115 return "war";
116 }
117
118 /**
119 * Generates a default context root for the given artifact, based on the <tt>artifactId</tt>.
120 *
121 * @param a the artifact
122 * @return a context root for the artifact
123 */
124 private static String getDefaultContextRoot( Artifact a )
125 {
126 if ( a == null )
127 {
128 throw new NullPointerException( "Artifact could not be null." );
129 }
130 return "/" + a.getArtifactId();
131 }
132
133 /**
134 * {@inheritDoc}
135 */
136 public String getLibDir()
137 {
138 return "WEB-INF/lib";
139 }
140 }