Building and installing from source

When using a CMake build from the source distribution on Linux the easiest way to build and install is this simple command line:

make all && sudo make install/fast

It is important to use the install/fast option to eliminate the automatic rebuild by dependency that causes issues because the build tooling is designed to work with cached files in the user home directory during the build process. Instead this builds the code in the expected local build tree and then uses CMake install code to copy to the target destination.

Building Thrift with Gradle without CMake/Autoconf

The Thrift Java source is not build using the GNU tools, but rather uses the Gradle build system, which tends to be predominant amongst Java developers.

Currently we use gradle 8.0 to build the Thrift Java source. The usual way to setup gradle project is to include the gradle-wrapper.jar in the project and then run the gradle wrapper to bootstrap setting up gradle binaries. However to avoid putting binary files into the source tree we have ignored the gradle wrapper files. You are expected to install it manually, as described in the gradle documentation, or following this step (which is also done in the travis CI docker images):

bash export GRADLE_VERSION="8.4" # install dependencies apt-get install -y --no-install-recommends openjdk-17-jdk-headless wget unzip # download gradle distribution wget$ -q -O /tmp/gradle-$ # check binary integrity echo "3e1af3ae886920c3ac87f7a91f816c0c7c436f276a6eefdb3da152100fef72ae /tmp/gradle-$" | sha256sum -c - # unzip and install unzip -d /tmp /tmp/gradle-$ mv /tmp/gradle-$GRADLE_VERSION /usr/local/gradle ln -s /usr/local/gradle/bin/gradle /usr/local/bin

After the above step, gradle binary will be available in /usr/local/bin/. You can further choose to locally create the gradle wrapper (even if they are ignored) using:

bash gradle wrapper --gradle-version $GRADLE_VERSION

To compile the Java Thrift libraries, simply do the following:

bash gradle

Yep, that’s easy. Look for libthrift-<version>.jar in the build/libs directory.

The default build will run the unit tests which expect a usable Thrift compiler to exist on the system. You have two choices for that.

To just build the library without running unit tests you simply do this.

bash gradle assemble

To install the library in the local Maven repository location where other Maven or Gradle builds can reference it simply do this.

bash gradle publishToMavenLocal

The library will be placed in your home directory under .m2/repository

To include Thrift in your applications simply add libthrift.jar to your classpath, or install if in your default system classpath of choice.

Build Thrift behind a proxy:

bash gradle -Dhttp.proxyHost=myproxyhost -Dhttp.proxyPort=8080 -Dhttp.proxyUser=thriftuser -Dhttp.proxyPassword=topsecret

or via

bash ./configure --with-java GRADLE_OPTS='-Dhttp.proxyHost=myproxyhost -Dhttp.proxyPort=8080 -Dhttp.proxyUser=thriftuser -Dhttp.proxyPassword=topsecret'

Unit Test HTML Reports

The build will automatically generate an HTML Unit Test report. This can be found under build/reports/tests/test/index.html. It can be viewed with a browser directly from that location.

Clover Code Coverage for Thrift

The build will optionally generate Clover Code coverage if the Gradle property cloverEnabled=true is set in ~/.gradle/ or on the command line via -PcloverEnabled=true. The generated report can be found under the location build/reports/clover/html/index.html. It can be viewed with a browser directly from that location. Additionally, a PDF report is generated and is found under the location build/reports/clover/clover.pdf.

The following command will build, unit test, and generate Clover reports:

bash gradle -PcloverEnabled=true

Publishing Maven Artifacts to Maven Central

The Automake build generates a Makefile that provides the correct parameters when you run the build provided the has been set with the correct version number. The Gradle build will receive the correct value for the build. The same applies to the CMake build, the value from the file will be used if you execute these commands:

bash make maven-publish -- This is for an Automake Linux build make MavenPublish -- This is for a CMake generated build

The publish task in Gradle is preconfigured with all necessary details to sign and publish the artifacts from the build to the Apache Maven staging repository. The task requires the following externally provided properties to authenticate to the repository and sign the artifacts. The preferred approach is to create or edit the ~/.gradle/ file and add the following properties to it.

```properties # Signing key information for artifacts PGP signature (values are examples) signing.keyId=24875D73 signing.password=secret signing.secretKeyRingFile=/Users/me/.gnupg/secring.gpg

Apache Maven staging repository user credentials

mavenUser=meMyselfAndI mavenPassword=MySuperAwesomeSecretPassword ```

NOTE: If you do not have a secring.gpg file, see the gradle signing docs for instructions on how to generate it.

It is also possible to manually publish using the Gradle build directly. With the key information and credentials in place the following will generate if needed the build artifacts and proceed to publish the results.

bash gradle -Prelease=true publish

It is also possible to override the target repository for the Maven Publication by using a Gradle property, for example you can publish signed JAR files to your company internal server if you add this to the command line or in the ~/.gradle/ file. The URL below assumes a Nexus Repository.

properties maven-repository-url=

Or the same on the command line:

bash gradle -Pmaven-repository-url= -Prelease=true -Pthrift.version=0.11.0 publish



Breaking Changes



The access modifier of the AutoExpandingBuffer class has been changed from public to default (package) and will no longer be accessible by third-party libraries.

The access modifier of the ShortStack class has been changed from public to default (package) and will no longer be accessible by third-party libraries.