Skip to content

Commit

Permalink
Add documentation for CARGO-1628
Browse files Browse the repository at this point in the history
  • Loading branch information
alitokmen committed May 5, 2024
1 parent c9ce94f commit 88a2b9f
Show file tree
Hide file tree
Showing 9 changed files with 453 additions and 19 deletions.
16 changes: 8 additions & 8 deletions cargo/Container.html
Original file line number Diff line number Diff line change
Expand Up @@ -352,20 +352,20 @@ <h3 id="Container-Containerfeatures">Container features</h3>
<li><a href="Remote+Container.html">Remote Container</a><span class="smalltext">A container that is already running on some machine (local or remote)</span></li>
<li><a href="Local+Container.html">Local Container</a><span class="smalltext">A container executing on the machine where Cargo executes</span>
<ul class="childpages-macro">
<li><a href="Container+Start.html">Container Start</a><span class="smalltext">Start a container that is not already running</span></li>
<li><a href="Container+Stop.html">Container Stop</a><span class="smalltext">Stop a running container</span></li>
<li><a href="Container+Classpath.html">Container Classpath</a><span class="smalltext">How to configure the executing container's classpath</span>
<li><a href="Container+Timeout.html">Container Timeout</a><span class="smalltext">Timeout after which the container start/stop is deemed failed</span></li>
<li><a href="Installed+Container.html">Installed Container</a><span class="smalltext">A container installed on the machine where Cargo executes.</span>
<ul class="childpages-macro">
<li><a href="JBoss+7.x+onwards+and+WildFly+container+classpath.html">JBoss 7.x onwards and WildFly container classpath</a></li>
<li><a href="Application+Classpath.html">Application Classpath</a><span class="smalltext">How to configure the classpath of the application without changing the container's own classpath</span></li>
<li><a href="Installer.html">Installer</a><span class="smalltext">Installs a container</span></li>
<li><a href="Passing+system+properties.html">Passing system properties</a><span class="smalltext">How to pass system properties that will be available to the container while executing</span></li>
</ul></li>
<li><a href="Embedded+Container.html">Embedded Container</a><span class="smalltext">A container executing in the same JVM where Cargo is running</span></li>
<li><a href="Container+Start.html">Container Start</a><span class="smalltext">Start a container that is not already running</span></li>
<li><a href="Installed+Container.html">Installed Container</a><span class="smalltext">A container installed on the machine where Cargo executes.</span>
<li><a href="Container+Classpath.html">Container Classpath</a><span class="smalltext">How to configure the executing container's classpath</span>
<ul class="childpages-macro">
<li><a href="Passing+system+properties.html">Passing system properties</a><span class="smalltext">How to pass system properties that will be available to the container while executing</span></li>
<li><a href="Installer.html">Installer</a><span class="smalltext">Installs a container</span></li>
<li><a href="JBoss+7.x+onwards+and+WildFly+container+classpath.html">JBoss 7.x onwards and WildFly container classpath</a></li>
<li><a href="Application+Classpath.html">Application Classpath</a><span class="smalltext">How to configure the classpath of the application without changing the container's own classpath</span></li>
</ul></li>
<li><a href="Container+Timeout.html">Container Timeout</a><span class="smalltext">Timeout after which the container start/stop is deemed failed</span></li>
</ul></li>
</ul>
<p></p>
Expand Down
427 changes: 427 additions & 0 deletions cargo/Deploying+legacy+WARs+to+Tomcat+10.x+onwards.html

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion cargo/Features.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,10 @@ <h3 id="Navigation-Development">Development</h3>
<li><a href="Static+deployment+of+expanded+WAR.html">Static deployment of expanded WAR</a><span class="smalltext">Deploy an expanded WAR that will be started when the container starts</span></li>
<li><a href="Static+deployment+of+OSGi+Bundles.html">Static deployment of OSGi Bundles</a><span class="smalltext">Deploy an OSGi bundle that will be started when the container starts</span></li>
<li><a href="Static+deployment+of+RAR.html">Static deployment of RAR</a><span class="smalltext">Deploy a Java EE resource adapter (RAR) that will be started when the container starts</span></li>
<li><a href="Static+deployment+of+WAR.html">Static deployment of WAR</a><span class="smalltext">Deploy a WAR that will be started when the container starts</span></li>
<li><a href="Static+deployment+of+WAR.html">Static deployment of WAR</a><span class="smalltext">Deploy a WAR that will be started when the container starts</span>
<ul class="childpages-macro">
<li><a href="Deploying+legacy+WARs+to+Tomcat+10.x+onwards.html">Deploying legacy WARs to Tomcat 10.x onwards</a><span class="smalltext">Deploying J2EE / Java EE WARs on Tomcat 10.x onwards (which is Jakarta EE)</span></li>
</ul></li>
</ul></li>
</ul></li>
<li><a href="Extensions.html">Extensions</a><span class="smalltext">Extensions are additions to the Cargo core Java API such as build tool plugins, IDE plugins, etc</span>
Expand Down
16 changes: 8 additions & 8 deletions cargo/Local+Container.html
Original file line number Diff line number Diff line change
Expand Up @@ -326,20 +326,20 @@ <h3 id="LocalContainer-Explanation">Explanation</h3>
</center>
<h3 id="LocalContainer-Containerfeatures">Container features</h3>
<ul class="childpages-macro conf-macro output-block">
<li><a href="Container+Start.html">Container Start</a><span class="smalltext">Start a container that is not already running</span></li>
<li><a href="Container+Stop.html">Container Stop</a><span class="smalltext">Stop a running container</span></li>
<li><a href="Container+Classpath.html">Container Classpath</a><span class="smalltext">How to configure the executing container's classpath</span>
<li><a href="Container+Timeout.html">Container Timeout</a><span class="smalltext">Timeout after which the container start/stop is deemed failed</span></li>
<li><a href="Installed+Container.html">Installed Container</a><span class="smalltext">A container installed on the machine where Cargo executes.</span>
<ul class="childpages-macro">
<li><a href="JBoss+7.x+onwards+and+WildFly+container+classpath.html">JBoss 7.x onwards and WildFly container classpath</a></li>
<li><a href="Application+Classpath.html">Application Classpath</a><span class="smalltext">How to configure the classpath of the application without changing the container's own classpath</span></li>
<li><a href="Installer.html">Installer</a><span class="smalltext">Installs a container</span></li>
<li><a href="Passing+system+properties.html">Passing system properties</a><span class="smalltext">How to pass system properties that will be available to the container while executing</span></li>
</ul></li>
<li><a href="Embedded+Container.html">Embedded Container</a><span class="smalltext">A container executing in the same JVM where Cargo is running</span></li>
<li><a href="Container+Start.html">Container Start</a><span class="smalltext">Start a container that is not already running</span></li>
<li><a href="Installed+Container.html">Installed Container</a><span class="smalltext">A container installed on the machine where Cargo executes.</span>
<li><a href="Container+Classpath.html">Container Classpath</a><span class="smalltext">How to configure the executing container's classpath</span>
<ul class="childpages-macro">
<li><a href="Passing+system+properties.html">Passing system properties</a><span class="smalltext">How to pass system properties that will be available to the container while executing</span></li>
<li><a href="Installer.html">Installer</a><span class="smalltext">Installs a container</span></li>
<li><a href="JBoss+7.x+onwards+and+WildFly+container+classpath.html">JBoss 7.x onwards and WildFly container classpath</a></li>
<li><a href="Application+Classpath.html">Application Classpath</a><span class="smalltext">How to configure the classpath of the application without changing the container's own classpath</span></li>
</ul></li>
<li><a href="Container+Timeout.html">Container Timeout</a><span class="smalltext">Timeout after which the container start/stop is deemed failed</span></li>
</ul></td>
</tr>
</tbody>
Expand Down
3 changes: 2 additions & 1 deletion cargo/Project+Structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -461,10 +461,11 @@ <h3 id="Navigation-Development">Development</h3>
<li><span style="color: red;"><strong>tomcat6x-embedded-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with an embedded Tomcat 6.x container</li>
<li><span style="color: red;"><strong>tomcat7x-context-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with a Tomcat 7.x container and a user-defined context</li>
<li><span style="color: red;"><strong>tomcat7x-embedded-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with an embedded Tomcat 7.x container</li>
<li><span style="color: red;"><strong>tomcat7x-systemProperty-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with a Tomcat 7.x container and a user-defined system properties</li>
<li><span style="color: red;"><strong>tomcat7x-systemProperty-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with a Tomcat 7.x container and user-defined system properties</li>
<li><span style="color: red;"><strong>tomcat8x-embedded-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with an embedded Tomcat 8.x container</li>
<li><span style="color: red;"><strong>tomcat9x-embedded-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with an embedded Tomcat 9.x container</li>
<li><span style="color: red;"><strong>tomcat10x-embedded-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with an embedded Tomcat 10.x container</li>
<li><span style="color: red;"><strong>tomcat10x-legacyWar-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with a Tomcat 10.x container and a legacy WAR</li>
<li><span style="color: red;"><strong>tomcat11x-embedded-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin with an embedded Tomcat 11.x container</li>
<li><span style="color: red;"><strong>uberwar-test/</strong></span>: Sample application that exercises the Cargo Maven 3 plugin's uberwar feature</li>
<li><span style="color: red;"><strong>users-test/</strong></span>: Sample application that will be used to test configuration of users and roles.</li>
Expand Down
2 changes: 1 addition & 1 deletion cargo/Static+deployment+of+WAR.html
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ <h3 id="Navigation-Development">Development</h3>
<tr valign="top">
<td class="rightColumn">
<h3 id="StaticdeploymentofWAR-Definition">Definition</h3>Deploy a WAR that will be started when the container starts
<h3 id="StaticdeploymentofWAR-Example">Example</h3>
<h3 id="StaticdeploymentofWAR-ExampleusingtheJavaAPI">Example using the Java API</h3>
<p>Let's see how to use Jetty 4.x (an <a href="Embedded+Container.html">embedded container</a>) with a WAR to deploy in it.</p>
<div class="code panel pdl conf-macro output-block" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
Expand Down
1 change: 1 addition & 0 deletions cargo/TomEE+9.x.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ <h3 id="Navigation-Development">Development</h3>
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"> </span>
<div class="confluence-information-macro-body">
<p>Users of TomEE 9.x onwards should be aware that, as a result of the move from Java EE to Jakarta EE as part of the transfer of Java EE to the Eclipse Foundation, the primary package for all implemented APIs has changed from <code>javax.*</code> to <code>jakarta.*</code>. This will almost certainly require code changes to enable applications to migrate to TomEE 9.x and later.</p>
<p>TomEE 9 has an integrated functionality for automatically migrating J2EE / Java EE WARs to Jakarta EE. You can follow the instructions on <a href="Deploying+legacy+WARs+to+Tomcat+10.x+onwards.html">Deploying legacy WARs to Tomcat 10.x onwards</a> to make use of it.</p>
</div>
</div>
<h3 id="TomEE9.x-ContainerFeatures">Container Features</h3>
Expand Down
1 change: 1 addition & 0 deletions cargo/Tomcat+10.x.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ <h3 id="Navigation-Development">Development</h3>
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"> </span>
<div class="confluence-information-macro-body">
<p>Users of Tomcat 10.x onwards should be aware that, as a result of the move from Java EE to Jakarta EE as part of the transfer of Java EE to the Eclipse Foundation, the primary package for all implemented APIs has changed from <code>javax.*</code> to <code>jakarta.*</code>. This will almost certainly require code changes to enable applications to migrate to Tomcat 10.x and later.</p>
<p>Tomcat 10 has an integrated functionality for automatically migrating J2EE / Java EE WARs to Jakarta EE. You can follow the instructions on <a href="Deploying+legacy+WARs+to+Tomcat+10.x+onwards.html">Deploying legacy WARs to Tomcat 10.x onwards</a> to make use of it.</p>
</div>
</div>
<h3 id="Tomcat10.x-ContainerFeatures">Container Features</h3>
Expand Down
1 change: 1 addition & 0 deletions cargo/Tomcat+11.x.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ <h3 id="Navigation-Development">Development</h3>
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"> </span>
<div class="confluence-information-macro-body">
<p>Users of Tomcat 10.x onwards should be aware that, as a result of the move from Java EE to Jakarta EE as part of the transfer of Java EE to the Eclipse Foundation, the primary package for all implemented APIs has changed from <code>javax.*</code> to <code>jakarta.*</code>. This will almost certainly require code changes to enable applications to migrate to Tomcat 10.x and later.</p>
<p>Tomcat 10 has an integrated functionality for automatically migrating J2EE / Java EE WARs to Jakarta EE. You can follow the instructions on <a href="Deploying+legacy+WARs+to+Tomcat+10.x+onwards.html">Deploying legacy WARs to Tomcat 10.x onwards</a> to make use of it.</p>
</div>
</div>
<h3 id="Tomcat11.x-ContainerFeatures">Container Features</h3>
Expand Down

0 comments on commit 88a2b9f

Please sign in to comment.