Skip to Content

Wiki source code of maven-japplication-plugin

Version 34.1 by Andrus Adamchik on 2007/02/27 09:12
Show last authors
1 == Description ==
2
3 "maven-japplication-plugin" is a plugin for assembling native launchers of Java applications for a number of target platforms. It will package current project artifact and all its declared and transitive dependencies into the launcher. Currently supports native launchers for Mac and Windows operating systems and also a "java launcher" - a single jar file that can be run via "java -jar file.jar".
4
5 "maven-japplication-plugin" is based on a [[JApplication Ant task>>doc:JApplication]] and has similar capabilities, however the Maven environment provides more information about the project, so plugin has fewer required parameters.
6
7 == OS Requirements ==
8
9 OS requirements are similar to those for [[JApplication Ant task>>doc:JApplication]], i.e. Mac launcher can only be built on Mac, and Windows launcher - on Windows.
10
11 == Goals ==
12
13 === {{code language="none"}}org.objectstyle.woproject.maven2:japplication:japplication{{/code}} ===
14
15 "japplication" is the only defined goal. Its purpose is to assemble a java launcher. It has the parameters described below. The difference from JApplication Ant task is in smarter defaults.
16
17 |=(((
18 Parameter
19 )))|=(((
20 Description
21 )))|=(((
22 Required
23 )))|=(((
24 Default
25 )))|=(((
26 Platforms
27 )))
28 |(((
29 name
30 )))|(((
31 The name of the application without OS-specific extension
32 )))|(((
33 No
34 )))|(((
35 {{code language="none"}}${project.artifact.artifactId{{/code}}}
36 )))|(((
37
38 )))
39 |(((
40 mainClass
41 )))|(((
42 Main Java class
43 )))|(((
44 Yes
45 )))|(((
46
47 )))|(((
48
49 )))
50 |(((
51 os
52 )))|(((
53 A family of operating systems. Currently supported values are "mac", "windows" and "java"
54 )))|(((
55 No
56 )))|(((
57 Build machine OS, if omitted; if the os is not supported, will use "java".
58 )))|(((
59
60 )))
61 |(((
62 destDir
63 )))|(((
64 A destination directory where the application launcher should be installed
65 )))|(((
66 No
67 )))|(((
68 {{code language="none"}}${project.build.directory{{/code}}} - usually {{code language="none"}}"target/"{{/code}}
69 )))|(((
70
71 )))
72 |(((
73 longName
74 )))|(((
75 An optional string identifying the application human-readable name. If not specified, "name" is used.
76 )))|(((
77 No
78 )))|(((
79 {{code language="none"}}${project.artifact.artifactId}-${project.artifact.version{{/code}}}
80 )))|(((
81
82 )))
83 |(((
84 icon
85 )))|(((
86 Platform-specific icon file (usually "*.ico" on Windows and "*.icns" on Mac)
87 )))|(((
88 No
89 )))|(((
90
91 )))|(((
92 mac,windows
93 )))
94 |(((
95 jvm
96 )))|(((
97 Minimal version of the Java Virtual machine required.
98 )))|(((
99 No
100 )))|(((
101 {{code language="none"}}1.4+{{/code}}
102 )))|(((
103 mac
104 )))
105 |(((
106 jvmOptions
107 )))|(((
108 Optional parameters to pass to the JVM, such as memory settings, etc.
109 )))|(((
110 No
111 )))|(((
112
113 )))|(((
114 mac,windows
115 )))
116 |(((
117 version
118 )))|(((
119 Product version string
120 )))|(((
121 No
122 )))|(((
123 {{code language="none"}}${project.artifact.version{{/code}}}
124 )))|(((
125 mac
126 )))
127
128 == Examples ==
129
130 A POM that builds a Foo application on Mac. All declared and transitive dependencies (not shown here) will be included in Foo.app automatically:
131
132 {{code title="pom.xml"}}
133 <?xml version="1.0" encoding="UTF-8"?>
134 <project xmlns="http://maven.apache.org/POM/4.0.0"
135 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
136 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
137
138 ...
139 <build>
140 <plugins>
141 <plugin>
142 <groupId>org.objectstyle.woproject.maven2</groupId>
143 <artifactId>maven-japplication-plugin</artifactId>
144 <configuration>
145 <name>Foo</name>
146 <mainClass>org.example.foo.Main</mainClass>
147 <os>mac</os>
148 </configuration>
149 <executions>
150 <execution>
151 <phase>package</phase>
152 <goals>
153 <goal>japplication</goal>
154 </goals>
155 </execution>
156 </executions>
157 </plugin>
158 </plugins>
159 </build>
160 </project>
161
162 {{/code}}