summary refs log tree commit diff
path: root/doc/languages-frameworks/java.xml
blob: dcf4d17fa57d86dd185a4f05e162f48c75caf3f0 (plain) (blame)
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
<section xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xml:id="sec-language-java">
 <title>Java</title>

 <para>
  Ant-based Java packages are typically built from source as follows:
<programlisting>
stdenv.mkDerivation {
  name = "...";
  src = fetchurl { ... };

  buildInputs = [ jdk ant ];

  buildPhase = "ant";
}
</programlisting>
  Note that <varname>jdk</varname> is an alias for the OpenJDK.
 </para>

 <para>
  JAR files that are intended to be used by other packages should be installed
  in <filename>$out/share/java</filename>. The OpenJDK has a stdenv setup hook
  that adds any JARs in the <filename>share/java</filename> directories of the
  build inputs to the <envar>CLASSPATH</envar> environment variable. For
  instance, if the package <literal>libfoo</literal> installs a JAR named
  <filename>foo.jar</filename> in its <filename>share/java</filename>
  directory, and another package declares the attribute
<programlisting>
buildInputs = [ jdk libfoo ];
</programlisting>
  then <envar>CLASSPATH</envar> will be set to
  <filename>/nix/store/...-libfoo/share/java/foo.jar</filename>.
 </para>

 <para>
  Private JARs should be installed in a location like
  <filename>$out/share/<replaceable>package-name</replaceable></filename>.
 </para>

 <para>
  If your Java package provides a program, you need to generate a wrapper
  script to run it using the OpenJRE. You can use
  <literal>makeWrapper</literal> for this:
<programlisting>
buildInputs = [ makeWrapper ];

installPhase =
  ''
    mkdir -p $out/bin
    makeWrapper ${jre}/bin/java $out/bin/foo \
      --add-flags "-cp $out/share/java/foo.jar org.foo.Main"
  '';
</programlisting>
  Note the use of <literal>jre</literal>, which is the part of the OpenJDK
  package that contains the Java Runtime Environment. By using
  <literal>${jre}/bin/java</literal> instead of
  <literal>${jdk}/bin/java</literal>, you prevent your package from depending
  on the JDK at runtime.
 </para>

 <para>
  It is possible to use a different Java compiler than <command>javac</command>
  from the OpenJDK. For instance, to use the GNU Java Compiler:
<programlisting>
buildInputs = [ gcj ant ];
</programlisting>
  Here, Ant will automatically use <command>gij</command> (the GNU Java
  Runtime) instead of the OpenJRE.
 </para>
</section>