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
|
# Building Ice for Java
This page describes how to build and install Ice for Java from source code. If
you prefer, you can also download [binary distributions][1] for the supported
platforms.
## Build Requirements
### Operating Systems
Ice for Java is expected to build and run properly on Windows, macOS, and any
recent Linux distribution for x86_64 (or ix86), and was extensively tested using
the operating systems and compiler versions listed for our [supported
platforms][2]. Due to the portability of Java, it is very likely that it will
also work on other platforms for which a suitable Java implementation is
available.
### Slice to Java Compiler
You will need the Slice to Java compiler. ZeroC provides compiler binaries
for our supported platforms. For other platforms, you will have to either port
Ice for C++ (which contains the Slice to Java compiler), or you will have to
translate your Slice files to Java on a supported platform and then copy the
generated Java files to your target platform.
### Java Version
Ice for Java requires J2SE 1.8 or later.
Make sure that the `javac` and `java` commands are present in your PATH.
The Metrics Graph feature of the IceGrid GUI tool requires JavaFX support. This
feature will not be available if you build the source with a JVM that lacks
support for JavaFX. Alternatively, building the source in an environment with
JavaFX produces an IceGrid GUI JAR file that can be used in JVMs with or without
JavaFX support, as the Metrics Graph feature is enabled dynamically.
### Gradle
Ice for Java uses the [Gradle][3] build system, and includes the Gradle wrapper
version 2.4 in the distribution. You cannot build the Ice for Java source
distribution without an Internet connection. Gradle will download all required
distribution without an Internet connection. Gradle will download all required
packages automatically from ZeroC's Maven repository located at
https://repo.zeroc.com/nexus/content/repositories/thirdparty
### Bzip2 Compression
Ice for Java supports protocol compression using the bzip2 classes included
with [Apache Commons Compress][5].
The Maven package id for the commons-compress JAR file is as follows:
groupId=org.apache.commons, version=1.14, artifactId=commons-compress
The demos and tests are automatically setup to enable protocol compression by
adding the commons-compress JAR to the manifest class path. For your own
applications you must add the commons-compress JAR to the application CLASSPATH
to enable protocol compression.
> *These classes are a pure Java implementation of the bzip2 algorithm and
therefore add significant latency to Ice requests.*
### JGoodies
The IceGrid GUI tool uses the JGoodies libraries Forms and Looks. The following
versions were tested:
JGoodies Forms 1.9.0
JGoodies Looks 2.7.0
The Maven package ids for the JGoodies packages are as follows:
groupId=com.jgoodies, version=1.9.0, artifactId=jgoodies-forms
groupId=com.jgoodies, version=2.7.0, artifactId=jgoodies-looks
### ProGuard
Gradle uses [ProGuard][4] to create the standalone JAR file for the IceGrid
GUI tool.
The Maven package id for the ProGuard package is as follows:
groupId='net.sf.proguard', artifactId='proguard-gradle', version='5.2.1'
### Java Application Bundler
Under macOS Gradle uses the Java Application Bundler to create an application
bundle for the IceGrid GUI tool.
The Maven package id for the application bundler package is as follows:
groupId=com.oracle, version=1.0, artifactId=appbundler
## Compiling Ice for Java
### Preparing to Build
The build system requires the Slice to Java compiler from Ice for C++. If you
have not built Ice for C++ in this source distribution, you must set the
`ICE_BIN_DIST` environment variable to `cpp` and the `ICE_HOME` environment
variable with the path name of your Ice installation. For example, on Unix with
an RPM installation:
```
export ICE_BIN_DIST=cpp
export ICE_HOME=/usr
```
On Windows with an MSI installation:
```
set ICE_BIN_DIST=cpp
set ICE_HOME=C:\Program Files\ZeroC\Ice-3.7.0
```
If you are using Ice for C++ from a source distribution on Windows, you must set
the `CPP_PLATFORM` and `CPP_CONFIGURATION` environment variables to match the
platform and configuration used in your C++ build:
```
set CPP_PLATFORM=x64
set CPP_CONFIGURATION=Debug
```
The supported values for `CPP_PLATFORM` are `Win32` and `x64` and the supported
values for `CPP_CONFIGURATION` are `Debug` and `Release`.
Before building Ice for Java, review the settings in the file
`gradle.properties` and edit as necessary.
### Building Ice for Java
To build Ice, all services, and tests, run
```
gradlew build
```
Upon completion, the Ice JAR and POM files are placed in the `lib` subdirectory.
If at any time you wish to discard the current build and start a new one, use
these commands:
```
gradlew clean
gradlew build
```
## Installing Ice for Java
To install Ice for Java in the directory specified by the `prefix` variable in
`gradle.properties` run the following command:
```
gradlew install
```
The following JAR files will be installed to `<prefix>/lib`.
glacier2-3.7.0.jar
ice-3.7.0.jar
icebox-3.7.0.jar
icebt-3.7.0.jar
icediscovery-3.7.0.jar
icegrid-3.7.0.jar
icegridgui.jar
icelocatordiscovery-3.7.0.jar
icepatch2-3.7.0.jar
icessl-3.7.0.jar
icestorm-3.7.0.jar
POM files are also installed for ease of deployment to a Maven-based
distribution system.
## Running the Java Tests
Some of the Ice for Java tests employ applications that are part of the Ice for
C++ distribution. If you have not built Ice for C++ in this source distribution
then you must set the `ICE_HOME` environment variable with the path name of your
Ice installation. On Unix:
```
export ICE_HOME=/opt/Ice-3.7.0 (For local build)
export ICE_HOME=/usr (For RPM installation)
```
On Windows:
```
set ICE_HOME=C:\Program Files\ZeroC\Ice-3.7.0
```
Python is required to run the test suite. To run the tests, open a command
window and change to the top-level directory. At the command prompt, execute:
```
python allTests.py
```
If everything worked out, you should see lots of `ok` messages. In case of a
failure, the tests abort with `failed`.
## IceGrid GUI Tool
Ice for Java includes the IceGrid GUI tool. It can be found in the file
`lib/icegridgui.jar`.
This JAR file is completely self-contained and has no external dependencies.
You can start the tool with the following command:
```
java -jar icegridgui.jar
```
On macOS, the build also creates an application bundle named IceGrid GUI. You
can start the IceGrid GUI tool by double-clicking the IceGrid GUI icon in
Finder.
[1]: https://zeroc.com/distributions/ice
[2]: https://doc.zeroc.com/display/Rel/Supported+Platforms+for+Ice+3.7.0
[3]: https://gradle.org
[4]: http://proguard.sourceforge.net
[5]: https://commons.apache.org/proper/commons-compress/
|
