Management API Reference for scattered-cache

Children (3)

• component
  • backups
  • expiration
  • locking
  • partition-handling
  • state-transfer
  • transaction
• memory
  • heap
  • off-heap
• store
  • custom
  • file
  • hotrod
  • jdbc
  • none
  • remote

Provided Capabilities (10)

Attributes (6)

• bias-lifespan - When greater than zero, specifies the duration (in ms) that a cache entry will be cached on a non-owner following a write operation.

  Type	LONG
  Default Value	300000
  Unit	MILLISECONDS
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Min	0
  Max	9223372036854775807
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "When greater than zero, specifies the duration (in ms) that a cache entry will be cached on a non-owner following a write operation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 300000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• invalidation-batch-size - The threshold after which batched invalidations are sent.

  Type	INT
  Default Value	128
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Min	0
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The threshold after which batched invalidations are sent.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 128, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• modules - The set of modules associated with this cache's configuration.

  Type	LIST
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The set of modules associated with this cache's configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• remote-timeout - In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

  Type	LONG
  Default Value	17500
  Unit	MILLISECONDS
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Min	0
  Max	9223372036854775807
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 17500, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• segments - Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.

  Type	INT
  Default Value	256
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Min	1
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 256, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• statistics-enabled - If enabled, statistics will be collected for this cache

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If enabled, statistics will be collected for this cache", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

• add - Add a scattered cache to this cache container

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  bias-lifespan	LONG	false	true	300000	When greater than zero, specifies the duration (in ms) that a cache entry will be cached on a non-owner following a write operation.
  invalidation-batch-size	INT	false	true	128	The threshold after which batched invalidations are sent.
  modules	LIST	false	true		The set of modules associated with this cache's configuration.
  remote-timeout	LONG	false	true	17500	In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
  segments	INT	false	true	256	Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.
  statistics-enabled	BOOLEAN	false	true	false	If enabled, statistics will be collected for this cache

  Raw DMR model

  { "operation-name" : "add", "description" : "Add a scattered cache to this cache container", "request-properties" : { "bias-lifespan" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "When greater than zero, specifies the duration (in ms) that a cache entry will be cached on a non-owner following a write operation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 300000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default" }, "invalidation-batch-size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The threshold after which batched invalidations are sent.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 128, "min" : 0, "max" : 2147483647, "stability" : "default" }, "modules" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The set of modules associated with this cache's configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "remote-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 17500, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default" }, "segments" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 256, "min" : 1, "max" : 2147483647, "stability" : "default" }, "statistics-enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If enabled, statistics will be collected for this cache", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Remove a scattered cache from this cache container

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove a scattered cache from this cache container", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.infinispan.cache-container.scattered-cache

          
  <feature spec="subsystem.infinispan.cache-container.scattered-cache">
    <param name="cache-container" value="{resource name}"/>
    <param name="scattered-cache" value="{resource name}"/>
    <param name="bias-lifespan" value="{value}"/>
    <param name="invalidation-batch-size" value="{value}"/>
    <param name="modules" value="{value}"/>
    <param name="remote-timeout" value="{value}"/>
    <param name="segments" value="{value}"/>
    <param name="statistics-enabled" value="{value}"/>
  <feature/>
          
        

  📋