Management API Reference for component=expiration

The cache expiration configuration.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache-configuration.component.expiration	true	/subsystem=infinispan/cache-container=/distributed-cache=/component=expiration /subsystem=infinispan/cache-container=/scattered-cache=/component=expiration /subsystem=infinispan/cache-container=/local-cache=/component=expiration /subsystem=infinispan/cache-container=/replicated-cache=/component=expiration

Attributes (3)

interval - Specifies the duration of time (in milliseconds) between expiration processing, during which expired cache entries will be purged from memory and stores. If zero, asynchronous expiration processing is disabled.

Type	LONG
Default Value	60000
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" : "Specifies the duration of time (in milliseconds) between expiration processing, during which expired cache entries will be purged from memory and stores. If zero, asynchronous expiration processing is disabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

lifespan - When defined, specifies the default duration of time (in milliseconds) since creation after which cache entries will auto-expire. When undefined, cache entries will not auto-expire due to age by default.

Type	LONG
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 defined, specifies the default duration of time (in milliseconds) since creation after which cache entries will auto-expire. When undefined, cache entries will not auto-expire due to age by default.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

max-idle - When defined, specifies the default duration of time (in milliseconds) since last access after which idle cache entries will auto-expire. When undefined, idle cache entries will not auto-expire by default.

Type	LONG
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 defined, specifies the default duration of time (in milliseconds) since last access after which idle cache entries will auto-expire. When undefined, idle cache entries will not auto-expire by default.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

add - Adds an expiration configuration element to the cache.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
interval	LONG	false	true	60000	Specifies the duration of time (in milliseconds) between expiration processing, during which expired cache entries will be purged from memory and stores. If zero, asynchronous expiration processing is disabled.
lifespan	LONG	false	true		When defined, specifies the default duration of time (in milliseconds) since creation after which cache entries will auto-expire. When undefined, cache entries will not auto-expire due to age by default.
max-idle	LONG	false	true		When defined, specifies the default duration of time (in milliseconds) since last access after which idle cache entries will auto-expire. When undefined, idle cache entries will not auto-expire by default.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds an expiration configuration element to the cache.",
    "request-properties" : {
        "interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Specifies the duration of time (in milliseconds) between expiration processing, during which expired cache entries will be purged from memory and stores.  If zero, asynchronous expiration processing is disabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "lifespan" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "When defined, specifies the default duration of time (in milliseconds) since creation after which cache entries will auto-expire. When undefined, cache entries will not auto-expire due to age by default.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "max-idle" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "When defined, specifies the default duration of time (in milliseconds) since last access after which idle cache entries will auto-expire. When undefined, idle cache entries will not auto-expire by default.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes an expiration configuration element from the cache.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes an expiration configuration element from the cache.",
    "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.invalidation-cache.component.expiration

        
<feature spec="subsystem.infinispan.cache-container.invalidation-cache.component.expiration">
  <param name="cache-container" value="{resource name}"/>
  <param name="invalidation-cache" value="{resource name}"/>
  <param name="interval" value="{value}"/>
  <param name="lifespan" value="{value}"/>
  <param name="max-idle" value="{value}"/>
<feature/>