Module: infinispan

Infinispan module.
Source:

Type Definitions

ClientOptions

Client configuration settings. Object instances that override these configuration options can be used on client construction to tweak its behaviour.
Type:
  • Object
Properties:
Name Type Attributes Default Description
version 2.9 | 2.5 | 2.2 <optional>
<nullable>
 2.9 Version of client/server protocol.
cacheName String <optional>
<nullable>
 Optional cache name.
maxRetries Number <optional>
<nullable>
 3 Optional number of retries for operation.
ssl Object <optional>
<nullable>
 TLS/SSL properties.
Properties
Name Type Attributes Default Description
enabled boolean <optional>
<nullable>
 false Optional flag to enable SSL support.
secureProtocol String <optional>
<nullable>
 TLSv1_2_method Optional field with secure protocol in use.
trustCerts Array.<String> <optional>
<nullable>
 Optional paths of trusted SSL certificates.
clientAuth.key String <optional>
<nullable>
 Optional path to client authentication key.
clientAuth.passphrase String <optional>
<nullable>
 Optional password for client key.
clientAuth.cert String <optional>
<nullable>
 Optional client certificate.
sniHostName String <optional>
<nullable>
 Optional SNI host name.
cryptoStore.path String <optional>
<nullable>
 Optional crypto store path.
cryptoStore.passphrase String <optional>
<nullable>
 Optional password for crypto store.
authentication Object <optional>
<nullable>
 Authentication properties.
Properties
Name Type Attributes Description
enabled boolean <optional>
<nullable>
 Enable authentication.
saslMechanism String <optional>
<nullable>
 Select the SASL mechanism to use. Can be one of PLAIN, DIGEST-MD5, SCRAM-SHA-1, SCRAM-SHA-256, SCRAM-SHA-384, SCRAM-SHA-512, EXTERNAL, OAUTHBEARER
userName String <optional>
<nullable>
 The authentication username. Required by the PLAIN, DIGEST and SCRAM mechanisms.
password String <optional>
<nullable>
 The authentication password. Required by the PLAIN, DIGEST and SCRAM mechanisms.
token String <optional>
<nullable>
 The OAuth token. Required by the OAUTHBEARER mechanism.
authzid String <optional>
<nullable>
 The SASL authorization ID.
authzid String <optional>
<nullable>
 The SASL authorization ID.
dataFormat Object <optional>
<nullable>
 Content-type for entry
Properties
Name Type Attributes Description
keyType String <optional>
<nullable>
 Content-type for key
valueType String <optional>
<nullable>
 Content-type for value
topologyUpdates boolean <optional>
<nullable>
 true Optional flag to controls whether the client deals with topology updates or not.
mediaType "text/plain" | "application/json" <optional>
<nullable>
 "text/plain" Media type of the cache contents.
clusters Array.<Cluster> <optional>
<nullable>
 Optional additional clusters for cross-site failovers.
Since:
  • 0.3
Source:

Cluster

Cluster information.
Type:
  • Object
Properties:
Name Type Description
name String Cluster name.
servers Array.<ServerAddress> Cluster servers details.
Since:
  • 0.3
Source:

DurationUnit

A String formatted to specify duration unit information. Duration unit is formed of two elements, the first is the number of units, and the second is the unit itself: 's' for seconds, 'ms' for milliseconds, 'ns' for nanoseconds, 'μs' for microseconds, 'm' for minutes, 'h' for hours and 'd' for days. So, for example: '1s' would be one second, '5h' five hours...etc.
Type:
  • String
Since:
  • 0.3
Source:

Entry

Key/value entry.
Type:
  • Object
Properties:
Name Type Description
key String | Object Entry's key.
value String | Object Entry's value.
Since:
  • 0.3
Source:

ExecParams

Script execution parameters.
Type:
  • Object
Properties:
Name Type Description
PARAM_NAME String Name of the parameter.
PARAM_VALUE String Value of the parameter.
Since:
  • 0.3
Source:

IteratorNext

Iterator next object returned from completed Iterator.next() calls.
Type:
  • Object
Properties:
Name Type Attributes Description
key String | Object <nullable>
 If iteration not done, entry's key, otherwise undefined.
value String | Object <nullable>
 If iteration not done, entry's value, otherwise undefined.
done Boolean Indicates whether iteration has been completed. When true, key and value will be undefined. When false, key and value will be non-null.
Since:
  • 0.3
Source:

IteratorOptions

Iterator options defines a set of optional parameters that control how iteration occurs and the data that's iterated over.
Type:
  • Object
Properties:
Name Type Description
metadata Boolean Indicates whether entries iterated over also expose metadata information. This option is false by default which means no metadata information is exposed on iteration.
Since:
  • 0.3
Source:

ListenOptions

Listener options.
Type:
  • Object
Properties:
Name Type Description
listenerId String Listener identifier can be passed in as parameter to register multiple event callback functions for the same listener.
Since:
  • 0.3
Source:

MetadataValue

Metadata value.
Type:
  • Object
Properties:
Name Type Description
value String | Object Value associated with the key
version Buffer Version of the value as a byte buffer.
lifespan Number Lifespan of entry, defined in seconds. If the entry is immortal, it would be -1.
maxIdle Number Max idle time of entry, defined in seconds. If the entry is no transient, it would be -1.
Since:
  • 0.3
Source:

MultiStoreOptions

Multi store options defines a set of optional parameters that can be passed when storing multiple entries.
Type:
  • Object
Properties:
Name Type Description
lifespan DurationUnit Lifespan for the stored entry.
maxIdle DurationUnit Max idle time for the stored entry.
Since:
  • 0.3
Source:

RemoveOptions

Remove options defines a set of optional parameters that can be passed when removing data.
Type:
  • Object
Properties:
Name Type Description
previous Boolean Indicates whether previous value should be returned. If no previous value exists, it would return undefined.
Since:
  • 0.3
Source:

ServerAddress

Server address.
Type:
  • Object
Properties:
Name Type Description
host String Server host name.
port Number Server port.
Since:
  • 0.3
Source:

StatsItem

Statistic item.
Type:
  • Object
Properties:
Name Type Description
STAT_NAME String Name of the statistic.
STAT_VALUE String Value of the statistic.
Since:
  • 0.3
Source:

StoreOptions

Store options defines a set of optional parameters that can be passed when storing data.
Type:
  • Object
Properties:
Name Type Description
previous Boolean Indicates whether previous value should be returned. If no previous value exists, it would return undefined.
lifespan DurationUnit Lifespan for the stored entry.
maxIdle DurationUnit Max idle time for the stored entry.
Since:
  • 0.3
Source: