Custom Client Artifacts

As of Apache Calcite Avatica 1.9.0, there are two artifacts (jars) provided that enable client-accessto an Avatica server over JDBC.

  1. <dependencies>
  2.   <!-- Shaded artifact -->
  3.   <dependency>
  4.     <groupId>org.apache.calcite.avatica</groupId>
  5.     <artifactId>avatica</artifactId>
  6.   </dependency>
  7.   <!-- Non-shaded artifact -->
  8.   <dependency>
  9.     <groupId>org.apache.calcite.avatica</groupId>
  10.     <artifactId>avatica-core</artifactId>
  11.   </dependency>
  12. </dependencies>

In keeping with the convention of previous releases, org.apache.calcite.avatica:avatica is a JARwhich contains all of the necessary dependencies of the Avatica client code base. Those classes whichcan be safely relocated are done so to reduce the potential for classpath issues.

Avatica 1.9.0 will introduce a new artifact org.apache.calcite.avatica:avatica-core which is onlythe Avatica client classes without any bundled dependencies. This artifact enables users to build aclasspath with different versions of JARs than what Avatica presently depends upon. This is a “your-mileage-may-vary”or “void-your-warranty” type of decision (as you are using Avatica with dependecies which we have not tested);however, some downstream projects do provide reasonable assurances of compatibilities across releases.

Building your own Avatica client artifact

In some cases, it may be beneficial to provide specific versions of Avatica dependencies. Here isa brief pom.xml which outlines how this can be done.

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.   <modelVersion>4.0.0</modelVersion>
  4.   <groupId>myorg.custom.client</groupId>
  5.   <artifactId>my-special-app-client</artifactId>
  6.   <packaging>jar</packaging>
  7.   <name>Special Application Client Artifact</name>
  8.   <description>A custom artifact which uses Apache Calcite Avatica for my Org's Special Application</description>
  10.   <properties>
  11.     <myorg.prefix>myorg.custom.client</myorg.prefix>
  12.   </properties>
  14.   <dependencies>
  15.     <dependency>
  16.       <groupId>org.apache.calcite.avatica</groupId>
  17.       <artifactId>avatica-core</artifactId>
  18.       <version>1.9.0</version>
  19.     </dependency>
  20.     <dependency>
  21.       <groupId>org.apache.httpcomponents</groupId>
  22.       <artifactId>httpclient</artifactId>
  23.       <!-- Override the version from avatica-core (4.5.2) to address a hypothetical bug in httpclient -->
  24.       <version>4.5.3</version>
  25.     </dependency>
  26.     <!-- Include Guava for the "Special Application" -->
  27.     <dependency>
  28.       <groupId>com.google.guava</groupId>
  29.       <artifactId>guava</artifactId>
  30.       <version>17.0</version>
  31.     </dependency>
  32.   </dependencies>
  34.   <build>
  35.     <plugins>
  36.       <plugin>
  37.         <groupId>org.apache.maven.plugins</groupId>
  38.         <artifactId>maven-shade-plugin</artifactId>
  39.         <executions>
  40.           <execution>
  41.             <phase>package</phase>
  42.             <goals>
  43.               <goal>shade</goal>
  44.             </goals>
  45.             <configuration>
  46.               <!-- Relocate Jackson, Protobuf, Apache Commons HttpClient and HttpComponents, but not Guava.
  47.                    The hypothetical "Special App" would be expecting Guava in the standard location -->
  48.               <relocations>
  49.                 <relocation>
  50.                   <pattern>com.fasterxml.jackson</pattern>
  51.                   <shadedPattern>${myorg.prefix}.com.fasterxml.jackson</shadedPattern>
  52.                 </relocation>
  53.                 <relocation>
  54.                   <pattern>com.google.protobuf</pattern>
  55.                   <shadedPattern>${myorg.prefix}.com.google.protobuf</shadedPattern>
  56.                 </relocation>
  57.                 <relocation>
  58.                   <pattern>org.apache.http</pattern>
  59.                   <shadedPattern>${myorg.prefix}.org.apache.http</shadedPattern>
  60.                 </relocation>
  61.                 <relocation>
  62.                   <pattern>org.apache.commons</pattern>
  63.                   <shadedPattern>${myorg.prefix}.org.apache.commons</shadedPattern>
  64.                 </relocation>
  65.               </relocations>
  66.               <createDependencyReducedPom>false</createDependencyReducedPom>
  67.             </configuration>
  68.           </execution>
  69.         </executions>
  70.       </plugin>
  71.     </plugins>
  72.   </build>
  73. </project>