Management API Reference for caching-realm

A realm definition that enables caching to another security realm. The caching strategy is LRU (Least Recently Used) where least accessed entries are discarded when the maximum number of entries is reached.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.security-realm	true	/subsystem=elytron/jaas-realm=* /subsystem=elytron/jdbc-realm=* /subsystem=elytron/filesystem-realm=* /subsystem=elytron/token-realm=* /subsystem=elytron/ldap-realm=* /subsystem=elytron/distributed-realm=* /subsystem=elytron/key-store-realm=* /subsystem=elytron/failover-realm=* /subsystem=security/elytron-realm=* /subsystem=elytron/custom-modifiable-realm=* /subsystem=elytron/identity-realm=* /subsystem=elytron/aggregate-realm=* /subsystem=elytron/properties-realm=* /subsystem=elytron/custom-realm=*

Attributes (3)

maximum-age - The time in milliseconds that an item can stay in the cache.

Type	LONG
Default Value	-1
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The time in milliseconds that an item can stay in the cache.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

maximum-entries - The maximum number of entries to keep in the cache.

Type	INT
Default Value	16
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of entries to keep in the cache.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : 16, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

realm - A reference to a cacheable security realm.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A reference to a cacheable security realm.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.security-realm", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (3)

add - The add operation for the security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
maximum-age	LONG	false	false	-1	The time in milliseconds that an item can stay in the cache.
maximum-entries	INT	false	false	16	The maximum number of entries to keep in the cache.
realm	STRING	true	false		A reference to a cacheable security realm.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "maximum-age" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The time in milliseconds that an item can stay in the cache.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "maximum-entries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of entries to keep in the cache.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : 16,
            "stability" : "default"
        },
        "realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to a cacheable security realm.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.security-realm",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

clear-cache - Removes all entries from the cache.

Raw DMR model


{
    "operation-name" : "clear-cache",
    "description" : "Removes all entries from the cache.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - The remove operation for the security realm.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the security realm.",
    "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.elytron.caching-realm

        
<feature spec="subsystem.elytron.caching-realm">
  <param name="caching-realm" value="{resource name}"/>
  <param name="maximum-age" value="{value}"/>
  <param name="maximum-entries" value="{value}"/>
  <param name="realm" value="{value}"/>
<feature/>