Skip to Content
Last modified by Ulrich Köster on 2009/08/02 20:26
From version 26.1
edited by Henrique Prange
on 2023/11/13 11:56
Change comment: Renamed from xwiki:WOL.Packaging WO Applications as true WAR with Maven
To version 9.1
edited by Henrique Prange
on 2009/08/02 20:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -WOProject-Maven
Tags
... ... @@ -1,1 +1,0 @@
1 -favourite
Content
... ... @@ -1,10 +1,10 @@
1 -If you have used the [[doc:woapplication-archetype]] to create your project, jump to the step 3.
1 +If you have used the [[woapplication-archetype]] to create your project, jump to the step 3.
2 2  
3 3  You have to follow some instructions to build a true WAR package:
4 4  
5 5  == Step 1: Create a web.xml file ==
6 6  
7 -You need to create a web.xml file. You can download a simple web.xml file [[here>>attach:web.xml]]. Don't forget to change the displayName and the WOMainBundle properties:
7 +You need to create a web.xml file. You can download a simple web.xml file [[here>>^web.xml]]. Don't forget to change the displayName and the WOMainBundle properties:
8 8  
9 9  {{noformat}}
10 10  
... ... @@ -23,7 +23,7 @@
23 23  
24 24  == Step 2: Create/generate an Info.plist file ==
25 25  
26 -You also need to create or generate a valid Info.plist file into your resources folder. [[Here>>attach:Info.plist]] is a sample Info.plist. You have to change the ${your-app-name} and ${package} occurrences with the respective application name and Application class package.
26 +You also need to create or generate a valid Info.plist file into your resources folder. [[Here>>^Info.plist]] is a sample Info.plist. You have to change the $your-app-name and $package occurrences with the respective application name and Application class package.
27 27  
28 28  == Step 3: Package your classes, resources and webserver resources ==
29 29  
... ... @@ -103,11 +103,11 @@
103 103  
104 104  {{/noformat}}
105 105  
106 -Read this [[tutorial>>url:http://wiki.objectstyle.org/confluence/display/WONDER/Creating+a+wonder+app+to+deploy+as+a+servlet||shape="rect"]] to find how to configure the ERXServletAdaptor in your application.
106 +Read this [[tutorial>>http://wiki.objectstyle.org/confluence/display/WONDER/Creating+a+wonder+app+to+deploy+as+a+servlet]] to find how to configure the ERXServletAdaptor in your application.
107 107  
108 108  == Step 5: Change the packaging type ==
109 109  
110 -The default [[maven-war-plugin>>url:http://maven.apache.org/plugins/maven-war-plugin/||shape="rect"]] can handle the war packaging correctly. You have to change the packaging of your POM to 'war' in order to use this plug-in:
110 +The default [[maven-war-plugin>>http://maven.apache.org/plugins/maven-war-plugin/]] can handle the war packaging correctly. You have to change the packaging of your POM to 'war' in order to use this plug-in:
111 111  
112 112  {{noformat}}
113 113  
... ... @@ -119,7 +119,7 @@
119 119  
120 120  == Step 6: Filtering variables with Maven (OPTIONAL) ==
121 121  
122 -Maven supports variable substitution during build time. It is called resource filtering. You can find more information about resource filtering [[here>>url:http://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html||shape="rect"]] and [[here>>url:http://www.sonatype.com/books/maven-book/reference/resource-filtering-sect-description.html||shape="rect"]].
122 +Maven supports variable substitution during build time. It is called resource filtering. You can find more information about resource filtering [[here>>http://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html]] and [[here>>http://www.sonatype.com/books/maven-book/reference/resource-filtering-sect-description.html]].
123 123  
124 124  If you are using variables in your resource files (i.e. the Info.plist), you have to configure Maven to filter the Resources folder like this:
125 125  
... ... @@ -165,7 +165,7 @@
165 165  
166 166  = Running your application as true WAR =
167 167  
168 -You can use the [[maven-jetty-plugin>>url:http://docs.codehaus.org/display/JETTY/Maven+Jetty+Plugin||shape="rect"]] to run and test your application.
168 +You can use the [[maven-jetty-plugin>>http://docs.codehaus.org/display/JETTY/Maven+Jetty+Plugin]] to run and test your application.
169 169  
170 170  == Step 1: Configure the maven-jetty-plugin ==
171 171  
... ... @@ -196,4 +196,4 @@
196 196  
197 197  == Step 3: See the result ==
198 198  
199 -Open a browser and type the URL for your application like this: [[http:~~/~~/locahost:8080/your-app-name/WebObjects/>>url:http://locahost:8080/your-app-name/WebObjects/||shape="rect"]]
199 +Open a browser and type the URL for your application like this: [[http://locahost:8080/your-app-name/WebObjects/]]
Info.plist
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -1.3 KB
Content
web.xml
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -2.6 KB
Content
... ... @@ -1,76 +1,0 @@
1 -<?xml version="1.0" encoding="UTF-8" ?>
2 -
3 -<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web
4 -Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
5 -
6 -<!-- This web.xml file by itself will allow you to run the corresponding
7 - WebObjects application in a Servlet container. If you would like to
8 - merge the WebObjects application with your existing JSP/Servlet
9 - application, you have to merge this web.xml with your existing web.xml.
10 -
11 - NOTE: This file is normally included as the template file 'web.xml.template'.
12 - During the build process, the placeholders for WOROOT, LOCALROOT, WOAINSTALLROOT,
13 - WOAppMode, WOClassPath, WOApplicationClass and WOtaglib will be replaced
14 - with the appropriate values. Other parts of the template file may be
15 - customized as required.
16 -
17 - NOTE: WEBINFROOT is added to the WOClassPath at build time, but the replacement
18 - value is replaced at runtime to be the path to the WEB-INF directory.
19 --->
20 -
21 -<web-app>
22 - <display-name>Your Application Name</display-name>
23 - <context-param>
24 - <param-name>WOJarBundle</param-name>
25 - <param-value>YES</param-value>
26 - <description>
27 - Whether this app is a "true" WAR, rather than a "stub" WAR
28 - or SSDD Note that WOROOT, LOCALROOT, WOAINSTALLROOT,
29 - WOClassPath are ignored if this is true However, if this is
30 - true, WOMainBundle must be set to the main bundle name
31 - </description>
32 - </context-param>
33 -
34 - <context-param>
35 - <param-name>WOMainBundle</param-name>
36 - <param-value>your-app-name</param-value>
37 - <description>
38 - Sets the name of the main bundle. Only used if WOJarBundle
39 - is true
40 - </description>
41 - </context-param>
42 -
43 - <!-- Indicates if application is development or deployment mode. In development
44 - mode, images are vended by the application directly from frameworks. In
45 - deployment mode, images are vended by the webserver. -->
46 - <context-param>
47 - <param-name>WOAppMode</param-name>
48 - <param-value>development</param-value>
49 - </context-param>
50 -
51 - <!-- Class name of the WOApplication subclass that defines the
52 - WebObjects application. -->
53 - <context-param>
54 - <param-name>WOApplicationClass</param-name>
55 - <param-value>
56 - your.package.Application
57 - </param-value>
58 - </context-param>
59 -
60 - <!-- The WebObjects Servlet that interfaces between the Servlet container
61 - world and the WebObjects world. -->
62 - <servlet>
63 - <servlet-name>WOServletAdaptor</servlet-name>
64 - <servlet-class>
65 - com.webobjects.jspservlet.WOServletAdaptor
66 - </servlet-class>
67 - <load-on-startup>5</load-on-startup>
68 - </servlet>
69 -
70 - <!-- URLs starting with 'WebObjects' use the WebObjects Servlet adaptor. -->
71 - <servlet-mapping>
72 - <servlet-name>WOServletAdaptor</servlet-name>
73 - <url-pattern>/WebObjects/*</url-pattern>
74 - </servlet-mapping>
75 -</web-app>
76 -