infinispan 0.8.0 → 0.10.0

package/documentation/asciidoc/stories/assembly_client_usage_examples.adoc

@@ -0,0 +1,10 @@
+[id='client-usage-examples']
+:context: client-usage-examples
+= Using {hr_js} clients
+Take a look at some examples for using the {hr_js} client with {brandname}.
+
+include::{topics}/ref_client_usage.adoc[leveloffset=+1]
+
+// Restore the parent context.
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]

package/documentation/asciidoc/stories/assembly_installation_configuration.adoc

@@ -0,0 +1,20 @@
+[id='install-configure']
+:context: install-configure
+= Installing and configuring {hr_js} clients
+Ensure your system meets requirements before installing the {hr_js} client.
+You can then configure {hr_js} clients to connect to {brandname} Server, use different media types for keys and values, and customize logging.
+
+include::{topics}/proc_installing_clients.adoc[leveloffset=+1]
+include::{topics}/proc_configuring_connections.adoc[leveloffset=+1]
+include::{topics}/proc_configuring_connections_xsite.adoc[leveloffset=+2]
+include::{topics}/proc_switching_clusters.adoc[leveloffset=+2]
+include::{topics}/proc_configuring_authentication.adoc[leveloffset=+1]
+include::{topics}/ref_authentication_mechanisms.adoc[leveloffset=+2]
+include::{topics}/proc_configuring_encryption.adoc[leveloffset=+1]
+include::{topics}/ref_encryption.adoc[leveloffset=+2]
+include::{topics}/proc_configuring_data_formats.adoc[leveloffset=+1]
+include::{topics}/proc_configuring_logging.adoc[leveloffset=+1]
+
+// Restore the parent context.
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]

package/documentation/asciidoc/titles/js_client.asciidoc

@@ -0,0 +1,28 @@
+//Directory attributes
+:stories: ../stories
+:topics: ../topics
+
+//Doc attributes
+//Community
+:community:
+include::{topics}/attributes/community-attributes.adoc[]
+//Downstream
+//include::{topics}/attributes/downstream-attributes.adoc[]
+//:downstream:
+//:rhdg-install-npmrepo:
+
+//Title attributes
+:toc2:
+:icons: font
+:toclevels: 3
+:numbered:
+:sectanchors:
+
+//Title
+= {hr_js} Client Guide
+
+{hr_js} clients provide asynchronous, event-driven access to {brandname} clusters for Node.js applications.
+The asynchronous operation results are represented with `Promise` instances, which allows the client to chain multiple invocations and centralize error handling.
+
+//User stories
+include::stories.adoc[]

package/documentation/asciidoc/titles/stories.adoc

@@ -0,0 +1,5 @@
+//Reference user stories or topics.
+//Please review authoring guidelines in the Contributors Guide.
+
+include::{stories}/assembly_installation_configuration.adoc[leveloffset=+1]
+include::{stories}/assembly_client_usage_examples.adoc[leveloffset=+1]

package/documentation/asciidoc/topics/attributes/community-attributes.adoc

@@ -0,0 +1,8 @@
+:brandname: Infinispan
+:hr_js: Hot Rod JS
+
+:doc_home: https://infinispan.org/documentation/
+:download_url: https://infinispan.org/hotrod-clients
+:node_docs: https://docs.jboss.org/infinispan/hotrod-clients/javascript/1.0/apidocs/
+:server_docs: https://infinispan.org/docs/stable/titles/server/server.html
+:code_tutorials: https://github.com/infinispan/infinispan-simple-tutorials/

package/documentation/asciidoc/topics/attributes/downstream-attributes.adoc

@@ -0,0 +1,2 @@
+:brandname: Data Grid
+:hr_js: Hot Rod JS

package/documentation/asciidoc/topics/code_examples/authentication-digest.js

@@ -0,0 +1,12 @@
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    authentication: {
+      enabled: true,
+      saslMechanism: 'DIGEST-MD5',
+      userName: 'username',
+      password: 'changeme',
+      serverName: 'infinispan'
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/authentication-external.js

@@ -0,0 +1,15 @@
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    authentication: {
+      enabled: true,
+      saslMechanism: 'EXTERNAL'
+    },
+    ssl: {
+      enabled: true,
+      clientAuth: {
+        cert: 'out/ssl/client/client.p12',
+      }
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/authentication-oauthbearer.js

@@ -0,0 +1,10 @@
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    authentication: {
+      enabled: true,
+      saslMechanism: 'OAUTHBEARER',
+      token: `<token>`
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/authentication-plain.js

@@ -0,0 +1,11 @@
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    authentication: {
+      enabled: true,
+      saslMechanism: 'PLAIN',
+      userName: 'username',
+      password: 'changeme'
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/authentication-scram.js

@@ -0,0 +1,11 @@
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    authentication: {
+      enabled: true,
+      saslMechanism: 'SCRAM-SHA-1',
+      userName: 'username',
+      password: 'changeme'
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/await-multiple-entries.js

@@ -0,0 +1,36 @@
+const infinispan = require("infinispan");
+
+const log4js = require('log4js');
+log4js.configure('example-log4js.json');
+
+async function test() {
+  let client = await infinispan.client({port: 11222, host: '127.0.0.1'});
+  console.log(`Connected to Infinispan dashboard data`);
+
+  let data = [
+    {key: 'multi1', value: 'v1'},
+    {key: 'multi2', value: 'v2'},
+    {key: 'multi3', value: 'v3'}];
+
+  await client.putAll(data);
+
+  let entries = await client.getAll(['multi2', 'multi3']);
+  console.log('getAll(multi2, multi3)=%s', JSON.stringify(entries));
+
+  let iterator = await client.iterator(1);
+
+  let entry = {done: true};
+
+  do {
+    entry = await iterator.next();
+    console.log('iterator.next()=' + JSON.stringify(entry));
+  } while (!entry.done);
+
+  await iterator.close();
+
+  await client.clear();
+
+  await client.disconnect();
+}
+
+test();

package/documentation/asciidoc/topics/code_examples/await-single-entries.js

@@ -0,0 +1,29 @@
+const infinispan = require("infinispan");
+
+const log4js = require('log4js');
+log4js.configure('example-log4js.json');
+
+async function test() {
+  await new Promise((resolve, reject) => setTimeout(() => resolve(), 1000));
+  console.log('Hello, World!');
+
+  let client = await infinispan.client({port: 11222, host: '127.0.0.1'});
+  console.log(`Connected to Infinispan dashboard data`);
+
+  await client.put('key', 'value');
+
+  let value = await client.get('key');
+  console.log('get(key)=' + value);
+
+  let success = await client.remove('key');
+  console.log('remove(key)=' + success);
+
+  let stats = await client.stats();
+  console.log('Number of stores: ' + stats.stores);
+  console.log('Number of cache hits: ' + stats.hits);
+  console.log('All statistics: ' + JSON.stringify(stats, null, " "));
+
+  await client.disconnect();
+}
+
+test();

package/documentation/asciidoc/topics/code_examples/conditional-operations.js

@@ -0,0 +1,57 @@
+var infinispan = require('infinispan');
+
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'}
+  {
+    // Configure client connections with authentication and encryption here.
+  }
+);
+
+connected.then(function (client) {
+
+  var clientPut = client.putIfAbsent('cond', 'v0');
+
+  var showPut = clientPut.then(
+      function(success) { console.log(':putIfAbsent(cond)=' + success); });
+
+  var clientReplace = showPut.then(
+      function() { return client.replace('cond', 'v1'); } );
+
+  var showReplace = clientReplace.then(
+      function(success) { console.log('replace(cond)=' + success); });
+
+  var clientGetMetaForReplace = showReplace.then(
+      function() { return client.getWithMetadata('cond'); });
+
+  // Call the getWithMetadata method to retrieve the value and its metadata.
+  var clientReplaceWithVersion = clientGetMetaForReplace.then(
+      function(entry) {
+        console.log('getWithMetadata(cond)=' + JSON.stringify(entry));
+        return client.replaceWithVersion('cond', 'v2', entry.version);
+      }
+  );
+
+  var showReplaceWithVersion = clientReplaceWithVersion.then(
+      function(success) { console.log('replaceWithVersion(cond)=' + success); });
+
+  var clientGetMetaForRemove = showReplaceWithVersion.then(
+      function() { return client.getWithMetadata('cond'); });
+
+  var clientRemoveWithVersion = clientGetMetaForRemove.then(
+      function(entry) {
+        console.log('getWithMetadata(cond)=' + JSON.stringify(entry));
+        return client.removeWithVersion('cond', entry.version);
+      }
+  );
+
+  var showRemoveWithVersion = clientRemoveWithVersion.then(
+      function(success) { console.log('removeWithVersion(cond)=' + success)});
+
+  return showRemoveWithVersion.finally(
+      function() { return client.disconnect(); });
+
+}).catch(function(error) {
+
+  console.log("Got error: " + error.message);
+
+});

package/documentation/asciidoc/topics/code_examples/connection-multiple-servers.js

@@ -0,0 +1,23 @@
+var infinispan = require('infinispan');
+
+var connected = infinispan.client(
+  [{port: 11322, host: '127.0.0.1'}, {port: 11222, host: '127.0.0.1'}]
+  {
+    // Configure client connections with authentication and encryption here.
+  }
+);
+
+connected.then(function (client) {
+
+  var members = client.getTopologyInfo().getMembers();
+
+  // Displays all members of the {brandname} cluster.
+  console.log('Connected to: ' + JSON.stringify(members));
+
+  return client.disconnect();
+
+}).catch(function(error) {
+
+  console.log("Got error: " + error.message);
+
+});

package/documentation/asciidoc/topics/code_examples/connection-xsite-cluster-switch.js

@@ -0,0 +1,39 @@
+var connected = infinispan.client({port: 11222, host: '127.0.0.1'},
+  {
+    clusters: [
+      {
+        name: 'LON',
+        servers: [{port: 11222, host: 'LON-host'}]
+      },
+      {
+        name: 'NYC',
+        servers: [{port: 11222, host: 'NYC-host1'}, {port: 11322, host: 'NYC-host2'}]
+      }
+    ]
+  });
+
+connected.then(function (client) {
+
+  var switchToB = client.getTopologyInfo().switchToCluster('NYC');
+
+  switchToB.then(function(switchSucceed) {
+
+    if (switchSucceed) {
+      ...
+    }
+
+    ...
+
+    var switchToDefault = client.getTopologyInfo().switchToDefaultCluster();
+
+    switchToDefault.then(function(switchSucceed) {
+
+      if (switchSucceed) {
+        ...
+      }
+
+    })
+
+  })
+
+});

package/documentation/asciidoc/topics/code_examples/connection-xsite.js

@@ -0,0 +1,13 @@
+var connected = infinispan.client({port: 11222, host: '127.0.0.1'},
+  {
+    clusters: [
+      {
+        name: 'LON',
+        servers: [{port: 11222, host: 'LON-host'}]
+      },
+      {
+        name: 'NYC',
+        servers: [{port: 11222, host: 'NYC-host1'}, {port: 11322, host: 'NYC-host2'}]
+      }
+    ]
+  });

package/documentation/asciidoc/topics/code_examples/data-types.js

@@ -0,0 +1,30 @@
+var infinispan = require('infinispan');
+
+var connected = infinispan.client(
+    {port: 11222, host: '127.0.0.1'},
+    {
+        dataFormat : {
+            keyType: 'application/json',
+            valueType: 'application/json'
+        }
+    }
+);
+
+connected.then(function (client) {
+
+  var clientPut = client.put({k: 'key'}, {v: 'value'});
+
+  var clientGet = clientPut.then(
+      function() { return client.get({k: 'key'}); });
+
+  var showGet = clientGet.then(
+      function(value) { console.log("get({k: 'key'})=" + JSON.stringify(value)); });
+
+  return showGet.finally(
+      function() { return client.disconnect(); });
+
+}).catch(function(error) {
+
+  console.log("Got error: " + error.message);
+
+});

package/documentation/asciidoc/topics/code_examples/encryption-crypto-store.js

@@ -0,0 +1,11 @@
+var connected = infinispan.client({port: 11222, host: '127.0.0.1'},
+  {
+    ssl: {
+      enabled: true,
+      cryptoStore: {
+        path: 'my-truststore.p12',
+        passphrase: 'secret'
+      }
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/encryption-private-key.js

@@ -0,0 +1,13 @@
+var connected = infinispan.client({port: 11222, host: '127.0.0.1'},
+  {
+    ssl: {
+      enabled: true,
+      trustCerts: ['my-root-ca.crt.pem'],
+      clientAuth: {
+        key: 'privkey.pem',
+        passphrase: 'secret',
+        cert:ssl 'cert.pem'
+      }
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/encryption-sni-hostname.js

@@ -0,0 +1,9 @@
+var connected = infinispan.client({port: 11222, host: '127.0.0.1'},
+  {
+    ssl: {
+      enabled: true,
+      trustCerts: ['my-root-ca.crt.pem']
+      sniHostName: 'example.com'
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/encryption-trust-certs.js

@@ -0,0 +1,8 @@
+var connected = infinispan.client({port: 11222, host: '127.0.0.1'},
+  {
+    ssl: {
+      enabled: true,
+      trustCerts: ['my-root-ca.crt.pem']
+    }
+  }
+);

package/documentation/asciidoc/topics/code_examples/ephemeral-data.js

@@ -0,0 +1,52 @@
+var infinispan = require('infinispan');
+
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'}
+  {
+    // Configure client connections with authentication and encryption here.
+  }
+);
+
+connected.then(function (client) {
+
+  var clientPutExpiry = client.put('expiry', 'value', {lifespan: '1s'});
+
+  var clientGetMetaAndSize = clientPutExpiry.then(
+    function() {
+      // Compute getWithMetadata and size in parallel.
+      return Promise.all([client.getWithMetadata('expiry'), client.size()]);
+    });
+
+  var showGetMetaAndSize = clientGetMetaAndSize.then(
+    function(values) {
+      console.log('Before expiration:');
+      console.log('getWithMetadata(expiry)=' + JSON.stringify(values[0]));
+      console.log('size=' + values[1]);
+    });
+
+  var clientContainsAndSize = showGetMetaAndSize.then(
+    function() {
+      sleepFor(1100); // Sleep to force expiration.
+      return Promise.all([client.containsKey('expiry'), client.size()]);
+    });
+
+  var showContainsAndSize = clientContainsAndSize.then(
+    function(values) {
+      console.log('After expiration:');
+      console.log('containsKey(expiry)=' + values[0]);
+      console.log('size=' + values[1]);
+    });
+
+  return showContainsAndSize.finally(
+    function() { return client.disconnect(); });
+
+}).catch(function(error) {
+
+  console.log("Got error: " + error.message);
+
+});
+
+function sleepFor(sleepDuration){
+  var now = new Date().getTime();
+  while(new Date().getTime() < now + sleepDuration){ /* Do nothing. */ }
+}

package/documentation/asciidoc/topics/code_examples/hello-world.js

@@ -0,0 +1,42 @@
+var infinispan = require('infinispan');
+
+// Connect to {brandname} Server.
+// Use an existing cache named "myCache".
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    cacheName: 'myCache',
+    clientIntelligence: 'BASIC',
+    authentication: {
+      enabled: true,
+      saslMechanism: 'DIGEST-MD5',
+      userName: 'username',
+      password: 'changeme'
+    }
+  }
+);
+
+connected.then(function (client) {
+
+  console.log('Connected to `myCache`');
+
+  // Add an entry to the cache.
+  var clientPut = client.put('hello', 'world');
+
+  // Retrieve the entry you added.
+  var clientGet = clientPut.then(
+      function() { return client.get('hello'); });
+
+  // Print the value of the entry.
+  var showGet = clientGet.then(
+      function(value) { console.log('get(hello)=' + value); });
+
+  // Disconnect from {brandname} Server.
+  return client.disconnect();
+
+}).catch(function(error) {
+
+  // Log any errors.
+  console.log("Got error: " + error.message);
+
+});

package/documentation/asciidoc/topics/code_examples/key-value-converter.js

@@ -0,0 +1,67 @@
+var infinispan = require('infinispan');
+
+var connected = infinispan.client(
+    {port: 11222, host: '127.0.0.1'}
+    , {
+        dataFormat : {
+            keyType: 'application/json',
+            valueType: 'application/json'
+        }
+    }
+);
+
+connected.then(function (client) {
+    // Include the remote event converter to avoid unnecessary roundtrips.
+    var opts = {
+        converterFactory : {
+            name: "key-value-with-previous-converter-factory"
+        }
+    };
+
+    var clientAddListenerCreate = client.addListener('create', logEvent("Created"), opts);
+
+    var clientAddListeners = clientAddListenerCreate.then(
+        function(listenerId) {
+            // Associate multiple callbacks with a single client-side listener.
+            // To do this, register listeners with the same listener ID.
+            var clientAddListenerModify =
+                client.addListener('modify', logEvent("Modified"), {opts, listenerId: listenerId});
+
+            var clientAddListenerRemove =
+                client.addListener('remove', logEvent("Removed"), {opts, listenerId: listenerId});
+
+            return Promise.all([clientAddListenerModify, clientAddListenerRemove]);
+        });
+
+    var clientCreate = clientAddListeners.then(
+        function() { return client.putIfAbsent('converted', 'v0'); });
+
+    var clientModify = clientCreate.then(
+        function() { return client.replace('converted', 'v1'); });
+
+    var clientRemove = clientModify.then(
+        function() { return client.remove('converted'); });
+
+    var clientRemoveListener =
+        Promise.all([clientAddListenerCreate, clientRemove]).then(
+            function(values) {
+                var listenerId = values[0];
+                return client.removeListener(listenerId);
+            });
+
+    return clientRemoveListener.finally(
+        function() { return client.disconnect(); });
+
+}).catch(function(error) {
+
+    console.log("Got error: " + error.message);
+
+});
+
+function logEvent(prefix) {
+    return function(event) {
+        console.log(prefix + " key: " + event.key);
+        console.log(prefix + " value: " + event.value);
+        console.log(prefix + " previous value: " + event.prev);
+    }
+}

package/documentation/asciidoc/topics/code_examples/logging-configuration.js

@@ -0,0 +1,2 @@
+var log4js = require('log4js');
+log4js.configure('path/to/my-log4js.json');

package/documentation/asciidoc/topics/code_examples/multiple-entries.js

@@ -0,0 +1,64 @@
+var infinispan = require('infinispan');
+
+var connected = infinispan.client(
+  {port: 11222, host: '127.0.0.1'},
+  {
+    cacheName: 'myCache',
+    authentication: {
+        enabled: true,
+        saslMechanism: 'DIGEST-MD5',
+        userName: 'username',
+        password: 'changeme'
+    }
+  }
+);
+
+connected.then(function (client) {
+  var data = [
+    {key: 'multi1', value: 'v1'},
+    {key: 'multi2', value: 'v2'},
+    {key: 'multi3', value: 'v3'}];
+
+  var clientPutAll = client.putAll(data);
+
+  var clientGetAll = clientPutAll.then(
+    function() { return client.getAll(['multi2', 'multi3']); });
+
+  var showGetAll = clientGetAll.then(
+    function(entries) {
+      console.log('getAll(multi2, multi3)=%s', JSON.stringify(entries));
+    }
+  );
+
+  var clientIterator = showGetAll.then(
+    function() { return client.iterator(1); });
+
+  var showIterated = clientIterator.then(
+    function(it) {
+      function loop(promise, fn) {
+        // Simple recursive loop over the iterator's next() call.
+        return promise.then(fn).then(function (entry) {
+          return entry.done
+            ? it.close().then(function () { return entry.value; })
+            : loop(it.next(), fn);
+        });
+      }
+
+      return loop(it.next(), function (entry) {
+        console.log('iterator.next()=' + JSON.stringify(entry));
+        return entry;
+      });
+    }
+  );
+
+  var clientClear = showIterated.then(
+    function() { return client.clear(); });
+
+  return clientClear.finally(
+    function() { return client.disconnect(); });
+
+}).catch(function(error) {
+
+  console.log("Got error: " + error.message);
+
+});