Management API Reference for failover-realm

A realm definition that wraps two realms. One for default operation and the second to fail over to in case the first one is unavailable.

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=security/elytron-realm=* /subsystem=elytron/custom-modifiable-realm=* /subsystem=elytron/identity-realm=* /subsystem=elytron/aggregate-realm=* /subsystem=elytron/properties-realm=* /subsystem=elytron/caching-realm=* /subsystem=elytron/custom-realm=*

Attributes (3)

delegate-realm - Reference to the security realm to use as a default.

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" : "Reference to the security realm to use as a default.", "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" }`

emit-events - Whether SecurityEvent signifying delegate-realm unavailability should be emitted.

Type	BOOLEAN
Default Value	true
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" : "Whether SecurityEvent signifying delegate-realm unavailability should be emitted.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

failover-realm - Reference to the security realm to use in case the delegate-realm is unavailable.

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" : "Reference to the security realm to use in case the delegate-realm is unavailable.", "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 (2)

add - The add operation for the security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
delegate-realm	STRING	true	false		Reference to the security realm to use as a default.
emit-events	BOOLEAN	false	true	true	Whether SecurityEvent signifying delegate-realm unavailability should be emitted.
failover-realm	STRING	true	false		Reference to the security realm to use in case the delegate-realm is unavailable.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "delegate-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the security realm to use as a default.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.security-realm",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "emit-events" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether SecurityEvent signifying delegate-realm unavailability should be emitted.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "failover-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the security realm to use in case the delegate-realm is unavailable.",
            "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
}

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.failover-realm

        
<feature spec="subsystem.elytron.failover-realm">
  <param name="failover-realm" value="{resource name}"/>
  <param name="delegate-realm" value="{value}"/>
  <param name="emit-events" value="{value}"/>
  <param name="failover-realm-feature" value="{value}"/>
<feature/>