Merge pull request #667 from wburns/jdg

Support Infinispan Client in Protean
quarkusio · Jan 30, 2019 · 164c9db · 164c9db
2 parents 5d0b705 + 83da481
commit 164c9db
Show file tree

Hide file tree

Showing 40 changed files with 2,407 additions and 0 deletions.
diff --git a/build-parent/pom.xml b/build-parent/pom.xml
@@ -113,6 +113,7 @@
       <junit4.version>4.12</junit4.version>
       <junit.jupiter.version>5.3.2</junit.jupiter.version>
       <assertj.version>3.11.1</assertj.version>
+      <infinispan.version>10.0.0.Alpha3</infinispan.version>
    </properties>
 
    <dependencyManagement>
@@ -457,6 +458,16 @@
             <artifactId>shamrock-security-runtime</artifactId>
             <version>${project.version}</version>
          </dependency>
+         <dependency>
+            <groupId>org.jboss.shamrock</groupId>
+            <artifactId>shamrock-infinispan-client-runtime</artifactId>
+            <version>${project.version}</version>
+         </dependency>
+         <dependency>
+            <groupId>org.jboss.shamrock</groupId>
+            <artifactId>shamrock-infinispan-client-deployment</artifactId>
+            <version>${project.version}</version>
+         </dependency>
          <dependency>
             <groupId>org.jboss.logging</groupId>
             <artifactId>jboss-logging-embedded</artifactId>
@@ -1262,6 +1273,21 @@
             <artifactId>smallrye-reactive-messaging-provider</artifactId>
             <version>${smallrye-reactive-messaging.version}</version>
          </dependency>
+         <dependency>
+            <groupId>org.infinispan</groupId>
+            <artifactId>infinispan-client-hotrod</artifactId>
+            <version>${infinispan.version}</version>
+         </dependency>
+         <dependency>
+            <groupId>org.infinispan</groupId>
+            <artifactId>infinispan-remote-query-client</artifactId>
+            <version>${infinispan.version}</version>
+         </dependency>
+         <dependency>
+            <groupId>org.infinispan</groupId>
+            <artifactId>infinispan-query-dsl</artifactId>
+            <version>${infinispan.version}</version>
+         </dependency>
 
       </dependencies>
    </dependencyManagement>

diff --git a/extensions/infinispan-client/README.MD b/extensions/infinispan-client/README.MD
@@ -0,0 +1,132 @@
+# Infinispan Client for Protean
+
+## Status
+
+The RemoteCache by default only supports byte[] key and values. However a user can plug in a Marshaller to workaround
+that. Please see the next few sections about features that currently work and those that don't
+
+## Things that work
+
+### Marshalling
+
+Can be supplied via hotrod-client.properties file. The class must have a no arg public constructor. This
+can also be configured at runtime by supplying DataFormat with the appropriate Marshaller instances on a key or value
+basis. You can also add infinispan-remote-query-client as a dependency and configure the marshaller in the
+hotrod.client-properties file to be `infinispan.client.hotrod.marshaller=org.infinispan.client.hotrod.marshall.ProtoStreamMarshaller`
+which allows support for protobuf marshalling. You can also provide `org.infinispan.protostream.MessageMarshaller` via @Produces
+and we will automatically register those marshallers with the global ProtoStreamMarshaller.
+
+### Protobuf Marshalling 
+
+A user can define Injected protobuf Marshaller and FileDescriptorSource to configure the
+ProtoStreamMarshaller if it is in use.
+
+The code here would be part of the user application to allow protobuf marshalling for User types Book and Author.
+
+```java
+   @Produces
+   MessageMarshaller bookMarshaller() {
+      return new BookMarshaller();
+   }
+
+   @Produces
+   MessageMarshaller authorMarshaller() {
+      return new AuthorMarshaller();
+   }
+
+   @Produces
+   FileDescriptorSource bookProtoDefinition() {
+      return FileDescriptorSource.fromString("library.proto", "package book_sample;\n" +
+            "\n" +
+            "message Book {\n" +
+            "  required string title = 1;\n" +
+            "  required string description = 2;\n" +
+            "  required int32 publicationYear = 3; // no native Date type available in Protobuf\n" +
+            "\n" +
+            "  repeated Author authors = 4;\n" +
+            "}\n" +
+            "\n" +
+            "message Author {\n" +
+            "  required string name = 1;\n" +
+            "  required string surname = 2;\n" +
+            "}");
+   }
+```
+
+You may also now supply a file(s) in the META-INF directory of your project ending in .proto. Any such file will
+be read and parsed as a protobuf file and automatically registered with the protostream marshaller if configured. Note
+that the programmatic way via @Produces will overwrite any same named files (ie. library.proto).
+
+### CDI
+
+RemoteCache and RemoteCacheManager can both be injected via @Inject. The former allows named cache injection by
+adding the Remote annotation, specifying the name of the cache. Currently the RemoteCacheManager is configured via the
+hotrod-client.properties and/or microprofile-config.properties (with micro profile config replacing properties if both
+are present).
+
+### Near Caching
+
+Bounded and Unbounded both work. Exception encountered when protobuf marshalling is enabled
+
+### TLS/SSL
+
+This is working, but requires some additional steps to get configured.
+
+#### Configure truststore information (optionally keystore)
+
+This is configured via hotrod-client.properties file located in META-INF. Everything is the same as normal in that
+you have to add the certificate from the server to the configured truststore if it already trusted in the default
+java cacerts file.
+
+#### Configure your project to allow security services (enable JNI optional)
+
+You (currently) need to enable all security services in Substrate
+(https://github.com/oracle/graal/blob/master/substratevm/JCA-SECURITY-SERVICES.md). This can be done by adding
+`<enableAllSecurityServices>true</enableAllSecurityServices>` to the shamrock-maven-plugin configuration values.
+
+You may have to also enable JNI, depending on the security provider by also adding `<enableJni>true</enableJni>` to the
+same configuration values. If you have to enable JNI you will then also have to add the appropriate shared library to
+be contained in a directory defined by `java.library.path`. In many times this shared library will be `sunec`, which
+can be located at `<JAVA_HOME>/jre/lib/<platform>/libsunec.so`.
+
+### Authentication
+
+DIGEST_MD5, PLAIN, EXTERNAL were all tested to work.
+
+### Querying
+
+Querying is also supported. To be able to do DSL based queries you need to add the infinispan-query-dsl artifact to your
+list of dependencies and then you can use it as normal. A simple example can be seen at
+http://infinispan.org/docs/dev/user_guide/user_guide.html#a_remote_query_example
+
+### Counters
+
+Counters work :)
+
+### Continuous Query
+
+Continuous Query works
+
+### Listeners
+
+This is working
+
+## Things to do
+
+Annotation based protobuf marshalling is not yet currently supported. This requires additional changes as classes
+must be generated at compile time and protostream, underlying library powering protobuf marshalling, only supports
+runtime based class generation.
+
+## Things to still verify work
+
+
+
+
+
+### Multimap
+
+Need to verify what is needed
+
+### Transactions
+
+This will need additional dependencies and verification
diff --git a/extensions/infinispan-client/deployment/pom.xml b/extensions/infinispan-client/deployment/pom.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2018 Red Hat, Inc.
+  ~
+  ~ Licensed 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.
+  -->
+
+<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">
+    <parent>
+        <artifactId>shamrock-infinispan-client</artifactId>
+        <groupId>org.jboss.shamrock</groupId>
+        <version>1.0.0.Alpha1-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>shamrock-infinispan-client-deployment</artifactId>
+    <name>Shamrock - Infinispan - Client - Deployment</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.jboss.shamrock</groupId>
+            <artifactId>shamrock-core-deployment</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jboss.shamrock</groupId>
+            <artifactId>shamrock-arc-deployment</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jboss.shamrock</groupId>
+            <artifactId>shamrock-infinispan-client-runtime</artifactId>
+        </dependency>
+    </dependencies>
+</project>