| |
| Xerces Java Build Instructions |
| ------------------------------ |
| |
| =========================================================================== |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. Please see the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to you under the Apache License, Version 2.0 |
| * (the "License"). You may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| =========================================================================== |
| |
| This Apache Xerces-J GitHub repos branch, contains instructions to build Xerces-J. |
| |
| Before building Xerces-J, users would need the source package and tools package |
| available from the Apache Xerces-J project's distribution web page: |
| |
| https://xerces.apache.org/xerces2-j/ |
| |
| Download both the Xerces-J-src.X.Y.Z.zip and Xerces-J-tools.X.Y.Z.zip |
| files for the appropriate Xerces-J release (where "X.Y.Z" is the version |
| number) and extract them in the same directory. If you're using an Unix |
| variant OS like Linux, download the equivalent .tar.gz files instead of |
| the .zip files. |
| |
| You also need to have a Java Development Kit (JDK) version 1.8 or |
| higher installed on your system. The latest Xerces-J codebase on this GitHub |
| repos has Java language maximum source/target level requirement of 1.8. |
| |
| Before initiating any part of the build, set the JAVA_HOME environment |
| variable to the installation directory of your JDK. |
| |
| Ant (https://ant.apache.org/) 1.10.2 or later is needed to build everything in Xerces-J, including |
| the documentation. This tool, and the others needed (besides the |
| pre-requisite JDK) are contained within the tools package. To |
| make building Xerces-J packages easier, Windows batch file and a Linux |
| shell script are included. |
| |
| If you only want to compile the source code and make the JAR files, |
| run the following command on Windows: |
| |
| build.bat jars |
| |
| or from Linux (make sure that build.sh is executable): |
| |
| build.sh jars |
| |
| This shall compile all of the source code and generate the JAR |
| files that are available as part of the binary package. After |
| having results of these Xerces-J builds, the build results shall be |
| located in the "build" directory. |
| |
| If all results of Xerces-J build are needed, including the documentation, |
| run the build batch file or shell script specifying an Ant build "all" |
| target instead of "jars". |
| |
| We use JProfiler (https://www.ej-technologies.com/jprofiler) tool for Java software run-time |
| analysis and optimization of Xerces-J software. |
| |
| |
| Sincerely, |
| Apache Xerces Team |
