summaryrefslogtreecommitdiffstats
path: root/site/trunk/site-publish/plugins/tuscany-war-plugin/tuscany-war-mojo.html
blob: 8b94f92ecdd7cc249607fda8fad83e2e88ea876a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">










<html>
  <head>
    <title>Apache Tuscany War Plugin - 
    tuscany-war-plugin - tuscany-war:tuscany-war</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Apache Tuscany War Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 02/15/2007
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
        <ul>
              
    <li class="none">
              <a href="index.html">Introduction</a>
        </li>
              
    <li class="none">
              <a href="plugin-info.html">Goals</a>
        </li>
              
    <li class="none">
              <a href="usage.html">Usage</a>
        </li>
          </ul>
                                       <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        
  
  
    <a name="tuscany-war:tuscany-war"></a><div class="section"><h2>tuscany-war:tuscany-war</h2>
      <p>Build the tuscany war file by adding the tuscany dependencies.

Performs the following tasks.

<ul>
<li>Adds the boot dependencies transitively to WEB-INF/tuscany/boot</li>
<li>By default boot libraries are transitively resolved from webapp-host</li>
<li>The version of boot libraries can be specified using configuration/runTimeVersion element</li>
<li>Boot libraries can be overridden using the configuration/bootLibs element in the plugin</li>
<li>Adds the extension artifacts specified using configuration/extensions to WEB-INF/tuscany/extensions</li>
<li>If configuration/loadExtensionsDependency is set to true extension dependencies are transitivel loaded</li>
<li>Extension dependencies are loaded into WEB-INF/tuscany/repository directory in a Maven repo format</li>
<li>Extension dependency metadata is written to WEB-INF/tuscany/repository/dependency.metadata file</li>
</ul></p>
      <p><b>Mojo Attributes</b>:<ul>
          <li>Requires a Maven 2.0 project to execute.</li>
          <li>Automatically executes within the lifecycle phase: <code>package</code></li>
          </ul>
        </p>
      <a name="required_parameters"></a><div class="section"><h3>Required Parameters</h3>
        <table class="bodyTable">
          <tr class="a">
            <th>Name</th>
            <th>Type</th>
            <th>Description</th>
            </tr>
          <tr class="b">
            <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
            <td><code>String</code></td>
            <td>The directory for the generated WAR.</td>
            </tr>
          <tr class="a">
            <td><b><a href="#warName">warName</a></b></td>
            <td><code>String</code></td>
            <td>The name of the generated WAR.</td>
            </tr>
          </table>
        </div>
      <a name="optional_parameters"></a><div class="section"><h3>Optional Parameters</h3>
        <table class="bodyTable">
          <tr class="b">
            <th>Name</th>
            <th>Type</th>
            <th>Description</th>
            </tr>
          <tr class="a">
            <td><b><a href="#bootLibs">bootLibs</a></b></td>
            <td><code>Dependency[]</code></td>
            <td>The directory for the generated WAR.</td>
            </tr>
          <tr class="b">
            <td><b><a href="#dependencies">dependencies</a></b></td>
            <td><code>Dependency[]</code></td>
            <td>The directory for the generated WAR.</td>
            </tr>
          <tr class="a">
            <td><b><a href="#extensions">extensions</a></b></td>
            <td><code>Dependency[]</code></td>
            <td>The directory for the generated WAR.</td>
            </tr>
          <tr class="b">
            <td><b><a href="#loadExtensionDependencies">loadExtensionDependencies</a></b></td>
            <td><code>boolean</code></td>
            <td>A flag to indicate whether extension dependencies should be resolved transitively.</td>
            </tr>
          <tr class="a">
            <td><b><a href="#metadataSource">metadataSource</a></b></td>
            <td><code>ArtifactMetadataSource</code></td>
            <td>Artifact metadata source.</td>
            </tr>
          <tr class="b">
            <td><b><a href="#runTimeVersion">runTimeVersion</a></b></td>
            <td><code>String</code></td>
            <td>The default version of boot dependany jar files</td>
            </tr>
          </table>
        </div>
      <a name="parameter_details"></a><div class="section"><h3>Parameter Details</h3>
        <p><b><a name="bootlibs">bootLibs</a></b></p>
        <p>The directory for the generated WAR.</p>
        <ul>
          <li><b>Type</b>: <code>org.apache.tuscany.plugin.war.Dependency[]</code></li>
          <li><b>Required</b>: <code>No</code></li>
          </ul><hr></hr><p><b><a name="dependencies">dependencies</a></b></p>
        <p>The directory for the generated WAR.</p>
        <ul>
          <li><b>Type</b>: <code>org.apache.tuscany.plugin.war.Dependency[]</code></li>
          <li><b>Required</b>: <code>No</code></li>
          </ul><hr></hr><p><b><a name="extensions">extensions</a></b></p>
        <p>The directory for the generated WAR.</p>
        <ul>
          <li><b>Type</b>: <code>org.apache.tuscany.plugin.war.Dependency[]</code></li>
          <li><b>Required</b>: <code>No</code></li>
          </ul><hr></hr><p><b><a name="loadextensiondependencies">loadExtensionDependencies</a></b></p>
        <p>A flag to indicate whether extension dependencies should be resolved transitively.</p>
        <ul>
          <li><b>Type</b>: <code>boolean</code></li>
          <li><b>Required</b>: <code>No</code></li>
          </ul><hr></hr><p><b><a name="metadatasource">metadataSource</a></b></p>
        <p>Artifact metadata source.</p>
        <ul>
          <li><b>Type</b>: <code>org.apache.maven.artifact.metadata.ArtifactMetadataSource</code></li>
          <li><b>Required</b>: <code>No</code></li>
          </ul><hr></hr><p><b><a name="outputdirectory">outputDirectory</a></b></p>
        <p>The directory for the generated WAR.</p>
        <ul>
          <li><b>Type</b>: <code>java.lang.String</code></li>
          <li><b>Required</b>: <code>Yes</code></li>
          <li><b>Expression</b>: <code>${project.build.directory}</code></li>
          </ul><hr></hr><p><b><a name="runtimeversion">runTimeVersion</a></b></p>
        <p>The default version of boot dependany jar files</p>
        <ul>
          <li><b>Type</b>: <code>java.lang.String</code></li>
          <li><b>Required</b>: <code>No</code></li>
          </ul><hr></hr><p><b><a name="warname">warName</a></b></p>
        <p>The name of the generated WAR.</p>
        <ul>
          <li><b>Type</b>: <code>java.lang.String</code></li>
          <li><b>Required</b>: <code>Yes</code></li>
          <li><b>Expression</b>: <code>${project.build.finalName}</code></li>
          </ul>
        </div>
      </div>
    
  
      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2007
    
          Apache Software Foundation
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>