{ "outcome" => "success", "result" => { "description" => "The root node of the server-level management model.", "min-occurs" => 1, "max-occurs" => 1, "attributes" => { "launch-type" => { "type" => STRING, "description" => "The manner in which the server process was launched. Either \"DOMAIN\" for a domain mode server launched by a Host Controller, \"STANDALONE\" for a standalone server launched from the command line, or \"EMBEDDED\" for a standalone server launched as an embedded part of an application running in the same virtual machine.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "DOMAIN", "STANDALONE", "EMBEDDED", "SELF_CONTAINED", "APPCLIENT" ], "access-type" => "read-only", "storage" => "runtime" }, "management-major-version" => { "type" => INT, "description" => "The major version of the WildFly Core kernel management interface that is provided by this server.", "expressions-allowed" => false, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "management-micro-version" => { "type" => INT, "description" => "The micro version of the WildFly Core kernel management interface that is provided by this server.", "expressions-allowed" => false, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "management-minor-version" => { "type" => INT, "description" => "The minor version of the WildFly Core kernel management interface that is provided by this server.", "expressions-allowed" => false, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "name" => { "type" => STRING, "description" => "The name of this server. If not set, defaults to the runtime value of InetAddress.getLocalHost().getHostName().", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "namespaces" => { "type" => OBJECT, "description" => "Map of namespaces used in the configuration XML document, where keys are namespace prefixes and values are schema URIs.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "organization" => { "type" => STRING, "description" => "Identification of the current organization running this server.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "process-type" => { "type" => STRING, "description" => "The type of process represented by this root resource. Always has a value of \"Server\" for a server resource.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "product-name" => { "type" => STRING, "description" => "The name of the WildFly Core based product that is being run by this server.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "product-version" => { "type" => STRING, "description" => "The version of the WildFly Core based product release that is being run by this server.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "profile-name" => { "type" => STRING, "description" => "The name of the server's configuration profile.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "release-codename" => { "type" => STRING, "description" => "The codename of the WildFly Core release this server is running.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "release-version" => { "type" => STRING, "description" => "The version of the WildFly Core release this server is running.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "running-mode" => { "type" => STRING, "description" => "The current running mode of the server. Either NORMAL (normal operations) or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "NORMAL", "ADMIN_ONLY" ], "access-type" => "read-only", "storage" => "runtime" }, "runtime-configuration-state" => { "type" => STRING, "description" => "The current persistent configuration state, one of starting, ok, reload-required, restart-required, stopping or stopped.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schema-locations" => { "type" => OBJECT, "description" => "Map of locations of XML schemas used in the configuration XML document, where keys are schema URIs and values are locations where the schema can be found.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "server-state" => { "type" => STRING, "description" => "The current state of the server controller; either STARTING, RUNNING, RESTART_REQUIRED, RELOAD_REQUIRED or STOPPING.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "suspend-state" => { "type" => STRING, "description" => "The suspend state of the server", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "RUNNING", "PRE_SUSPEND", "SUSPENDING", "SUSPENDED" ], "access-type" => "read-only", "storage" => "runtime" }, "uuid" => { "type" => STRING, "description" => "Unique Id of this server instance.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "subsystem" => { "description" => "The subsystems that make up the server's profile.", "model-description" => { "iiop-openjdk" => { "description" => "The iiop-openjdk subsystem configuration.", "attributes" => { "properties" => { "type" => OBJECT, "description" => "A list of generic key/value properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "auth-method" => { "type" => STRING, "description" => "The authentication method. Valid values are 'none' and 'username_password'.", "attribute-group" => "as-context", "expressions-allowed" => true, "nillable" => true, "default" => "username_password", "allowed" => [ "none", "username_password" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "realm" => { "type" => STRING, "description" => "The authentication service (AS) realm name.", "attribute-group" => "as-context", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "required" => { "type" => BOOLEAN, "description" => "Indicates if authentication is required (true) or not (false).", "attribute-group" => "as-context", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security" => { "type" => STRING, "description" => "Indicates whether the security interceptors are to be installed (on) or not (off).", "attribute-group" => "initializers", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "identity", "client", "none" ], "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "transactions" => { "type" => STRING, "description" => "Indicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts.", "attribute-group" => "initializers", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "full", "none", "spec" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "export-corbaloc" => { "type" => BOOLEAN, "description" => "Indicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off).", "attribute-group" => "naming", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "root-context" => { "type" => STRING, "description" => "The naming service root context.", "attribute-group" => "naming", "expressions-allowed" => true, "nillable" => true, "default" => "JBoss/Naming/root", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "giop-version" => { "type" => STRING, "description" => "The GIOP version to be used.", "attribute-group" => "orb", "expressions-allowed" => true, "nillable" => true, "default" => "1.2", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "persistent-server-id" => { "type" => STRING, "description" => "Persistent id of the server. Persistent object references are valid across many activactions of the server and they identify it using this property. As a result of that: many activations of the same server should have this property set to the same value, different server instances running on the same host should have different server ids.", "attribute-group" => "orb", "expressions-allowed" => false, "nillable" => true, "default" => "1", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "socket-binding" => { "type" => STRING, "description" => "The name of the socket binding configuration that specifies the ORB port.", "attribute-group" => "orb", "expressions-allowed" => false, "nillable" => true, "default" => "iiop", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-socket-binding" => { "type" => STRING, "description" => "The name of the socket binding configuration that specifies the ORB SSL port.", "attribute-group" => "orb", "expressions-allowed" => false, "nillable" => true, "default" => "iiop-ssl", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "caller-propagation" => { "type" => STRING, "description" => "Indicates whether the caller identity should be propagated in the SAS context or not. Valid values are 'none' and 'supported'.", "attribute-group" => "sas-context", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "add-component-via-interceptor" => { "type" => BOOLEAN, "description" => "Indicates whether SSL components should be added by an IOR interceptor (on) or not (off).", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "client-requires" => { "type" => STRING, "description" => "Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth).", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => "None", "allowed" => [ "None", "ServerAuth", "ClientAuth", "MutualAuth" ], "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "client-supports" => { "type" => STRING, "description" => "Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth).", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => "MutualAuth", "allowed" => [ "None", "ServerAuth", "ClientAuth", "MutualAuth" ], "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-domain" => { "type" => STRING, "description" => "The name of the security domain that holds the key and trust stores that will be used to establish SSL connections.", "attribute-group" => "security", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "socket-binding-ref" => {"type" => "core"}, "iiop-security" => {"type" => "iiop-openjdk"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "server-requires" => { "type" => STRING, "description" => "Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth).", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => "None", "allowed" => [ "None", "ServerAuth", "ClientAuth", "MutualAuth" ], "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "server-supports" => { "type" => STRING, "description" => "Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth).", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => "MutualAuth", "allowed" => [ "None", "ServerAuth", "ClientAuth", "MutualAuth" ], "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "support-ssl" => { "type" => BOOLEAN, "description" => "Indicates whether SSL is to be supported (on) or not (off).", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"iiop-security" => {"type" => "iiop-openjdk"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "high-water-mark" => { "type" => INT, "description" => "TCP connection cache parameter. Each time the number of connections exceeds this value ORB tries to reclaim connections. Number of reclaimed connections is specified by tcp-number-to-reclaim property. If this property is not set then it is configured as OpenJDK ORB default.", "attribute-group" => "tcp", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "number-to-reclaim" => { "type" => INT, "description" => "TCP connection cache parameter. Each time number of connections exceeds tcp-high-water-mark property then ORB tries to reclaim connections. Number of reclaimed connections is specified by this property. If it is not set then it is configured as OpenJDK ORB default.", "attribute-group" => "tcp", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "confidentiality" => { "type" => STRING, "description" => "Indicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'.", "attribute-group" => "transport-config", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported", "required" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "detect-misordering" => { "type" => STRING, "description" => "Indicates whether the transport must require misordering detection or not. Valid values are 'none', 'supported' and 'required'.", "attribute-group" => "transport-config", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported", "required" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "detect-replay" => { "type" => STRING, "description" => "Indicates whether the transport must require replay detection or not. Valid values are 'none', 'supported' and 'required'.", "attribute-group" => "transport-config", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported", "required" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "integrity" => { "type" => STRING, "description" => "Indicates whether the transport must require integrity protection or not. Valid values are 'none', 'supported' and 'required'.", "attribute-group" => "transport-config", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported", "required" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "trust-in-client" => { "type" => STRING, "description" => "Indicates if the transport must require trust in client to be established. Valid values are 'none', 'supported' and 'required'.", "attribute-group" => "transport-config", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported", "required" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "trust-in-target" => { "type" => STRING, "description" => "Indicates if the transport must require trust in target to be established. Valid values are 'none' and 'supported'.", "attribute-group" => "transport-config", "expressions-allowed" => true, "nillable" => true, "default" => "none", "allowed" => [ "none", "supported" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "jsr77" => { "description" => "The configuration of the JSR-77 subsystem.", "capabilities" => [{ "name" => "org.wildfly.jsr77", "dynamic" => false }], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "jpa" => { "description" => "The configuration of the JPA subsystem.", "attributes" => { "default-datasource" => { "type" => STRING, "description" => "The name of the default global datasource.", "expressions-allowed" => true, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-extended-persistence-inheritance" => { "type" => STRING, "description" => "Controls how JPA extended persistence context (XPC) inheritance is performed. 'DEEP' shares the extended persistence context at top bean level. 'SHALLOW' the extended persistece context is only shared with the parent bean (never with sibling beans).", "expressions-allowed" => true, "nillable" => true, "default" => "DEEP", "allowed" => [ "DEEP", "SHALLOW" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "messaging-activemq" => { "description" => "The messaging-activemq subsystem.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "jms-bridge" => { "description" => "A JMS bridge instance.", "model-description" => {"*" => { "description" => "A JMS bridge instance.", "attributes" => { "add-messageID-in-header" => { "type" => BOOLEAN, "description" => "If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-id" => { "type" => STRING, "description" => "The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "failure-retry-interval" => { "type" => LONG, "description" => "The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.", "expressions-allowed" => true, "nillable" => false, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-batch-size" => { "type" => INT, "description" => "The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-batch-time" => { "type" => LONG, "description" => "The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.", "expressions-allowed" => true, "nillable" => false, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-retries" => { "type" => INT, "description" => "The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "The name of AS7 module containing the resources required to lookup source and target JMS resources.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "paused" => { "type" => BOOLEAN, "description" => "Whether the JMS bridge is paused.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "quality-of-service" => { "type" => STRING, "description" => "The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "AT_MOST_ONCE", "DUPLICATES_OK", "ONCE_AND_ONLY_ONCE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "selector" => { "type" => STRING, "description" => "A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether the JMS bridge is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "subscription-name" => { "type" => STRING, "description" => "The name of the subscription if it is durable and the source destination is a topic.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "source-connection-factory" => { "type" => STRING, "description" => "The name of the source connection factory to lookup on the source messaging server.", "attribute-group" => "source", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "source-context" => { "type" => OBJECT, "description" => "The properties used to configure the source JNDI initial context.", "attribute-group" => "source", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "source-destination" => { "type" => STRING, "description" => "The name of the source destination to lookup on the source messaging server.", "attribute-group" => "source", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "source-password" => { "type" => STRING, "description" => "The password for creating the source connection.", "attribute-group" => "source", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "source-user" => { "type" => STRING, "description" => "The name of the user for creating the source connection.", "attribute-group" => "source", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target-connection-factory" => { "type" => STRING, "description" => "The name of the target connection factory to lookup on the target messaging server.", "attribute-group" => "target", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target-context" => { "type" => OBJECT, "description" => "The properties used to configure the target JNDI initial context.", "attribute-group" => "target", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target-destination" => { "type" => STRING, "description" => "The name of the target destination to lookup on the target messaging server.", "attribute-group" => "target", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target-password" => { "type" => STRING, "description" => "The password for creating the target connection.", "attribute-group" => "target", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target-user" => { "type" => STRING, "description" => "The name of the user for creating the target connection.", "attribute-group" => "target", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "server" => { "description" => "An ActiveMQ server instance.", "model-description" => {"*" => { "description" => "An ActiveMQ server instance.", "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Whether the server is active (and accepting connections) or passive (in backup mode, waiting for failover).", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "async-connection-execution-enabled" => { "type" => BOOLEAN, "description" => "Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-ttl-override" => { "type" => LONG, "description" => "If set, this will override how long (in ms) to keep a connection alive without receiving a ping.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "id-cache-size" => { "type" => INT, "description" => "The size of the cache for pre-creating message IDs.", "expressions-allowed" => true, "nillable" => true, "default" => 20000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "incoming-interceptors" => { "type" => LIST, "description" => "The list of incoming interceptor classes used by this server.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the interceptor class.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "module" => { "type" => STRING, "description" => "The name of the module that provides the interceptor class.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "outgoing-interceptors" => { "type" => LIST, "description" => "The list of outgoing interceptor classes used by this server.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the interceptor class.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "module" => { "type" => STRING, "description" => "The name of the module that provides the interceptor class.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "page-max-concurrent-io" => { "type" => INT, "description" => "The maximum number of concurrent reads allowed on paging", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "persist-delivery-count-before-delivery" => { "type" => BOOLEAN, "description" => "Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "persist-id-cache" => { "type" => BOOLEAN, "description" => "Whether IDs are persisted to the journal.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "persistence-enabled" => { "type" => BOOLEAN, "description" => "Whether the server will use the file based journal for persistence.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scheduled-thread-pool-max-size" => { "type" => INT, "description" => "The number of threads that the main scheduled thread pool has.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether this server is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "thread-pool-max-size" => { "type" => INT, "description" => "The number of threads that the main thread pool has. -1 means no limit.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "version" => { "type" => STRING, "description" => "The server's version.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "wild-card-routing-enabled" => { "type" => BOOLEAN, "description" => "Whether the server supports wild card routing.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-password" => { "type" => STRING, "description" => "The password used by cluster connections to communicate between the clustered nodes.", "attribute-group" => "cluster", "expressions-allowed" => true, "nillable" => true, "default" => "CHANGE ME!!", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-user" => { "type" => STRING, "description" => "The user used by cluster connections to communicate between the clustered nodes.", "attribute-group" => "cluster", "expressions-allowed" => true, "nillable" => true, "default" => "ACTIVEMQ.CLUSTER.ADMIN.USER", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "memory-measure-interval" => { "type" => LONG, "description" => "Frequency to sample JVM memory in ms (or -1 to disable memory sampling)", "attribute-group" => "debug", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "memory-warning-threshold" => { "type" => INT, "description" => "Percentage of available memory which if exceeded results in a warning log", "attribute-group" => "debug", "expressions-allowed" => true, "nillable" => true, "default" => 25, "unit" => "PERCENTAGE", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "perf-blast-pages" => { "type" => INT, "description" => "Number of pages to add to check the journal performance (only meant to be used to test performance of pages).", "attribute-group" => "debug", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "run-sync-speed-test" => { "type" => BOOLEAN, "description" => "Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.", "attribute-group" => "debug", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "server-dump-interval" => { "type" => LONG, "description" => "How often to dump basic runtime information to the server log. A value less than 1 disables this feature.", "attribute-group" => "debug", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "create-bindings-dir" => { "type" => BOOLEAN, "description" => "Whether the server should create the bindings directory on start up.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "create-journal-dir" => { "type" => BOOLEAN, "description" => "Whether the server should create the journal directory on start up.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-buffer-size" => { "type" => LONG, "description" => "The size of the internal buffer on the journal.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-buffer-timeout" => { "type" => LONG, "description" => "The timeout (in nanoseconds) used to flush internal buffers on the journal.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-compact-min-files" => { "type" => INT, "description" => "The minimal number of journal data files before we can start compacting.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => 10, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-compact-percentage" => { "type" => INT, "description" => "The percentage of live data on which we consider compacting the journal.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => 30, "unit" => "PERCENTAGE", "min" => 0L, "max" => 100L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-file-size" => { "type" => LONG, "description" => "The size (in bytes) of each journal file.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => 10485760, "unit" => "BYTES", "min" => 1024L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-max-io" => { "type" => INT, "description" => "The maximum number of write requests that can be in the AIO queue at any one time.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-min-files" => { "type" => INT, "description" => "How many journal files to pre-create.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => 2, "min" => 2L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-pool-files" => { "type" => INT, "description" => "The number of journal files that can be reused. ActiveMQ will create as many files as needed however when reclaiming files it will shrink back to the value (-1 means no limit).", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-sync-non-transactional" => { "type" => BOOLEAN, "description" => "Whether to wait for non transaction data to be synced to the journal before returning a response to the client.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-sync-transactional" => { "type" => BOOLEAN, "description" => "Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "journal-type" => { "type" => STRING, "description" => "The type of journal to use.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => "ASYNCIO", "allowed" => [ "NIO", "ASYNCIO" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "log-journal-write-rate" => { "type" => BOOLEAN, "description" => "Whether to periodically log the journal's write rate and flush rate.", "attribute-group" => "journal", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jmx-domain" => { "type" => STRING, "description" => "The JMX domain used to register internal ActiveMQ MBeans in the MBeanServer.", "attribute-group" => "management", "expressions-allowed" => true, "nillable" => true, "default" => "org.apache.activemq.artemis", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"messaging-management" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jmx-management-enabled" => { "type" => BOOLEAN, "description" => "Whether ActiveMQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.", "attribute-group" => "management", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"messaging-management" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "management-address" => { "type" => STRING, "description" => "Address to send management messages to.", "attribute-group" => "management", "expressions-allowed" => true, "nillable" => true, "default" => "jms.queue.activemq.management", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"messaging-management" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "management-notification-address" => { "type" => STRING, "description" => "The name of the address that consumers bind to to receive management notifications.", "attribute-group" => "management", "expressions-allowed" => true, "nillable" => true, "default" => "activemq.notifications", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"messaging-management" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "message-expiry-scan-period" => { "type" => LONG, "description" => "How often (in ms) to scan for expired messages.", "attribute-group" => "message-expiry", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "message-expiry-thread-priority" => { "type" => INT, "description" => "The priority of the thread expiring messages.", "attribute-group" => "message-expiry", "expressions-allowed" => true, "nillable" => true, "default" => 3, "min" => 1L, "max" => 10L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "override-in-vm-security" => { "type" => BOOLEAN, "description" => "Whether the ActiveMQ server will override security credentials for in-vm connections.", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-domain" => { "type" => STRING, "description" => "The security domain to use to verify user and role information", "attribute-group" => "security", "expressions-allowed" => false, "nillable" => true, "default" => "other", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-enabled" => { "type" => BOOLEAN, "description" => "Whether security is enabled.", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-constraints" => {"sensitive" => {"messaging-security" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-invalidation-interval" => { "type" => LONG, "description" => "How long (in ms) to wait before invalidating the security cache.", "attribute-group" => "security", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-constraints" => {"sensitive" => {"messaging-security" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "message-counter-max-day-history" => { "type" => INT, "description" => "How many days to keep message counter history.", "attribute-group" => "statistics", "expressions-allowed" => true, "nillable" => true, "default" => 10, "unit" => "DAYS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "message-counter-sample-period" => { "type" => LONG, "description" => "The sample period (in ms) to use for message counters.", "attribute-group" => "statistics", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Whether gathering of statistics such as message counters are enabled.", "attribute-group" => "statistics", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transaction-timeout" => { "type" => LONG, "description" => "How long (in ms) before a transaction can be removed from the resource manager after create time.", "attribute-group" => "transaction", "expressions-allowed" => true, "nillable" => true, "default" => 300000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "transaction-timeout-scan-period" => { "type" => LONG, "description" => "How often (in ms) to scan for timeout transactions.", "attribute-group" => "transaction", "expressions-allowed" => true, "nillable" => true, "default" => 1000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "discovery-group" => { "description" => "Multicast group to listen to receive broadcast from other servers announcing their connectors.", "model-description" => {"*" => { "description" => "Multicast group to listen to receive broadcast from other servers announcing their connectors.", "capabilities" => [{ "name" => "org.wildfly.messaging.activemq.discovery-group.channel-factory", "dynamic" => true }], "attributes" => { "initial-wait-timeout" => { "type" => LONG, "description" => "Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jgroups-channel" => { "type" => STRING, "description" => "The name used by a JGroups channel to join a cluster.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["socket-binding"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jgroups-stack" => { "type" => STRING, "description" => "The name of a stack defined in the org.jboss.as.clustering.jgroups subsystem that is used to form a cluster.", "expressions-allowed" => false, "nillable" => true, "requires" => ["jgroups-channel"], "capability-reference" => "org.wildfly.clustering.jgroups.channel-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "refresh-timeout" => { "type" => LONG, "description" => "Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "socket-binding" => { "type" => STRING, "description" => "The discovery group socket binding.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["jgroups-channel"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "connection-factory" => { "description" => "Defines a connection factory.", "model-description" => {"*" => { "description" => "Defines a connection factory.", "attributes" => { "auto-group" => { "type" => BOOLEAN, "description" => "Whether or not message grouping is automatically used", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "block-on-acknowledge" => { "type" => BOOLEAN, "description" => "True to set block on acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "block-on-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on durable send.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "block-on-non-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on non durable send.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-large-message-client" => { "type" => BOOLEAN, "description" => "True to cache large messages.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "call-failover-timeout" => { "type" => LONG, "description" => "The timeout to use when fail over is in process (in ms).", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "call-timeout" => { "type" => LONG, "description" => "The call time out.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-failure-check-period" => { "type" => LONG, "description" => "The client failure check period.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-id" => { "type" => STRING, "description" => "The client id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "compress-large-messages" => { "type" => BOOLEAN, "description" => "Whether large messages should be compressed.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation window size.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-load-balancing-policy-class-name" => { "type" => STRING, "description" => "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.", "expressions-allowed" => false, "nillable" => true, "default" => "org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-ttl" => { "type" => LONG, "description" => "The connection ttl.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connectors" => { "type" => LIST, "description" => "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "consumer-max-rate" => { "type" => INT, "description" => "The consumer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "consumer-window-size" => { "type" => INT, "description" => "The consumer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "discovery-group" => { "type" => STRING, "description" => "The discovery group name.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "dups-ok-batch-size" => { "type" => INT, "description" => "The dups ok batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "entries" => { "type" => LIST, "description" => "The jndi names the connection factory should be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "factory-type" => { "type" => STRING, "description" => "The type of connection factory.", "expressions-allowed" => true, "nillable" => true, "default" => "GENERIC", "allowed" => [ "GENERIC", "TOPIC", "QUEUE", "XA_GENERIC", "XA_QUEUE", "XA_TOPIC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "failover-on-initial-connection" => { "type" => BOOLEAN, "description" => "True to fail over on initial connection.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "group-id" => { "type" => STRING, "description" => "The group id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "ha" => { "type" => BOOLEAN, "description" => "Whether the connection factory supports High Availability.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-retry-interval" => { "type" => LONG, "description" => "The max retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "min-large-message-size" => { "type" => INT, "description" => "The min large message size.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "pre-acknowledge" => { "type" => BOOLEAN, "description" => "True to pre-acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "producer-max-rate" => { "type" => INT, "description" => "The producer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "producer-window-size" => { "type" => INT, "description" => "The producer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 65536, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "protocol-manager-factory" => { "type" => STRING, "description" => "The protocol manager factory used by this connection factory.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reconnect-attempts" => { "type" => INT, "description" => "The reconnect attempts.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "retry-interval" => { "type" => LONG, "description" => "The retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "The retry interval multiplier.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "scheduled-thread-pool-max-size" => { "type" => INT, "description" => "The scheduled thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "thread-pool-max-size" => { "type" => INT, "description" => "The thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transaction-batch-size" => { "type" => INT, "description" => "The transaction batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-global-pools" => { "type" => BOOLEAN, "description" => "True to use global pools.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "http-acceptor" => { "description" => "Defines a way in which remote connections can be made to the ActiveMQ server over HTTP.", "model-description" => {"*" => { "description" => "Defines a way in which remote connections can be made to the ActiveMQ server over HTTP.", "attributes" => { "http-listener" => { "type" => STRING, "description" => "The Undertow's http-listener that handles HTTP upgrade requests.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the acceptor factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "upgrade-legacy" => { "type" => BOOLEAN, "description" => "Also accepts to upgrade HTTP request from legacy (HornetQ) clients.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "connector-service" => { "description" => "A connector service allows to integrate external components with Apache ActiveMQ Artemis to send and receive messages.", "model-description" => {"*" => { "description" => "A connector service allows to integrate external components with Apache ActiveMQ Artemis to send and receive messages.", "attributes" => { "factory-class" => { "type" => STRING, "description" => "Class name of the factory class that can instantiate the connector service.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "params" => { "type" => OBJECT, "description" => "A key/value pair understood by the connector service's factory-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "http-connector" => { "description" => "Used by a remote client to define how it connects to a server over HTTP.", "model-description" => {"*" => { "description" => "Used by a remote client to define how it connects to a server over HTTP.", "attributes" => { "endpoint" => { "type" => STRING, "description" => "The http-acceptor that serves as the endpoint of this http-connector.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the connector factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding that the connector will use to create connections.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "in-vm-connector" => { "description" => "Used by an in-VM client to define how it connects to a server.", "model-description" => {"*" => { "description" => "Used by an in-VM client to define how it connects to a server.", "attributes" => { "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the connector factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-id" => { "type" => INT, "description" => "The server id.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "security-setting" => { "description" => "A security setting allows sets of permissions to be defined against queues based on their address.", "model-description" => {"*" => { "description" => "A security setting allows sets of permissions to be defined against queues based on their address.", "access-constraints" => {"application" => {"security-setting" => {"type" => "messaging-activemq"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"role" => { "description" => "A security role.", "model-description" => {"*" => { "description" => "A security role.", "access-constraints" => {"application" => {"security-setting" => {"type" => "messaging-activemq"}}}, "attributes" => { "consume" => { "type" => BOOLEAN, "description" => "This permission allows the user to consume a message from a queue bound to matching addresses.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "create-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to create a durable queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "create-non-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to create a temporary queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "delete-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to delete a durable queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "delete-non-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to delete a temporary queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "manage" => { "type" => BOOLEAN, "description" => "This permission allows the user to invoke management operations by sending management messages to the management address.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"messaging-management" => {"type" => "messaging-activemq"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "send" => { "type" => BOOLEAN, "description" => "This permission allows the user to send a message to matching addresses.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "ha-policy" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "model-description" => { "replication-colocated" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "backup-port-offset" => { "type" => INT, "description" => "The offset to use for the Connectors and Acceptors when creating a new backup server.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "backup-request-retries" => { "type" => INT, "description" => "How many times the live server will try to request a backup, -1 means for ever.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "backup-request-retry-interval" => { "type" => LONG, "description" => "How long (in ms) to wait for retries between attempts to request a backup server.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "excluded-connectors" => { "type" => LIST, "description" => "The connectors that must not have their port offset.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-backups" => { "type" => INT, "description" => "Whether or not this live server will accept backup requests from other live servers.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "request-backup" => { "type" => BOOLEAN, "description" => "If true then the server will request a backup on another node.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"configuration" => { "description" => "Configuration", "model-description" => { "slave" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "allow-failback" => { "type" => BOOLEAN, "description" => "Whether a server will automatically stop when a another places a request to take over its place. The use case is when a regular server stops and its backup takes over its duties, later the main server restarts and requests the server (the former backup) to stop operating.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-name" => { "type" => STRING, "description" => "Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "group-name" => { "type" => STRING, "description" => "If set, backup servers will only pair with live servers with matching group-name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-replication-sync-timeout" => { "type" => LONG, "description" => "How long to wait until the initiation replication is synchronized.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-saved-replicated-journal-size" => { "type" => INT, "description" => "This specifies how many times a replicated backup server can restart after moving its files on start. Once there are this number of backup journal files the server will stop permanently after if fails back.", "expressions-allowed" => true, "nillable" => true, "default" => 2, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "restart-backup" => { "type" => BOOLEAN, "description" => "Will this server, if a backup, restart once it has been stopped because of failback or scaling down.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down" => { "type" => BOOLEAN, "description" => "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-cluster-name" => { "type" => STRING, "description" => "Name of the cluster used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-connectors" => { "type" => LIST, "description" => "List of connectors used to form the scale-down cluster.", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-discovery-group" => { "type" => STRING, "description" => "Name of the discovery group used to build the scale-down cluster", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-group-name" => { "type" => STRING, "description" => "Name of the group used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "master" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "check-for-live-server" => { "type" => BOOLEAN, "description" => "Whether to check the cluster for another server using the same server ID when starting up.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-name" => { "type" => STRING, "description" => "Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "group-name" => { "type" => STRING, "description" => "If set, backup servers will only pair with live servers with matching group-name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-replication-sync-timeout" => { "type" => LONG, "description" => "How long to wait until the initiation replication is synchronized.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} }, "replication-master" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "check-for-live-server" => { "type" => BOOLEAN, "description" => "Whether to check the cluster for another server using the same server ID when starting up.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-name" => { "type" => STRING, "description" => "Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "group-name" => { "type" => STRING, "description" => "If set, backup servers will only pair with live servers with matching group-name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-replication-sync-timeout" => { "type" => LONG, "description" => "How long to wait until the initiation replication is synchronized.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "shared-store-slave" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "allow-failback" => { "type" => BOOLEAN, "description" => "Whether a server will automatically stop when a another places a request to take over its place. The use case is when a regular server stops and its backup takes over its duties, later the main server restarts and requests the server (the former backup) to stop operating.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "failover-on-server-shutdown" => { "type" => BOOLEAN, "description" => "Whether the server must failover when it is normally shutdown.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "restart-backup" => { "type" => BOOLEAN, "description" => "Will this server, if a backup, restart once it has been stopped because of failback or scaling down.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down" => { "type" => BOOLEAN, "description" => "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-cluster-name" => { "type" => STRING, "description" => "Name of the cluster used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-connectors" => { "type" => LIST, "description" => "List of connectors used to form the scale-down cluster.", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-discovery-group" => { "type" => STRING, "description" => "Name of the discovery group used to build the scale-down cluster", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-group-name" => { "type" => STRING, "description" => "Name of the group used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "live-only" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "scale-down" => { "type" => BOOLEAN, "description" => "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-cluster-name" => { "type" => STRING, "description" => "Name of the cluster used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-connectors" => { "type" => LIST, "description" => "List of connectors used to form the scale-down cluster.", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-discovery-group" => { "type" => STRING, "description" => "Name of the discovery group used to build the scale-down cluster", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-group-name" => { "type" => STRING, "description" => "Name of the group used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "shared-store-master" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => {"failover-on-server-shutdown" => { "type" => BOOLEAN, "description" => "Whether the server must failover when it is normally shutdown.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "replication-slave" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "allow-failback" => { "type" => BOOLEAN, "description" => "Whether a server will automatically stop when a another places a request to take over its place. The use case is when a regular server stops and its backup takes over its duties, later the main server restarts and requests the server (the former backup) to stop operating.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-name" => { "type" => STRING, "description" => "Name of the cluster used for replication. If it is undefined, the name of the first cluster connection defined in the configuration will be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "group-name" => { "type" => STRING, "description" => "If set, backup servers will only pair with live servers with matching group-name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-replication-sync-timeout" => { "type" => LONG, "description" => "How long to wait until the initiation replication is synchronized.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-saved-replicated-journal-size" => { "type" => INT, "description" => "This specifies how many times a replicated backup server can restart after moving its files on start. Once there are this number of backup journal files the server will stop permanently after if fails back.", "expressions-allowed" => true, "nillable" => true, "default" => 2, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "restart-backup" => { "type" => BOOLEAN, "description" => "Will this server, if a backup, restart once it has been stopped because of failback or scaling down.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down" => { "type" => BOOLEAN, "description" => "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-cluster-name" => { "type" => STRING, "description" => "Name of the cluster used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-connectors" => { "type" => LIST, "description" => "List of connectors used to form the scale-down cluster.", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-discovery-group" => { "type" => STRING, "description" => "Name of the discovery group used to build the scale-down cluster", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-group-name" => { "type" => STRING, "description" => "Name of the group used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "shared-store-colocated" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "backup-port-offset" => { "type" => INT, "description" => "The offset to use for the Connectors and Acceptors when creating a new backup server.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "backup-request-retries" => { "type" => INT, "description" => "How many times the live server will try to request a backup, -1 means for ever.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "backup-request-retry-interval" => { "type" => LONG, "description" => "How long (in ms) to wait for retries between attempts to request a backup server.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-backups" => { "type" => INT, "description" => "Whether or not this live server will accept backup requests from other live servers.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "request-backup" => { "type" => BOOLEAN, "description" => "If true then the server will request a backup on another node.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"configuration" => { "description" => "Configuration", "model-description" => { "slave" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => { "allow-failback" => { "type" => BOOLEAN, "description" => "Whether a server will automatically stop when a another places a request to take over its place. The use case is when a regular server stops and its backup takes over its duties, later the main server restarts and requests the server (the former backup) to stop operating.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "failover-on-server-shutdown" => { "type" => BOOLEAN, "description" => "Whether the server must failover when it is normally shutdown.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "restart-backup" => { "type" => BOOLEAN, "description" => "Will this server, if a backup, restart once it has been stopped because of failback or scaling down.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down" => { "type" => BOOLEAN, "description" => "Configure whether this server send its messages to another live server in the scale-down cluster when it is shutdown cleanly.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-cluster-name" => { "type" => STRING, "description" => "Name of the cluster used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-connectors" => { "type" => LIST, "description" => "List of connectors used to form the scale-down cluster.", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-discovery-group" => { "type" => STRING, "description" => "Name of the discovery group used to build the scale-down cluster", "attribute-group" => "scale-down", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["scale-down-connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scale-down-group-name" => { "type" => STRING, "description" => "Name of the group used to scale down.", "attribute-group" => "scale-down", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "master" => { "description" => "A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, or replication-colocated).", "attributes" => {"failover-on-server-shutdown" => { "type" => BOOLEAN, "description" => "Whether the server must failover when it is normally shutdown.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} } } }, "divert" => { "description" => "A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.", "model-description" => {"*" => { "description" => "A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.", "attributes" => { "divert-address" => { "type" => STRING, "description" => "Address to divert from", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "exclusive" => { "type" => BOOLEAN, "description" => "Whether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "filter" => { "type" => STRING, "description" => "An optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the ActiveMQ filter expression syntax described in the ActiveMQ documentation.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "forwarding-address" => { "type" => STRING, "description" => "Address to divert to", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "routing-name" => { "type" => STRING, "description" => "Routing name of the divert", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "transformer-class-name" => { "type" => STRING, "description" => "The name of a class used to transform the message's body or properties before it is diverted.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "pooled-connection-factory" => { "description" => "Defines a managed connection factory.", "model-description" => {"*" => { "description" => "Defines a managed connection factory.", "attributes" => { "auto-group" => { "type" => BOOLEAN, "description" => "The autogroup.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "block-on-acknowledge" => { "type" => BOOLEAN, "description" => "True to set block on acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "block-on-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on durable send.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "block-on-non-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on non durable send.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cache-large-message-client" => { "type" => BOOLEAN, "description" => "True to cache large messages.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "call-failover-timeout" => { "type" => LONG, "description" => "The timeout to use when fail over is in process (in ms).", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "call-timeout" => { "type" => LONG, "description" => "The call time out.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "client-failure-check-period" => { "type" => LONG, "description" => "The client failure check period.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "client-id" => { "type" => STRING, "description" => "The client id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "compress-large-messages" => { "type" => BOOLEAN, "description" => "Whether large messages should be compressed.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation window size.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-load-balancing-policy-class-name" => { "type" => STRING, "description" => "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.", "expressions-allowed" => false, "nillable" => true, "default" => "org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-ttl" => { "type" => LONG, "description" => "The connection ttl.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connectors" => { "type" => LIST, "description" => "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "consumer-max-rate" => { "type" => INT, "description" => "The consumer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "consumer-window-size" => { "type" => INT, "description" => "The consumer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "discovery-group" => { "type" => STRING, "description" => "The discovery group name.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "dups-ok-batch-size" => { "type" => INT, "description" => "The dups ok batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "entries" => { "type" => LIST, "description" => "The jndi names the connection factory should be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "failover-on-initial-connection" => { "type" => BOOLEAN, "description" => "True to fail over on initial connection.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "group-id" => { "type" => STRING, "description" => "The group id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ha" => { "type" => BOOLEAN, "description" => "Whether the connection factory supports High Availability.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-connect-attempts" => { "type" => INT, "description" => "The number of attempts to connect initially with this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-message-packet-size" => { "type" => INT, "description" => "The initial size of messages created through this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1500, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "managed-connection-pool" => { "type" => STRING, "description" => "The class name of the managed connection pool used by this pooled-connection-factory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-pool-size" => { "type" => INT, "description" => "The maximum size for the pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-retry-interval" => { "type" => LONG, "description" => "The max retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "min-large-message-size" => { "type" => INT, "description" => "The min large message size.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "min-pool-size" => { "type" => INT, "description" => "The minimum size for the pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "pre-acknowledge" => { "type" => BOOLEAN, "description" => "True to pre-acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "producer-max-rate" => { "type" => INT, "description" => "The producer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "producer-window-size" => { "type" => INT, "description" => "The producer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 65536, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "protocol-manager-factory" => { "type" => STRING, "description" => "The protocol manager factory used by this pooled connection factory.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "reconnect-attempts" => { "type" => INT, "description" => "The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "retry-interval" => { "type" => LONG, "description" => "The retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "The retry interval multiplier.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scheduled-thread-pool-max-size" => { "type" => INT, "description" => "The scheduled thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "thread-pool-max-size" => { "type" => INT, "description" => "The thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "transaction" => { "type" => STRING, "description" => "The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).", "expressions-allowed" => true, "nillable" => true, "default" => "transaction", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "transaction-batch-size" => { "type" => INT, "description" => "The transaction batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-auto-recovery" => { "type" => BOOLEAN, "description" => "True to use auto recovery.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-global-pools" => { "type" => BOOLEAN, "description" => "True to use global pools.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "user" => { "type" => STRING, "description" => "The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jndi-params" => { "type" => STRING, "description" => "The JNDI params to use for locating the destination for incoming connections.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "rebalance-connections" => { "type" => BOOLEAN, "description" => "Rebalance inbound connections when cluster topology changes.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "setup-attempts" => { "type" => INT, "description" => "The number of times to set up an MDB endpoint", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "setup-interval" => { "type" => LONG, "description" => "The interval between attempts at setting up an MDB endpoint.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-jndi" => { "type" => BOOLEAN, "description" => "Use JNDI to locate the destination for incoming connections", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-local-tx" => { "type" => BOOLEAN, "description" => "Use a local transaction for incoming sessions", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "acceptor" => { "description" => "An acceptor defines a way in which connections can be made to the ActiveMQ server.", "model-description" => {"*" => { "description" => "An acceptor defines a way in which connections can be made to the ActiveMQ server.", "attributes" => { "factory-class" => { "type" => STRING, "description" => "Class name of the factory class that can instantiate the acceptor.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the acceptor factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding that the acceptor will use to accept connections.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether this acceptor is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "legacy-connection-factory" => { "description" => "Connection Factory resource used by legacy HornetQ clients to connect to the messaging-activemq subsystem.", "model-description" => {"*" => { "description" => "Defines a connection factory.", "attributes" => { "auto-group" => { "type" => BOOLEAN, "description" => "Whether or not message grouping is automatically used", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "block-on-acknowledge" => { "type" => BOOLEAN, "description" => "True to set block on acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "block-on-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on durable send.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "block-on-non-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on non durable send.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-large-message-client" => { "type" => BOOLEAN, "description" => "True to cache large messages.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "call-failover-timeout" => { "type" => LONG, "description" => "The timeout to use when fail over is in process (in ms).", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "call-timeout" => { "type" => LONG, "description" => "The call time out.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-failure-check-period" => { "type" => LONG, "description" => "The client failure check period.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-id" => { "type" => STRING, "description" => "The client id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "compress-large-messages" => { "type" => BOOLEAN, "description" => "Whether large messages should be compressed.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation window size.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-load-balancing-policy-class-name" => { "type" => STRING, "description" => "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.", "expressions-allowed" => false, "nillable" => true, "default" => "org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-ttl" => { "type" => LONG, "description" => "The connection ttl.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connectors" => { "type" => LIST, "description" => "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "consumer-max-rate" => { "type" => INT, "description" => "The consumer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "consumer-window-size" => { "type" => INT, "description" => "The consumer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "discovery-group" => { "type" => STRING, "description" => "The discovery group name.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "dups-ok-batch-size" => { "type" => INT, "description" => "The dups ok batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "entries" => { "type" => LIST, "description" => "The jndi names the connection factory should be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "factory-type" => { "type" => STRING, "description" => "The type of connection factory.", "expressions-allowed" => true, "nillable" => true, "default" => "GENERIC", "allowed" => [ "GENERIC", "TOPIC", "QUEUE", "XA_GENERIC", "XA_QUEUE", "XA_TOPIC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "failover-on-initial-connection" => { "type" => BOOLEAN, "description" => "True to fail over on initial connection.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "group-id" => { "type" => STRING, "description" => "The group id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "ha" => { "type" => BOOLEAN, "description" => "Whether the connection factory supports High Availability.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "initial-connect-attempts" => { "type" => INT, "description" => "The number of attempts for the initial connection to the server.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "initial-message-packet-size" => { "type" => INT, "description" => "The initial size of messages created through this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1500, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-retry-interval" => { "type" => LONG, "description" => "The max retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "min-large-message-size" => { "type" => INT, "description" => "The min large message size.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pre-acknowledge" => { "type" => BOOLEAN, "description" => "True to pre-acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "producer-max-rate" => { "type" => INT, "description" => "The producer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "producer-window-size" => { "type" => INT, "description" => "The producer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 65536, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reconnect-attempts" => { "type" => INT, "description" => "The reconnect attempts.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "retry-interval" => { "type" => LONG, "description" => "The retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "The retry interval multiplier.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "scheduled-thread-pool-max-size" => { "type" => INT, "description" => "The scheduled thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "thread-pool-max-size" => { "type" => INT, "description" => "The thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transaction-batch-size" => { "type" => INT, "description" => "The transaction batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-global-pools" => { "type" => BOOLEAN, "description" => "True to use global pools.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "queue" => { "description" => "A Queue.", "model-description" => {"*" => { "description" => "A Queue.", "access-constraints" => {"application" => {"queue" => {"type" => "messaging-activemq"}}}, "attributes" => { "consumer-count" => { "type" => INT, "description" => "The number of consumers consuming messages from this queue.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "dead-letter-address" => { "type" => STRING, "description" => "The address to send the queue's dead messages to.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable" => { "type" => BOOLEAN, "description" => "Defines whether the queue is durable.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "expiry-address" => { "type" => STRING, "description" => "The address to send the queue's expired messages to.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "filter" => { "type" => STRING, "description" => "A queue message filter definition. An undefined or empty filter will match all messages.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "id" => { "type" => LONG, "description" => "The id of the queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "paused" => { "type" => BOOLEAN, "description" => "Whether the queue is paused.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "queue-address" => { "type" => STRING, "description" => "The queue address defines what address is used for routing messages.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "scheduled-count" => { "type" => LONG, "description" => "The number of scheduled messages in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the queue is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "in-vm-acceptor" => { "description" => "Defines a way in which in-VM connections can be made to the ActiveMQ server.", "model-description" => {"*" => { "description" => "Defines a way in which in-VM connections can be made to the ActiveMQ server.", "attributes" => { "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the acceptor factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-id" => { "type" => INT, "description" => "The server id.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether this acceptor is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "grouping-handler" => { "description" => "Makes decisions about which node in a cluster should handle a message with a group id assigned.", "model-description" => {"*" => { "description" => "Makes decisions about which node in a cluster should handle a message with a group id assigned.", "attributes" => { "group-timeout" => { "type" => LONG, "description" => "How long a group binding will be used, -1 means for ever. Bindings are removed after this wait elapses (valid for both LOCAL and REMOTE handlers).", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "grouping-handler-address" => { "type" => STRING, "description" => "A reference to a cluster connection and the address it uses.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "reaper-period" => { "type" => LONG, "description" => "How often the reaper will be run to check for timed out group bindings (only valid for LOCAL handlers).", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "timeout" => { "type" => LONG, "description" => "How long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "type" => { "type" => STRING, "description" => "Whether the handler is the single \"Local\" handler for the cluster, which makes handling decisions, or a \"Remote\" handler which converses with the local handler.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "LOCAL", "REMOTE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "core-address" => { "description" => "A runtime-only resource representing a ActiveMQ \"address\". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.", "model-description" => {"*" => { "description" => "A runtime-only resource representing a ActiveMQ \"address\". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.", "storage" => "runtime-only", "attributes" => { "binding-names" => { "type" => LIST, "description" => "The names of all bindings (both queues and diverts) bound to this address.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "number-of-bytes-per-page" => { "type" => LONG, "description" => "The number of bytes used by each page for this address.", "expressions-allowed" => false, "nillable" => false, "unit" => "BYTES", "access-type" => "read-only", "storage" => "runtime" }, "number-of-pages" => { "type" => INT, "description" => "The number of pages used by this address.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "queue-names" => { "type" => LIST, "description" => "The names of the queues associated with the address.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"role" => { "description" => "A security role.", "model-description" => {"*" => { "description" => "A security role.", "storage" => "runtime-only", "attributes" => { "consume" => { "type" => BOOLEAN, "description" => "This permission allows the user to consume a message from a queue bound to matching addresses.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "create-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to create a durable queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "create-non-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to create a temporary queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "delete-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to delete a durable queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "delete-non-durable-queue" => { "type" => BOOLEAN, "description" => "This permission allows the user to delete a temporary queue.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "manage" => { "type" => BOOLEAN, "description" => "This permission allows the user to invoke management operations by sending management messages to the management address.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"messaging-management" => {"type" => "messaging-activemq"}}}, "access-type" => "read-only", "storage" => "runtime" }, "send" => { "type" => BOOLEAN, "description" => "This permission allows the user to send a message to matching addresses.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "remote-acceptor" => { "description" => "Defines a way in which remote connections can be made to the ActiveMQ server.", "model-description" => {"*" => { "description" => "Defines a way in which remote connections can be made to the ActiveMQ server.", "attributes" => { "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the acceptor factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding that the acceptor will use to accept connections.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether this acceptor is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "bridge" => { "description" => "The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different ActiveMQ server.", "model-description" => {"*" => { "description" => "The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different ActiveMQ server.", "attributes" => { "check-period" => { "type" => LONG, "description" => "The period (in milliseconds) between client failure check.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation-window-size to use for the connection used to forward messages to the target node.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-ttl" => { "type" => LONG, "description" => "The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "discovery-group" => { "type" => STRING, "description" => "The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["static-connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "filter" => { "type" => STRING, "description" => "An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ filter expression syntax described in the ActiveMQ documentation.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "forwarding-address" => { "type" => STRING, "description" => "The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ha" => { "type" => BOOLEAN, "description" => "Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-connect-attempts" => { "type" => INT, "description" => "The number of attempts to connect initially with this bridge.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-retry-interval" => { "type" => LONG, "description" => "The maximum interval of time used to retry connections", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "min-large-message-size" => { "type" => INT, "description" => "The minimum size (in bytes) for a message before it is considered as a large message.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used.", "expressions-allowed" => true, "nillable" => true, "default" => "CHANGE ME!!", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "producer-window-size" => { "type" => INT, "description" => "Producer flow control size on the bridge.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-name" => { "type" => STRING, "description" => "The unique name of the local queue that the bridge consumes from.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "reconnect-attempts" => { "type" => INT, "description" => "The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "reconnect-attempts-on-same-node" => { "type" => INT, "description" => "The total number of reconnect attempts on the same node the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "retry-interval" => { "type" => LONG, "description" => "The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether the bridge is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "static-connectors" => { "type" => LIST, "description" => "A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "transformer-class-name" => { "type" => STRING, "description" => "The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-duplicate-detection" => { "type" => BOOLEAN, "description" => "Whether the bridge will automatically insert a duplicate id property into each message that it forwards.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "user" => { "type" => STRING, "description" => "The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used.", "expressions-allowed" => true, "nillable" => true, "default" => "ACTIVEMQ.CLUSTER.ADMIN.USER", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "path" => { "description" => "A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.", "model-description" => { "paging-directory" => { "description" => "A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.", "min-occurs" => 1, "attributes" => { "path" => { "type" => STRING, "description" => "The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.", "expressions-allowed" => true, "nillable" => true, "default" => "activemq/paging", "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:", "expressions-allowed" => false, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "bindings-directory" => { "description" => "A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.", "min-occurs" => 1, "attributes" => { "path" => { "type" => STRING, "description" => "The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.", "expressions-allowed" => true, "nillable" => true, "default" => "activemq/bindings", "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:", "expressions-allowed" => false, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "large-messages-directory" => { "description" => "A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.", "min-occurs" => 1, "attributes" => { "path" => { "type" => STRING, "description" => "The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.", "expressions-allowed" => true, "nillable" => true, "default" => "activemq/largemessages", "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:", "expressions-allowed" => false, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "journal-directory" => { "description" => "A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.", "min-occurs" => 1, "attributes" => { "path" => { "type" => STRING, "description" => "The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.", "expressions-allowed" => true, "nillable" => true, "default" => "activemq/journal", "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:", "expressions-allowed" => false, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "cluster-connection" => { "description" => "Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.", "model-description" => {"*" => { "description" => "Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.", "attributes" => { "allow-direct-connections-only" => { "type" => BOOLEAN, "description" => "Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.", "expressions-allowed" => true, "nillable" => true, "default" => false, "alternatives" => ["discovery-group"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "call-failover-timeout" => { "type" => LONG, "description" => "The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "call-timeout" => { "type" => LONG, "description" => "The timeout (in ms) for remote calls made by the cluster connection.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "check-period" => { "type" => LONG, "description" => "The period (in milliseconds) between client failure check.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cluster-connection-address" => { "type" => STRING, "description" => "Each cluster connection only applies to messages sent to an address that starts with this value.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation-window-size to use for the connection used to forward messages to a target node.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-ttl" => { "type" => LONG, "description" => "The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connector-name" => { "type" => STRING, "description" => "The name of connector to use for live connection", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "discovery-group" => { "type" => STRING, "description" => "The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.", "expressions-allowed" => false, "nillable" => true, "alternatives" => [ "allow-direct-connections-only", "static-connectors" ], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "initial-connect-attempts" => { "type" => INT, "description" => "The number of attempts to connect initially with this cluster connection.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-hops" => { "type" => INT, "description" => "The maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-retry-interval" => { "type" => LONG, "description" => "The maximum interval of time used to retry connections", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "message-load-balancing-type" => { "type" => STRING, "description" => "The type of message load balancing provided by the cluster connection.", "expressions-allowed" => true, "nillable" => true, "default" => "ON_DEMAND", "allowed" => [ "OFF", "STRICT", "ON_DEMAND" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "min-large-message-size" => { "type" => INT, "description" => "The minimum size (in bytes) for a message before it is considered as a large message.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "node-id" => { "type" => STRING, "description" => "The node ID used by this cluster connection.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "notification-attempts" => { "type" => INT, "description" => "How many times the cluster connection will broadcast itself", "expressions-allowed" => true, "nillable" => true, "default" => 2, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "notification-interval" => { "type" => LONG, "description" => "How often the cluster connection will broadcast itself", "expressions-allowed" => true, "nillable" => true, "default" => 1000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "producer-window-size" => { "type" => INT, "description" => "Producer flow control size on the cluster connection.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "reconnect-attempts" => { "type" => INT, "description" => "The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "retry-interval" => { "type" => LONG, "description" => "The period in milliseconds between subsequent attempts to reconnect to a target server, if the connection to the target server has failed.", "expressions-allowed" => true, "nillable" => true, "default" => 500L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether the cluster connection is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "static-connectors" => { "type" => LIST, "description" => "The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "topology" => { "type" => STRING, "description" => "The topology of the nodes that this cluster connection is aware of.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-duplicate-detection" => { "type" => BOOLEAN, "description" => "Whether the bridge will automatically insert a duplicate id property into each message that it forwards.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "broadcast-group" => { "description" => "A broadcast group is the means by which a server broadcasts connectors over the network.", "model-description" => {"*" => { "description" => "A broadcast group is the means by which a server broadcasts connectors over the network.", "capabilities" => [{ "name" => "org.wildfly.messaging.activemq.broadcast-group.channel-factory", "dynamic" => true }], "attributes" => { "broadcast-period" => { "type" => LONG, "description" => "The period in milliseconds between consecutive broadcasts.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connectors" => { "type" => LIST, "description" => "Specifies the names of connectors that will be broadcast.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jgroups-channel" => { "type" => STRING, "description" => "The name used by a JGroups channel to join a cluster.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["socket-binding"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jgroups-stack" => { "type" => STRING, "description" => "The name of a stack defined in the org.jboss.as.clustering.jgroups subsystem that is used to form a cluster.", "expressions-allowed" => false, "nillable" => true, "requires" => ["jgroups-channel"], "capability-reference" => "org.wildfly.clustering.jgroups.channel-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "socket-binding" => { "type" => STRING, "description" => "The broadcast group socket binding.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["jgroups-channel"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "started" => { "type" => BOOLEAN, "description" => "Whether the broadcast group is started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "runtime-queue" => { "description" => "A runtime queue.", "model-description" => {"*" => { "description" => "A Queue.", "storage" => "runtime-only", "attributes" => { "consumer-count" => { "type" => INT, "description" => "The number of consumers consuming messages from this queue.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "dead-letter-address" => { "type" => STRING, "description" => "The address to send the queue's dead messages to.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable" => { "type" => BOOLEAN, "description" => "Defines whether the queue is durable.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "expiry-address" => { "type" => STRING, "description" => "The address to send the queue's expired messages to.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "filter" => { "type" => STRING, "description" => "A queue message filter definition. An undefined or empty filter will match all messages.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "id" => { "type" => LONG, "description" => "The id of the queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "paused" => { "type" => BOOLEAN, "description" => "Whether the queue is paused.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "queue-address" => { "type" => STRING, "description" => "The queue address defines what address is used for routing messages.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "scheduled-count" => { "type" => LONG, "description" => "The number of scheduled messages in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the queue is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "jms-topic" => { "description" => "Defines a JMS topic.", "model-description" => {"*" => { "description" => "Defines a JMS topic.", "access-constraints" => {"application" => {"jms-topic" => {"type" => "messaging-activemq"}}}, "attributes" => { "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable-message-count" => { "type" => INT, "description" => "The number of messages for all durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable-subscription-count" => { "type" => INT, "description" => "The number of durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "entries" => { "type" => LIST, "description" => "The jndi names the topic will be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "legacy-entries" => { "type" => LIST, "description" => "The legacy jndi names the topic will be bound to.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "non-durable-message-count" => { "type" => INT, "description" => "The number of messages for all non-durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "non-durable-subscription-count" => { "type" => INT, "description" => "The number of non-durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "subscription-count" => { "type" => INT, "description" => "The number of (durable and non-durable) subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the topic is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "topic-address" => { "type" => STRING, "description" => "The address the topic points to.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "address-setting" => { "description" => "An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.", "model-description" => {"*" => { "description" => "An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.", "attributes" => { "address-full-policy" => { "type" => STRING, "description" => "Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK)", "expressions-allowed" => true, "nillable" => true, "default" => "PAGE", "allowed" => [ "DROP", "PAGE", "BLOCK", "FAIL" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "auto-create-jms-queues" => { "type" => BOOLEAN, "description" => "Determines whether ActiveMQ should automatically create a JMS queue corresponding to the address-settings match when a JMS producer or a consumer is tries to use such a queue.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "auto-delete-jms-queues" => { "type" => BOOLEAN, "description" => "Determises Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "dead-letter-address" => { "type" => STRING, "description" => "The dead letter address", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "expiry-address" => { "type" => STRING, "description" => "Defines where to send a message that has expired.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "expiry-delay" => { "type" => LONG, "description" => "Defines the expiration time that will be used for messages using the default expiration time", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "last-value-queue" => { "type" => BOOLEAN, "description" => "Defines whether a queue only uses last values or not", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-delivery-attempts" => { "type" => INT, "description" => "Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address", "expressions-allowed" => true, "nillable" => true, "default" => 10, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-redelivery-delay" => { "type" => LONG, "description" => "Maximum value for the redelivery-delay (in ms).", "expressions-allowed" => true, "nillable" => true, "default" => 0L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-size-bytes" => { "type" => LONG, "description" => "The max bytes size.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "message-counter-history-day-limit" => { "type" => INT, "description" => "Day limit for the message counter history.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "unit" => "DAYS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "page-max-cache-size" => { "type" => INT, "description" => "The number of page files to keep in memory to optimize IO during paging navigation.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "page-size-bytes" => { "type" => LONG, "description" => "The paging size.", "expressions-allowed" => true, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redelivery-delay" => { "type" => LONG, "description" => "Defines how long to wait before attempting redelivery of a cancelled message", "expressions-allowed" => true, "nillable" => true, "default" => 0L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redelivery-multiplier" => { "type" => DOUBLE, "description" => "Multiplier to apply to the redelivery-delay parameter", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redistribution-delay" => { "type" => LONG, "description" => "Defines how long to wait when the last consumer is closed on a queue before redistributing any messages", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "send-to-dla-on-no-route" => { "type" => BOOLEAN, "description" => "If this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "slow-consumer-check-period" => { "type" => LONG, "description" => "How often to check for slow consumers on a particular queue.", "expressions-allowed" => true, "nillable" => true, "default" => 5L, "unit" => "MINUTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "slow-consumer-policy" => { "type" => STRING, "description" => "Determine what happens when a slow consumer is identified.", "expressions-allowed" => true, "nillable" => true, "default" => "NOTIFY", "allowed" => [ "KILL", "NOTIFY" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "slow-consumer-threshold" => { "type" => LONG, "description" => "The minimum rate of message consumption allowed before a consumer is considered slow.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "connector" => { "description" => "A connector can be used by a client to define how it connects to a server.", "model-description" => {"*" => { "description" => "A connector can be used by a client to define how it connects to a server.", "attributes" => { "factory-class" => { "type" => STRING, "description" => "Class name of the factory class that can instantiate the connector.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the connector factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding that the connector will use to create connections.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "remote-connector" => { "description" => "Used by a remote client to define how it connects to a server.", "model-description" => {"*" => { "description" => "Used by a remote client to define how it connects to a server.", "attributes" => { "params" => { "type" => OBJECT, "description" => "A key-value pair understood by the connector factory-class and used to configure it.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding that the connector will use to create connections.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "jms-queue" => { "description" => "Defines a JMS queue.", "model-description" => {"*" => { "description" => "Defines a JMS queue.", "access-constraints" => {"application" => {"jms-queue" => {"type" => "messaging-activemq"}}}, "attributes" => { "consumer-count" => { "type" => INT, "description" => "The number of consumers consuming messages from this queue.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "dead-letter-address" => { "type" => STRING, "description" => "The address to send dead messages to.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable" => { "type" => BOOLEAN, "description" => "Whether the queue is durable or not.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "entries" => { "type" => LIST, "description" => "The jndi names the queue will be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "expiry-address" => { "type" => STRING, "description" => "The address to send expired messages to.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "legacy-entries" => { "type" => LIST, "description" => "The jndi names the queue will be bound to.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "paused" => { "type" => BOOLEAN, "description" => "Whether the queue is paused.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "queue-address" => { "type" => STRING, "description" => "The queue address defines what address is used for routing messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "scheduled-count" => { "type" => LONG, "description" => "The number of scheduled messages in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "selector" => { "type" => STRING, "description" => "The queue selector.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the queue is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} } } }, "transactions" => { "description" => "The configuration of the transaction subsystem.", "capabilities" => [{ "name" => "org.wildfly.transactions", "dynamic" => false }], "attributes" => { "average-commit-time" => { "type" => LONG, "description" => "The average time of transaction commit in nanoseconds, measured from the moment the client calls commit until the transaction manager determines that the commit attempt was successful.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "default-timeout" => { "type" => INT, "description" => "The default timeout for a transaction managed by the transaction manager.", "expressions-allowed" => true, "nillable" => true, "default" => 300, "unit" => "SECONDS", "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enable-statistics" => { "type" => BOOLEAN, "description" => "Whether transaction statistics should be gathered.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "2.0.0", "reason" => "Use statistics-enabled." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enable-tsm-status" => { "type" => BOOLEAN, "description" => "Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "hornetq-store-enable-async-io" => { "type" => BOOLEAN, "description" => "Whether AsyncIO should be enabled for the journal store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "requires" => ["use-hornetq-store"], "deprecated" => { "since" => "3.0.0", "reason" => "Use journal-store-enable-async-io" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-action-store-drop-table" => { "type" => BOOLEAN, "description" => "Configure if jdbc action store should drop tables.", "expressions-allowed" => true, "nillable" => true, "default" => false, "requires" => ["use-jdbc-store"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-action-store-table-prefix" => { "type" => STRING, "description" => "Optional prefix for table used to write transcation logs in configured jdbc action store.", "expressions-allowed" => true, "nillable" => true, "requires" => ["use-jdbc-store"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-communication-store-drop-table" => { "type" => BOOLEAN, "description" => "Configure if jdbc communication store should drop tables.", "expressions-allowed" => true, "nillable" => true, "default" => false, "requires" => ["use-jdbc-store"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-communication-store-table-prefix" => { "type" => STRING, "description" => "Optional prefix for table used to write transcation logs in configured jdbc communication store.", "expressions-allowed" => true, "nillable" => true, "requires" => ["use-jdbc-store"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-state-store-drop-table" => { "type" => BOOLEAN, "description" => "Configure if jdbc state store should drop tables.", "expressions-allowed" => true, "nillable" => true, "default" => false, "requires" => ["use-jdbc-store"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-state-store-table-prefix" => { "type" => STRING, "description" => "Optional prefix for table used to write transcation logs in configured jdbc state store.", "expressions-allowed" => true, "nillable" => true, "requires" => ["use-jdbc-store"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jdbc-store-datasource" => { "type" => STRING, "description" => "Jndi name of non-XA datasource used. Datasource sghould be define in datasources subsystem. For this would work the non-XA datasource has to be marked as jta=\"false\".", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "journal-store-enable-async-io" => { "type" => BOOLEAN, "description" => "Whether AsyncIO should be enabled for the journal store. For this settings being active journal natives libraries needs to be available.", "expressions-allowed" => true, "nillable" => true, "default" => false, "requires" => ["use-journal-store"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "jts" => { "type" => BOOLEAN, "description" => "If true this enables the Java Transaction Service. Use of the JTS needs configuration in IIOP OpenJDK where Transactions parameter needs to be set to full.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "node-identifier" => { "type" => STRING, "description" => "Used to set the node identifier on the core environment. Each Xid that Transaction Manager creates will have this identifier encoded within it and ensures Transaction Manager will only recover branches which match the specified identifier. It is imperative that this identifier is unique between Application Server instances which share either an object store or access common resource managers.", "expressions-allowed" => true, "nillable" => true, "default" => "1", "min-length" => 0L, "max-length" => 23L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "number-of-aborted-transactions" => { "type" => LONG, "description" => "The number of aborted (i.e. rolledback) transactions.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-application-rollbacks" => { "type" => LONG, "description" => "The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behavior is considered an attribute of the application configuration.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-committed-transactions" => { "type" => LONG, "description" => "The number of committed transactions.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-heuristics" => { "type" => LONG, "description" => "The number of transactions which have terminated with heuristic outcomes.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-inflight-transactions" => { "type" => LONG, "description" => "The number of transactions that have begun but not yet terminated.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-nested-transactions" => { "type" => LONG, "description" => "The total number of nested (sub) transactions created.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-resource-rollbacks" => { "type" => LONG, "description" => "The number of transactions that rolled back due to resource (participant) failure.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-system-rollbacks" => { "type" => LONG, "description" => "The number of transactions that have been rolled back due to internal system errors.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-timed-out-transactions" => { "type" => LONG, "description" => "The number of transactions that have rolled back due to timeout.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "number-of-transactions" => { "type" => LONG, "description" => "The total number of transactions (top-level and nested) created", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "object-store-path" => { "type" => STRING, "description" => "Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the \"relative-to\" attribute. This settings is valid when default or journal store is used. It's not used when jdbc journal store is used.", "expressions-allowed" => true, "nillable" => true, "default" => "tx-object-store", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "object-store-relative-to" => { "type" => STRING, "description" => "References a global path configuration in the domain model, defaulting to the Application Server data directory (jboss.server.data.dir). The value of the \"Object store path\" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the \"Object store path\" attribute to be treated as an absolute path.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "process-id-socket-binding" => { "type" => STRING, "description" => "The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.", "expressions-allowed" => true, "nillable" => false, "alternatives" => ["process-id-uuid"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "process-id-socket-max-ports" => { "type" => INT, "description" => "The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "requires" => ["process-id-socket-binding"], "min" => 1L, "max" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "process-id-uuid" => { "type" => BOOLEAN, "description" => "Indicates whether the transaction manager should use a UUID based process id.", "expressions-allowed" => false, "nillable" => false, "default" => false, "alternatives" => ["process-id-socket-binding"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "recovery-listener" => { "type" => BOOLEAN, "description" => "Used to specify if the recovery system should listen on a network socket or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "socket-binding" => { "type" => STRING, "description" => "Used to reference the correct socket binding to use for the recovery environment.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Whether transaction statistics should be gathered.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "status-socket-binding" => { "type" => STRING, "description" => "Used to reference the correct socket binding to use for the transaction status manager.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-hornetq-store" => { "type" => BOOLEAN, "description" => "Use the journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file system file per transaction log.It's alternative to jdbc based store.", "expressions-allowed" => false, "nillable" => true, "default" => false, "deprecated" => { "since" => "3.0.0", "reason" => "Use use-journal-store" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "use-jdbc-store" => { "type" => BOOLEAN, "description" => "Use the jdbc store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file file per transaction log. It's alternative to journal based store.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" }, "use-journal-store" => { "type" => BOOLEAN, "description" => "Use the journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store creates normally one file system file per transaction log. The journal one consists from one file for all the transactions. It's alternative to jdbc based store.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "jvm" } }, "operations" => undefined, "notifications" => undefined, "children" => { "log-store" => { "description" => "Representation of the transaction logging storage mechanism.", "model-description" => {"log-store" => { "description" => "Representation of the transaction logging storage mechanism.", "attributes" => { "expose-all-logs" => { "type" => BOOLEAN, "description" => "Whether to expose all logs like orphans etc. By default only a subset of transaction logs is exposed.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "type" => { "type" => STRING, "description" => "Specifies the implementation type of the logging store.", "expressions-allowed" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {"transactions" => { "description" => "The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.", "model-description" => {"*" => { "description" => "The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.", "attributes" => { "age-in-seconds" => { "type" => LONG, "description" => "The time since this transaction was prepared or when the recovery system last tried to recover it.", "expressions-allowed" => false, "nillable" => true, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "id" => { "type" => STRING, "description" => "The id of this transaction.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jmx-name" => { "type" => STRING, "description" => "The JMX name of this transaction.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "type" => { "type" => STRING, "description" => "The type name under which this record is stored.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"participants" => { "description" => "The resources that did work in a transaction.", "model-description" => {"*" => { "description" => "The resources that did work in a transaction.", "attributes" => { "eis-product-name" => { "type" => STRING, "description" => "The JCA enterprise information system's product name.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "eis-product-version" => { "type" => STRING, "description" => "The JCA enterprise information system's product version", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "jmx-name" => { "type" => STRING, "description" => "The JMX name of this participant.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "jndi-name" => { "type" => STRING, "description" => "JNDI name of this participant.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "status" => { "type" => STRING, "description" => "Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "PENDING", "PREPARED", "FAILED", "HEURISTIC", "READONLY" ], "access-type" => "read-only", "storage" => "configuration" }, "type" => { "type" => STRING, "description" => "The type name under which this record is stored.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "commit-markable-resource" => { "description" => "a CMR resource (i.e. a local resource that can reliably participate in an XA transaction)", "model-description" => {"*" => { "description" => "a CMR resource (i.e. a local resource that can reliably participate in an XA transaction)", "attributes" => { "batch-size" => { "type" => INT, "description" => "Batch size for this CMR resource", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "immediate-cleanup" => { "type" => BOOLEAN, "description" => "Immediate cleanup associated to this CMR resource", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jndi-name" => { "type" => STRING, "description" => "JNDi name of this CMR resource", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "name" => { "type" => STRING, "description" => "table name for storing XIDs", "expressions-allowed" => true, "nillable" => true, "default" => "xids", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "modcluster" => { "description" => "The configuration of the modcluster subsystem.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"mod-cluster-config" => { "description" => "Defines configuration resource", "model-description" => {"configuration" => { "description" => "The common modcluster configuration.", "attributes" => { "advertise" => { "type" => BOOLEAN, "description" => "Use Advertise logic or not.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "advertise-security-key" => { "type" => STRING, "description" => "String containing the security key for the Advertise logic.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mod_cluster-security" => {"type" => "modcluster"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "advertise-socket" => { "type" => STRING, "description" => "Name of Socket binding to use for the Advertise socket.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "auto-enable-contexts" => { "type" => BOOLEAN, "description" => "Enable contexts even if disabled in mod_cluster_manager (httpd).", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "balancer" => { "type" => STRING, "description" => "The balancer name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connector" => { "type" => STRING, "description" => "The name of Undertow listener that mod_cluster reverse proxy will connect to.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "excluded-contexts" => { "type" => STRING, "description" => "List of contexts mod_cluster should ignore, Format String separated with commas.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "flush-packets" => { "type" => BOOLEAN, "description" => "Enables/disables packet flushing in httpd.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "flush-wait" => { "type" => INT, "description" => "Time to wait before flushing packets in httpd.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "SECONDS", "min" => -1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "load-balancing-group" => { "type" => STRING, "description" => "loadBalancingGroup name.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-attempts" => { "type" => INT, "description" => "Max attempts to process an idempotent request.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => -1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "node-timeout" => { "type" => INT, "description" => "Timeout (in seconds) for proxy connections to a node.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "SECONDS", "min" => -1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ping" => { "type" => INT, "description" => "Time (in seconds) in which to wait for a pong answer to a ping.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "proxies" => { "type" => LIST, "description" => "List of proxies for mod_cluster to register with defined by outbound-socket-binding in socket-binding-group.", "expressions-allowed" => false, "nillable" => true, "access-constraints" => {"sensitive" => {"mod_cluster-proxies" => {"type" => "modcluster"}}}, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "proxy-list" => { "type" => STRING, "description" => "List of proxies, Format (hostname:port) separated with comas.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["proxies"], "deprecated" => { "since" => "2.0.0", "reason" => "proxy-list attribute has been deprecated in favor of proxies (list of references to outbound-socket-binding)" }, "access-constraints" => {"sensitive" => {"mod_cluster-proxies" => {"type" => "modcluster"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "proxy-url" => { "type" => STRING, "description" => "Base URL for MCMP requests.", "expressions-allowed" => true, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"mod_cluster-proxies" => {"type" => "modcluster"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "session-draining-strategy" => { "type" => STRING, "description" => "Session draining strategy used during undeployment of a web application", "expressions-allowed" => true, "nillable" => true, "default" => "DEFAULT", "allowed" => [ "DEFAULT", "ALWAYS", "NEVER" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "simple-load-provider" => { "type" => INT, "description" => "Simple load provider", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "smax" => { "type" => INT, "description" => "Soft maximum idle connection count in httpd", "expressions-allowed" => true, "nillable" => true, "default" => -1, "min" => -1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "socket-timeout" => { "type" => INT, "description" => "Timeout to wait for httpd to answer a MCMP message.", "expressions-allowed" => true, "nillable" => true, "default" => 20, "unit" => "SECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "status-interval" => { "type" => INT, "description" => "Number of seconds a STATUS message is sent from the application server to the reverse proxy.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "unit" => "SECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "sticky-session" => { "type" => BOOLEAN, "description" => "Use sticky sessions for requests.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "sticky-session-force" => { "type" => BOOLEAN, "description" => "Don't failover a request with session information.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "sticky-session-remove" => { "type" => BOOLEAN, "description" => "Remove session information on failover.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "stop-context-timeout" => { "type" => INT, "description" => "Max time to wait for context to process pending requests.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "unit" => "SECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ttl" => { "type" => INT, "description" => "Time to live (in seconds) for idle connections above smax", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "SECONDS", "min" => -1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker-timeout" => { "type" => INT, "description" => "Timeout to wait in httpd for an available worker to process the requests.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "SECONDS", "min" => -1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "dynamic-load-provider" => { "description" => "Dynamic load provider", "model-description" => {"configuration" => { "description" => "Dynamic load provider", "attributes" => { "decay" => { "type" => INT, "description" => "Decay", "expressions-allowed" => true, "nillable" => true, "default" => 2, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "history" => { "type" => INT, "description" => "History", "expressions-allowed" => true, "nillable" => true, "default" => 9, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "load-metric" => { "description" => "Load metric definition", "model-description" => {"*" => { "description" => "Load metric definition", "attributes" => { "capacity" => { "type" => DOUBLE, "description" => "Capacity of the metric.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "property" => { "type" => OBJECT, "description" => "Properties for the metric.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "type" => { "type" => STRING, "description" => "Type of the metric", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "cpu", "mem", "heap", "sessions", "receive-traffic", "send-traffic", "requests", "busyness" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "weight" => { "type" => INT, "description" => "Weight of the metric.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "custom-load-metric" => { "description" => "Custom load metric", "model-description" => {"*" => { "description" => "Load metric definition", "attributes" => { "capacity" => { "type" => DOUBLE, "description" => "Capacity of the metric.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "class" => { "type" => STRING, "description" => "Class name of the custom metric.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "property" => { "type" => OBJECT, "description" => "Properties for the metric.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "weight" => { "type" => INT, "description" => "Weight of the metric.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "ssl" => { "description" => "The SSL configuration to client MCMP logic.", "model-description" => {"configuration" => { "description" => "The SSL configuration to client MCMP logic.", "access-constraints" => {"sensitive" => {"mod_cluster-security" => {"type" => "modcluster"}}}, "attributes" => { "ca-certificate-file" => { "type" => STRING, "description" => "Certificate authority.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ca-revocation-url" => { "type" => STRING, "description" => "Certificate authority revocation list.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "certificate-key-file" => { "type" => STRING, "description" => "Key file for the certificate.", "expressions-allowed" => true, "nillable" => true, "default" => expression "${user.home}/.keystore", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cipher-suite" => { "type" => STRING, "description" => "The allowed cipher suite.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "key-alias" => { "type" => STRING, "description" => "The key alias.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "Password.", "expressions-allowed" => true, "nillable" => true, "default" => "changeit", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "protocol" => { "type" => STRING, "description" => "The SSL protocols that are enabled.", "expressions-allowed" => true, "nillable" => true, "default" => "TLS", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }, "pojo" => { "description" => "Support JBoss5 and JBoss6 pojo configuration model.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "infinispan" => { "description" => "The configuration of the infinispan subsystem.", "capabilities" => [ { "name" => "org.wildfly.clustering.default-group", "dynamic" => false }, { "name" => "org.wildfly.clustering.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.command-dispatcher-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.default-command-dispatcher-factory", "dynamic" => false }, { "name" => "org.wildfly.clustering.default-node-factory", "dynamic" => false } ], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"cache-container" => { "description" => "The configuration of an infinispan cache container", "model-description" => {"*" => { "description" => "The configuration of an infinispan cache container", "capabilities" => [ { "name" => "org.wildfly.clustering.infinispan.cache-container", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.key-affinity-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-singleton-service-builder-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-registry-entry", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.default-cache-configuration", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-registry-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-group", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.default-service-provider-registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.default-cache", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache-container-configuration", "dynamic" => true } ], "attributes" => { "aliases" => { "type" => LIST, "description" => "The list of aliases for this cache container", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-manager-status" => { "type" => STRING, "description" => "The status of the cache manager component. May return null if the cache manager is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "cluster-name" => { "type" => STRING, "description" => "The name of the cluster this node belongs to. May return null if the cache manager is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "coordinator-address" => { "type" => STRING, "description" => "The logical address of the cluster's coordinator. May return null if the cache manager is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "default-cache" => { "type" => STRING, "description" => "The default infinispan cache", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.clustering.infinispan.cache-configuration", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "eviction-executor" => { "type" => STRING, "description" => "The scheduled executor used for eviction", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. This will be replaced by thread pool configuration embedded in the subsystem in a future release." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "is-coordinator" => { "type" => BOOLEAN, "description" => "Set to true if this node is the cluster's coordinator. May return null if the cache manager is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "The jndi name to which to bind this cache container", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "listener-executor" => { "type" => STRING, "description" => "The executor used for the replication queue", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. This will be replaced by thread pool configuration embedded in the subsystem in a future release." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "local-address" => { "type" => STRING, "description" => "The local address of the node. May return null if the cache manager is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module whose class loader should be used when building this cache container's configuration.", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.as.clustering.infinispan", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "replication-queue-executor" => { "type" => STRING, "description" => "The executor used for asynchronous cache operations", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. This will be replaced by thread pool configuration embedded in the subsystem in a future release." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "start" => { "type" => STRING, "description" => "The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start).", "expressions-allowed" => true, "nillable" => true, "default" => "LAZY", "allowed" => ["LAZY"], "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Future releases will only support LAZY mode." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "If enabled, statistics will be collected for this cache container", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "thread-pool" => { "description" => "Defines thread pools for this cache container", "model-description" => { "transport" => { "description" => "Defines a thread pool used for asynchronous transport communication.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 25, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 25, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 100000, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "async-operations" => { "description" => "Defines a thread pool used for asynchronous operations.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 25, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 25, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "remote-command" => { "description" => "Defines a thread pool used to execute remote commands.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "state-transfer" => { "description" => "Defines a thread pool used for for state transfer.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 60, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "listener" => { "description" => "Defines a thread pool used for asynchronous cache listener notifications.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 100000, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "expiration" => { "description" => "Defines a thread pool used for for evictions.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "persistence" => { "description" => "Defines a thread pool used for interacting with the persistent store.", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 4, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "transport" => { "description" => "A transport child of the cache container.", "model-description" => { "jgroups" => { "description" => "The description of the transport used by this cache container", "capabilities" => [ { "name" => "org.wildfly.clustering.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.command-dispatcher-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.transport.channel-factory", "dynamic" => true } ], "attributes" => { "channel" => { "type" => STRING, "description" => "The channel of this cache container's transport.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.clustering.jgroups.channel-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cluster" => { "type" => STRING, "description" => "The name of the group communication cluster", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. The cluster used by the transport of this cache container is configured via the JGroups subsystem." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "executor" => { "type" => STRING, "description" => "The executor to use for the transport", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. This will be replaced by thread pool configuration embedded in the subsystem in a future release." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "lock-timeout" => { "type" => LONG, "description" => "The timeout for locks for the transport", "expressions-allowed" => true, "nillable" => true, "default" => 240000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stack" => { "type" => STRING, "description" => "The jgroups stack to use for the transport", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. The protocol stack used by the transport of this cache container is configured via the JGroups subsystem." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "none" => { "description" => "A local-only transport used by this cache-container", "capabilities" => [ { "name" => "org.wildfly.clustering.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.command-dispatcher-factory", "dynamic" => true } ], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "distributed-cache" => { "description" => "A distributed cache child of the cache container.", "model-description" => {"*" => { "description" => "A distributed cache configuration.", "capabilities" => [ { "name" => "org.wildfly.clustering.cache.service-provider-registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.singleton-service-builder-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache-configuration", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-entry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-factory", "dynamic" => true } ], "attributes" => { "activations" => { "type" => LONG, "description" => "The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "async-marshalling" => { "type" => BOOLEAN, "description" => "If enabled, this will cause marshalling of entries to be performed asynchronously.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Asynchronous marshalling is no longer supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "average-read-time" => { "type" => LONG, "description" => "Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-replication-time" => { "type" => LONG, "description" => "The average time taken to replicate data around the cluster. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-write-time" => { "type" => LONG, "description" => "Average time (in ms) for cache writes. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "batching" => { "type" => BOOLEAN, "description" => "If enabled, the invocation batching API will be made available for this cache.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Replaced by BATCH transaction mode." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-status" => { "type" => STRING, "description" => "The status of the cache component. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-factor" => { "type" => DOUBLE, "description" => "Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "consistent-hash-strategy" => { "type" => STRING, "description" => "Defines the consistent hash strategy for the cache.", "expressions-allowed" => true, "nillable" => true, "default" => "INTER_CACHE", "allowed" => [ "INTER_CACHE", "INTRA_CACHE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "elapsed-time" => { "type" => LONG, "description" => "Time (in secs) since cache started. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hit-ratio" => { "type" => DOUBLE, "description" => "The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hits" => { "type" => LONG, "description" => "The number of cache attribute hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "indexing" => { "type" => STRING, "description" => "If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "LOCAL", "ALL" ], "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "indexing-properties" => { "type" => OBJECT, "description" => "Properties to control indexing behaviour", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "invalidations" => { "type" => LONG, "description" => "The number of cache invalidations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "The jndi-name to which to bind this cache instance.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "l1-lifespan" => { "type" => LONG, "description" => "Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.", "expressions-allowed" => true, "nillable" => true, "default" => 600000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "misses" => { "type" => LONG, "description" => "The number of cache attribute misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "mode" => { "type" => STRING, "description" => "Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "SYNC", "ASYNC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module whose class loader should be used when building this cache's configuration.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-entries" => { "type" => INT, "description" => "The current number of entries in the cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "owners" => { "type" => INT, "description" => "Number of cluster-wide replicas for each cache entry.", "expressions-allowed" => true, "nillable" => true, "default" => 2, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivations" => { "type" => LONG, "description" => "The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "queue-flush-interval" => { "type" => LONG, "description" => "In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.", "expressions-allowed" => true, "nillable" => true, "default" => 10L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. This attribute will be ignored." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-size" => { "type" => INT, "description" => "In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. This attribute will be ignored." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-write-ratio" => { "type" => DOUBLE, "description" => "The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remote-timeout" => { "type" => 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, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remove-hits" => { "type" => LONG, "description" => "The number of cache attribute remove hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remove-misses" => { "type" => LONG, "description" => "The number of cache attribute remove misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "replication-count" => { "type" => LONG, "description" => "The number of times data was replicated around the cluster. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "replication-failures" => { "type" => LONG, "description" => "The number of data replication failures. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "segments" => { "type" => 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, "nillable" => true, "default" => 256, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "start" => { "type" => STRING, "description" => "The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).", "expressions-allowed" => true, "nillable" => true, "default" => "LAZY", "allowed" => ["LAZY"], "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Only LAZY mode is supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "If enabled, statistics will be collected for this cache", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stores" => { "type" => LONG, "description" => "The number of cache attribute put operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "success-ratio" => { "type" => DOUBLE, "description" => "The data replication success ratio (successes/successes+failures). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "time-since-reset" => { "type" => LONG, "description" => "Time (in secs) since cache statistics were reset. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "component" => { "description" => "A configuration component of a cache.", "model-description" => { "expiration" => { "description" => "The cache expiration configuration.", "attributes" => { "interval" => { "type" => LONG, "description" => "Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "lifespan" => { "type" => LONG, "description" => "Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-idle" => { "type" => LONG, "description" => "Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "state-transfer" => { "description" => "The state transfer configuration for distributed and replicated caches.", "attributes" => { "chunk-size" => { "type" => INT, "description" => "The size, in bytes, in which to batch the transfer of cache entries.", "expressions-allowed" => true, "nillable" => true, "default" => 512, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Always enabled for replicated and distributed caches." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timeout" => { "type" => LONG, "description" => "The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.", "expressions-allowed" => true, "nillable" => true, "default" => 240000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "eviction" => { "description" => "The cache eviction configuration.", "attributes" => { "evictions" => { "type" => LONG, "description" => "The number of cache eviction operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "max-entries" => { "type" => LONG, "description" => "Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "strategy" => { "type" => STRING, "description" => "Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "UNORDERED", "FIFO", "LRU", "LIRS" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "locking" => { "description" => "The locking configuration of the cache.", "attributes" => { "acquire-timeout" => { "type" => LONG, "description" => "Maximum time to attempt a particular lock acquisition.", "expressions-allowed" => true, "nillable" => true, "default" => 15000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "concurrency-level" => { "type" => INT, "description" => "Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "current-concurrency-level" => { "type" => INT, "description" => "The estimated number of concurrently updating threads which this cache can support. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "isolation" => { "type" => STRING, "description" => "Sets the cache locking isolation level.", "expressions-allowed" => true, "nillable" => true, "default" => "READ_COMMITTED", "allowed" => [ "NONE", "SERIALIZABLE", "REPEATABLE_READ", "READ_COMMITTED", "READ_UNCOMMITTED" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-locks-available" => { "type" => INT, "description" => "The number of locks available to this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "number-of-locks-held" => { "type" => INT, "description" => "The number of locks currently in use by this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "striping" => { "type" => BOOLEAN, "description" => "If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "backups" => { "description" => "The remote backups for this cache.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"backup" => { "description" => "A remote backup.", "model-description" => {"*" => { "description" => "A backup site to which to replicate this cache.", "attributes" => { "after-failures" => { "type" => INT, "description" => "Indicates the number of failures after which this backup site should go offline.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "Indicates whether or not this backup site is enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "failure-policy" => { "type" => STRING, "description" => "The policy to follow when connectivity to the backup site fails.", "expressions-allowed" => true, "nillable" => true, "default" => "WARN", "allowed" => [ "IGNORE", "WARN", "FAIL", "CUSTOM" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-wait" => { "type" => LONG, "description" => "Indicates the minimum time (in milliseconds) to wait after the max number of failures is reached, after which this backup site should go offline.", "expressions-allowed" => true, "nillable" => true, "default" => 0L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "strategy" => { "type" => STRING, "description" => "The backup strategy for this cache", "expressions-allowed" => true, "nillable" => true, "default" => "ASYNC", "allowed" => [ "SYNC", "ASYNC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timeout" => { "type" => LONG, "description" => "The timeout for replicating to the backup site.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "transaction" => { "description" => "The cache transaction configuration.", "attributes" => { "commits" => { "type" => LONG, "description" => "The number of transaction commits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "locking" => { "type" => STRING, "description" => "The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.", "expressions-allowed" => true, "nillable" => true, "default" => "PESSIMISTIC", "allowed" => [ "OPTIMISTIC", "PESSIMISTIC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "mode" => { "type" => STRING, "description" => "Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "BATCH", "NON_XA", "NON_DURABLE_XA", "FULL_XA" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "prepares" => { "type" => LONG, "description" => "The number of transaction prepares. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "rollbacks" => { "type" => LONG, "description" => "The number of transaction rollbacks. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "stop-timeout" => { "type" => LONG, "description" => "If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "backup-for" => { "description" => "A cache for which this cache acts as a backup (for use with cross site replication).", "attributes" => { "remote-cache" => { "type" => STRING, "description" => "The name of the remote cache for which this cache acts as a backup.", "expressions-allowed" => true, "nillable" => true, "default" => "___defaultcache", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remote-site" => { "type" => STRING, "description" => "The site of the remote cache for which this cache acts as a backup.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "partition-handling" => { "description" => "The partition handling configuration for distributed and replicated caches.", "attributes" => { "availability" => { "type" => STRING, "description" => "Indicates the current availability of the cache.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "If enabled, the cache will enter degraded mode upon detecting a network partition that threatens the integrity of the cache.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "store" => { "description" => "A persistent store for a cache.", "model-description" => { "custom" => { "description" => "The cache store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "class" => { "type" => STRING, "description" => "The custom store implementation class to use for this cache store.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "binary-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "mixed-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => { "binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "remote" => { "description" => "The cache remote store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.remote.outbound-socket-binding", "dynamic" => true }], "attributes" => { "cache" => { "type" => STRING, "description" => "The name of the remote cache to use for this remote store.", "expressions-allowed" => true, "nillable" => true, "default" => "___defaultcache", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remote-servers" => { "type" => LIST, "description" => "A list of remote servers for this cache store.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-timeout" => { "type" => LONG, "description" => "A socket timeout for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "tcp-no-delay" => { "type" => BOOLEAN, "description" => "A TCP_NODELAY value for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "string-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "file" => { "description" => "The cache file store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "path" => { "type" => STRING, "description" => "The system path under which this cache store will persist its entries.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The system path to which the specified path is relative.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "none" => { "description" => "A store-less configuration.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} } } } } }} }, "invalidation-cache" => { "description" => "An invalidation cache child of the cache container.", "model-description" => {"*" => { "description" => "An invalidation cache", "capabilities" => [ { "name" => "org.wildfly.clustering.cache.service-provider-registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.singleton-service-builder-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache-configuration", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-entry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-factory", "dynamic" => true } ], "attributes" => { "activations" => { "type" => LONG, "description" => "The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "async-marshalling" => { "type" => BOOLEAN, "description" => "If enabled, this will cause marshalling of entries to be performed asynchronously.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Asynchronous marshalling is no longer supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "average-read-time" => { "type" => LONG, "description" => "Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-replication-time" => { "type" => LONG, "description" => "The average time taken to replicate data around the cluster. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-write-time" => { "type" => LONG, "description" => "Average time (in ms) for cache writes. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "batching" => { "type" => BOOLEAN, "description" => "If enabled, the invocation batching API will be made available for this cache.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Replaced by BATCH transaction mode." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-status" => { "type" => STRING, "description" => "The status of the cache component. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "elapsed-time" => { "type" => LONG, "description" => "Time (in secs) since cache started. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hit-ratio" => { "type" => DOUBLE, "description" => "The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hits" => { "type" => LONG, "description" => "The number of cache attribute hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "indexing" => { "type" => STRING, "description" => "If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "LOCAL", "ALL" ], "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "indexing-properties" => { "type" => OBJECT, "description" => "Properties to control indexing behaviour", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "invalidations" => { "type" => LONG, "description" => "The number of cache invalidations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "The jndi-name to which to bind this cache instance.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "misses" => { "type" => LONG, "description" => "The number of cache attribute misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "mode" => { "type" => STRING, "description" => "Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "SYNC", "ASYNC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module whose class loader should be used when building this cache's configuration.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-entries" => { "type" => INT, "description" => "The current number of entries in the cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "passivations" => { "type" => LONG, "description" => "The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "queue-flush-interval" => { "type" => LONG, "description" => "In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.", "expressions-allowed" => true, "nillable" => true, "default" => 10L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. This attribute will be ignored." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-size" => { "type" => INT, "description" => "In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. This attribute will be ignored." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-write-ratio" => { "type" => DOUBLE, "description" => "The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remote-timeout" => { "type" => 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, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remove-hits" => { "type" => LONG, "description" => "The number of cache attribute remove hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remove-misses" => { "type" => LONG, "description" => "The number of cache attribute remove misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "replication-count" => { "type" => LONG, "description" => "The number of times data was replicated around the cluster. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "replication-failures" => { "type" => LONG, "description" => "The number of data replication failures. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "start" => { "type" => STRING, "description" => "The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).", "expressions-allowed" => true, "nillable" => true, "default" => "LAZY", "allowed" => ["LAZY"], "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Only LAZY mode is supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "If enabled, statistics will be collected for this cache", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stores" => { "type" => LONG, "description" => "The number of cache attribute put operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "success-ratio" => { "type" => DOUBLE, "description" => "The data replication success ratio (successes/successes+failures). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "time-since-reset" => { "type" => LONG, "description" => "Time (in secs) since cache statistics were reset. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "component" => { "description" => "A configuration component of a cache.", "model-description" => { "expiration" => { "description" => "The cache expiration configuration.", "attributes" => { "interval" => { "type" => LONG, "description" => "Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "lifespan" => { "type" => LONG, "description" => "Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-idle" => { "type" => LONG, "description" => "Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "eviction" => { "description" => "The cache eviction configuration.", "attributes" => { "evictions" => { "type" => LONG, "description" => "The number of cache eviction operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "max-entries" => { "type" => LONG, "description" => "Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "strategy" => { "type" => STRING, "description" => "Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "UNORDERED", "FIFO", "LRU", "LIRS" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "locking" => { "description" => "The locking configuration of the cache.", "attributes" => { "acquire-timeout" => { "type" => LONG, "description" => "Maximum time to attempt a particular lock acquisition.", "expressions-allowed" => true, "nillable" => true, "default" => 15000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "concurrency-level" => { "type" => INT, "description" => "Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "current-concurrency-level" => { "type" => INT, "description" => "The estimated number of concurrently updating threads which this cache can support. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "isolation" => { "type" => STRING, "description" => "Sets the cache locking isolation level.", "expressions-allowed" => true, "nillable" => true, "default" => "READ_COMMITTED", "allowed" => [ "NONE", "SERIALIZABLE", "REPEATABLE_READ", "READ_COMMITTED", "READ_UNCOMMITTED" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-locks-available" => { "type" => INT, "description" => "The number of locks available to this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "number-of-locks-held" => { "type" => INT, "description" => "The number of locks currently in use by this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "striping" => { "type" => BOOLEAN, "description" => "If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "transaction" => { "description" => "The cache transaction configuration.", "attributes" => { "commits" => { "type" => LONG, "description" => "The number of transaction commits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "locking" => { "type" => STRING, "description" => "The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.", "expressions-allowed" => true, "nillable" => true, "default" => "PESSIMISTIC", "allowed" => [ "OPTIMISTIC", "PESSIMISTIC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "mode" => { "type" => STRING, "description" => "Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "BATCH", "NON_XA", "NON_DURABLE_XA", "FULL_XA" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "prepares" => { "type" => LONG, "description" => "The number of transaction prepares. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "rollbacks" => { "type" => LONG, "description" => "The number of transaction rollbacks. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "stop-timeout" => { "type" => LONG, "description" => "If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "store" => { "description" => "A persistent store for a cache.", "model-description" => { "remote" => { "description" => "The cache remote store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.remote.outbound-socket-binding", "dynamic" => true }], "attributes" => { "cache" => { "type" => STRING, "description" => "The name of the remote cache to use for this remote store.", "expressions-allowed" => true, "nillable" => true, "default" => "___defaultcache", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remote-servers" => { "type" => LIST, "description" => "A list of remote servers for this cache store.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-timeout" => { "type" => LONG, "description" => "A socket timeout for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "tcp-no-delay" => { "type" => BOOLEAN, "description" => "A TCP_NODELAY value for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "custom" => { "description" => "The cache store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "class" => { "type" => STRING, "description" => "The custom store implementation class to use for this cache store.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "string-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "file" => { "description" => "The cache file store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "path" => { "type" => STRING, "description" => "The system path under which this cache store will persist its entries.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The system path to which the specified path is relative.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "none" => { "description" => "A store-less configuration.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "binary-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "mixed-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => { "binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } } } } } }} }, "replicated-cache" => { "description" => "A replicated cache child of the cache container.", "model-description" => {"*" => { "description" => "A replicated cache configuration", "capabilities" => [ { "name" => "org.wildfly.clustering.cache.service-provider-registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.singleton-service-builder-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache-configuration", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-entry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-factory", "dynamic" => true } ], "attributes" => { "activations" => { "type" => LONG, "description" => "The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "async-marshalling" => { "type" => BOOLEAN, "description" => "If enabled, this will cause marshalling of entries to be performed asynchronously.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Asynchronous marshalling is no longer supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "average-read-time" => { "type" => LONG, "description" => "Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-replication-time" => { "type" => LONG, "description" => "The average time taken to replicate data around the cluster. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-write-time" => { "type" => LONG, "description" => "Average time (in ms) for cache writes. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "batching" => { "type" => BOOLEAN, "description" => "If enabled, the invocation batching API will be made available for this cache.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Replaced by BATCH transaction mode." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-status" => { "type" => STRING, "description" => "The status of the cache component. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "elapsed-time" => { "type" => LONG, "description" => "Time (in secs) since cache started. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hit-ratio" => { "type" => DOUBLE, "description" => "The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hits" => { "type" => LONG, "description" => "The number of cache attribute hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "indexing" => { "type" => STRING, "description" => "If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "LOCAL", "ALL" ], "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "indexing-properties" => { "type" => OBJECT, "description" => "Properties to control indexing behaviour", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "invalidations" => { "type" => LONG, "description" => "The number of cache invalidations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "The jndi-name to which to bind this cache instance.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "misses" => { "type" => LONG, "description" => "The number of cache attribute misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "mode" => { "type" => STRING, "description" => "Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "SYNC", "ASYNC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module whose class loader should be used when building this cache's configuration.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-entries" => { "type" => INT, "description" => "The current number of entries in the cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "passivations" => { "type" => LONG, "description" => "The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "queue-flush-interval" => { "type" => LONG, "description" => "In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.", "expressions-allowed" => true, "nillable" => true, "default" => 10L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. This attribute will be ignored." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-size" => { "type" => INT, "description" => "In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. This attribute will be ignored." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-write-ratio" => { "type" => DOUBLE, "description" => "The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remote-timeout" => { "type" => 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, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remove-hits" => { "type" => LONG, "description" => "The number of cache attribute remove hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remove-misses" => { "type" => LONG, "description" => "The number of cache attribute remove misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "replication-count" => { "type" => LONG, "description" => "The number of times data was replicated around the cluster. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "replication-failures" => { "type" => LONG, "description" => "The number of data replication failures. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "start" => { "type" => STRING, "description" => "The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).", "expressions-allowed" => true, "nillable" => true, "default" => "LAZY", "allowed" => ["LAZY"], "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Only LAZY mode is supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "If enabled, statistics will be collected for this cache", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stores" => { "type" => LONG, "description" => "The number of cache attribute put operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "success-ratio" => { "type" => DOUBLE, "description" => "The data replication success ratio (successes/successes+failures). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "time-since-reset" => { "type" => LONG, "description" => "Time (in secs) since cache statistics were reset. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "component" => { "description" => "A configuration component of a cache.", "model-description" => { "expiration" => { "description" => "The cache expiration configuration.", "attributes" => { "interval" => { "type" => LONG, "description" => "Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "lifespan" => { "type" => LONG, "description" => "Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-idle" => { "type" => LONG, "description" => "Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "state-transfer" => { "description" => "The state transfer configuration for distributed and replicated caches.", "attributes" => { "chunk-size" => { "type" => INT, "description" => "The size, in bytes, in which to batch the transfer of cache entries.", "expressions-allowed" => true, "nillable" => true, "default" => 512, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Always enabled for replicated and distributed caches." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timeout" => { "type" => LONG, "description" => "The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.", "expressions-allowed" => true, "nillable" => true, "default" => 240000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "eviction" => { "description" => "The cache eviction configuration.", "attributes" => { "evictions" => { "type" => LONG, "description" => "The number of cache eviction operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "max-entries" => { "type" => LONG, "description" => "Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "strategy" => { "type" => STRING, "description" => "Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "UNORDERED", "FIFO", "LRU", "LIRS" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "locking" => { "description" => "The locking configuration of the cache.", "attributes" => { "acquire-timeout" => { "type" => LONG, "description" => "Maximum time to attempt a particular lock acquisition.", "expressions-allowed" => true, "nillable" => true, "default" => 15000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "concurrency-level" => { "type" => INT, "description" => "Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "current-concurrency-level" => { "type" => INT, "description" => "The estimated number of concurrently updating threads which this cache can support. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "isolation" => { "type" => STRING, "description" => "Sets the cache locking isolation level.", "expressions-allowed" => true, "nillable" => true, "default" => "READ_COMMITTED", "allowed" => [ "NONE", "SERIALIZABLE", "REPEATABLE_READ", "READ_COMMITTED", "READ_UNCOMMITTED" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-locks-available" => { "type" => INT, "description" => "The number of locks available to this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "number-of-locks-held" => { "type" => INT, "description" => "The number of locks currently in use by this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "striping" => { "type" => BOOLEAN, "description" => "If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "backups" => { "description" => "The remote backups for this cache.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"backup" => { "description" => "A remote backup.", "model-description" => {"*" => { "description" => "A backup site to which to replicate this cache.", "attributes" => { "after-failures" => { "type" => INT, "description" => "Indicates the number of failures after which this backup site should go offline.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "Indicates whether or not this backup site is enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "failure-policy" => { "type" => STRING, "description" => "The policy to follow when connectivity to the backup site fails.", "expressions-allowed" => true, "nillable" => true, "default" => "WARN", "allowed" => [ "IGNORE", "WARN", "FAIL", "CUSTOM" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-wait" => { "type" => LONG, "description" => "Indicates the minimum time (in milliseconds) to wait after the max number of failures is reached, after which this backup site should go offline.", "expressions-allowed" => true, "nillable" => true, "default" => 0L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "strategy" => { "type" => STRING, "description" => "The backup strategy for this cache", "expressions-allowed" => true, "nillable" => true, "default" => "ASYNC", "allowed" => [ "SYNC", "ASYNC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timeout" => { "type" => LONG, "description" => "The timeout for replicating to the backup site.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "transaction" => { "description" => "The cache transaction configuration.", "attributes" => { "commits" => { "type" => LONG, "description" => "The number of transaction commits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "locking" => { "type" => STRING, "description" => "The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.", "expressions-allowed" => true, "nillable" => true, "default" => "PESSIMISTIC", "allowed" => [ "OPTIMISTIC", "PESSIMISTIC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "mode" => { "type" => STRING, "description" => "Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "BATCH", "NON_XA", "NON_DURABLE_XA", "FULL_XA" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "prepares" => { "type" => LONG, "description" => "The number of transaction prepares. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "rollbacks" => { "type" => LONG, "description" => "The number of transaction rollbacks. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "stop-timeout" => { "type" => LONG, "description" => "If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "backup-for" => { "description" => "A cache for which this cache acts as a backup (for use with cross site replication).", "attributes" => { "remote-cache" => { "type" => STRING, "description" => "The name of the remote cache for which this cache acts as a backup.", "expressions-allowed" => true, "nillable" => true, "default" => "___defaultcache", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remote-site" => { "type" => STRING, "description" => "The site of the remote cache for which this cache acts as a backup.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "partition-handling" => { "description" => "The partition handling configuration for distributed and replicated caches.", "attributes" => { "availability" => { "type" => STRING, "description" => "Indicates the current availability of the cache.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "If enabled, the cache will enter degraded mode upon detecting a network partition that threatens the integrity of the cache.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "store" => { "description" => "A persistent store for a cache.", "model-description" => { "custom" => { "description" => "The cache store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "class" => { "type" => STRING, "description" => "The custom store implementation class to use for this cache store.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "binary-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "mixed-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => { "binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "remote" => { "description" => "The cache remote store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.remote.outbound-socket-binding", "dynamic" => true }], "attributes" => { "cache" => { "type" => STRING, "description" => "The name of the remote cache to use for this remote store.", "expressions-allowed" => true, "nillable" => true, "default" => "___defaultcache", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remote-servers" => { "type" => LIST, "description" => "A list of remote servers for this cache store.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-timeout" => { "type" => LONG, "description" => "A socket timeout for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "tcp-no-delay" => { "type" => BOOLEAN, "description" => "A TCP_NODELAY value for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "string-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "file" => { "description" => "The cache file store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "path" => { "type" => STRING, "description" => "The system path under which this cache store will persist its entries.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The system path to which the specified path is relative.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "none" => { "description" => "A store-less configuration.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} } } } } }} }, "local-cache" => { "description" => "A local cache child of the cache container.", "model-description" => {"*" => { "description" => "A local cache configuration", "capabilities" => [ { "name" => "org.wildfly.clustering.cache.service-provider-registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.singleton-service-builder-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache-configuration", "dynamic" => true }, { "name" => "org.wildfly.clustering.infinispan.cache", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-entry", "dynamic" => true }, { "name" => "org.wildfly.clustering.cache.registry-factory", "dynamic" => true } ], "attributes" => { "activations" => { "type" => LONG, "description" => "The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-read-time" => { "type" => LONG, "description" => "Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "average-write-time" => { "type" => LONG, "description" => "Average time (in ms) for cache writes. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "batching" => { "type" => BOOLEAN, "description" => "If enabled, the invocation batching API will be made available for this cache.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Replaced by BATCH transaction mode." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-status" => { "type" => STRING, "description" => "The status of the cache component. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "elapsed-time" => { "type" => LONG, "description" => "Time (in secs) since cache started. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hit-ratio" => { "type" => DOUBLE, "description" => "The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "hits" => { "type" => LONG, "description" => "The number of cache attribute hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "indexing" => { "type" => STRING, "description" => "If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "LOCAL", "ALL" ], "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "indexing-properties" => { "type" => OBJECT, "description" => "Properties to control indexing behaviour", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Has no effect." }, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "invalidations" => { "type" => LONG, "description" => "The number of cache invalidations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "The jndi-name to which to bind this cache instance.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "misses" => { "type" => LONG, "description" => "The number of cache attribute misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module whose class loader should be used when building this cache's configuration.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-entries" => { "type" => INT, "description" => "The current number of entries in the cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "passivations" => { "type" => LONG, "description" => "The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "read-write-ratio" => { "type" => DOUBLE, "description" => "The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remove-hits" => { "type" => LONG, "description" => "The number of cache attribute remove hits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "remove-misses" => { "type" => LONG, "description" => "The number of cache attribute remove misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "start" => { "type" => STRING, "description" => "The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).", "expressions-allowed" => true, "nillable" => true, "default" => "LAZY", "allowed" => ["LAZY"], "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Only LAZY mode is supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "If enabled, statistics will be collected for this cache", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stores" => { "type" => LONG, "description" => "The number of cache attribute put operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "time-since-reset" => { "type" => LONG, "description" => "Time (in secs) since cache statistics were reset. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "component" => { "description" => "A configuration component of a cache.", "model-description" => { "expiration" => { "description" => "The cache expiration configuration.", "attributes" => { "interval" => { "type" => LONG, "description" => "Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "lifespan" => { "type" => LONG, "description" => "Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-idle" => { "type" => LONG, "description" => "Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "eviction" => { "description" => "The cache eviction configuration.", "attributes" => { "evictions" => { "type" => LONG, "description" => "The number of cache eviction operations. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "max-entries" => { "type" => LONG, "description" => "Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "strategy" => { "type" => STRING, "description" => "Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "UNORDERED", "FIFO", "LRU", "LIRS" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "locking" => { "description" => "The locking configuration of the cache.", "attributes" => { "acquire-timeout" => { "type" => LONG, "description" => "Maximum time to attempt a particular lock acquisition.", "expressions-allowed" => true, "nillable" => true, "default" => 15000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "concurrency-level" => { "type" => INT, "description" => "Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "current-concurrency-level" => { "type" => INT, "description" => "The estimated number of concurrently updating threads which this cache can support. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "isolation" => { "type" => STRING, "description" => "Sets the cache locking isolation level.", "expressions-allowed" => true, "nillable" => true, "default" => "READ_COMMITTED", "allowed" => [ "NONE", "SERIALIZABLE", "REPEATABLE_READ", "READ_COMMITTED", "READ_UNCOMMITTED" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "number-of-locks-available" => { "type" => INT, "description" => "The number of locks available to this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "number-of-locks-held" => { "type" => INT, "description" => "The number of locks currently in use by this cache. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "striping" => { "type" => BOOLEAN, "description" => "If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "transaction" => { "description" => "The cache transaction configuration.", "attributes" => { "commits" => { "type" => LONG, "description" => "The number of transaction commits. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "locking" => { "type" => STRING, "description" => "The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.", "expressions-allowed" => true, "nillable" => true, "default" => "PESSIMISTIC", "allowed" => [ "OPTIMISTIC", "PESSIMISTIC" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "mode" => { "type" => STRING, "description" => "Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.", "expressions-allowed" => true, "nillable" => true, "default" => "NONE", "allowed" => [ "NONE", "BATCH", "NON_XA", "NON_DURABLE_XA", "FULL_XA" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "prepares" => { "type" => LONG, "description" => "The number of transaction prepares. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "rollbacks" => { "type" => LONG, "description" => "The number of transaction rollbacks. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "stop-timeout" => { "type" => LONG, "description" => "If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.", "expressions-allowed" => true, "nillable" => true, "default" => 10000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "store" => { "description" => "A persistent store for a cache.", "model-description" => { "remote" => { "description" => "The cache remote store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.remote.outbound-socket-binding", "dynamic" => true }], "attributes" => { "cache" => { "type" => STRING, "description" => "The name of the remote cache to use for this remote store.", "expressions-allowed" => true, "nillable" => true, "default" => "___defaultcache", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "remote-servers" => { "type" => LIST, "description" => "A list of remote servers for this cache store.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-timeout" => { "type" => LONG, "description" => "A socket timeout for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "tcp-no-delay" => { "type" => BOOLEAN, "description" => "A TCP_NODELAY value for remote cache communication.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "custom" => { "description" => "The cache store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "class" => { "type" => STRING, "description" => "The custom store implementation class to use for this cache store.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "string-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "file" => { "description" => "The cache file store configuration.", "attributes" => { "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "path" => { "type" => STRING, "description" => "The system path under which this cache store will persist its entries.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The system path to which the specified path is relative.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "none" => { "description" => "A store-less configuration.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "binary-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => {"binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "mixed-jdbc" => { "description" => "The cache JDBC store configuration.", "capabilities" => [{ "name" => "org.wildfly.clustering.infinispan.cache-container.cache.store.jdbc.data-source", "dynamic" => true }], "attributes" => { "binary-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=binary child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-loader-loads" => { "type" => LONG, "description" => "The number of cache loader node loads. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "cache-loader-misses" => { "type" => LONG, "description" => "The number of cache loader node misses. May return null if the cache is not started.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "data-source" => { "type" => STRING, "description" => "References the data source used to connect to this store.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "dialect" => { "type" => STRING, "description" => "The dialect of this datastore.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "MYSQL", "POSTGRES", "DERBY", "HSQL", "H2", "SQLITE", "DB2", "DB2_390", "INFORMIX", "INTERBASE", "FIREBIRD", "SQL_SERVER", "ACCESS", "ORACLE", "SYBASE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "fetch-state" => { "type" => BOOLEAN, "description" => "If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "passivation" => { "type" => BOOLEAN, "description" => "If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "preload" => { "type" => BOOLEAN, "description" => "If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "A list of cache store properties.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "purge" => { "type" => BOOLEAN, "description" => "If true, purges this cache store when it starts up.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "singleton" => { "type" => BOOLEAN, "description" => "If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "string-keyed-table" => { "type" => OBJECT, "description" => "Defines a table used to store persistent cache entries.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Use table=string child resource." }, "value-type" => { "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L }, "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100 }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } } }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } } }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "write" => { "description" => "The write behavior of the cache store.", "model-description" => { "through" => { "description" => "Configures a cache store as write-through.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "behind" => { "description" => "Configures a cache store as write-behind instead of write-through.", "attributes" => { "flush-lock-timeout" => { "type" => LONG, "description" => "Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "modification-queue-size" => { "type" => INT, "description" => "Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shutdown-timeout" => { "type" => LONG, "description" => "Timeout in milliseconds to stop the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 25000L, "unit" => "MILLISECONDS", "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. This attribute is no longer used." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-pool-size" => { "type" => INT, "description" => "Size of the thread pool whose threads are responsible for applying the modifications to the cache store.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "table" => { "description" => "Defines a table used to store persistent cache data.", "model-description" => { "binary" => { "description" => "Defines a table used to store cache entries whose keys cannot be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_bucket", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "string" => { "description" => "Defines a table used to store cache entries whose keys can be expressed as strings.", "attributes" => { "batch-size" => { "type" => INT, "description" => "For DB inserts, the batch size determines how many inserts are batched together.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "data-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry data.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "datum", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BINARY", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "fetch-size" => { "type" => INT, "description" => "For DB queries, the fetch size will be used to set the fetch size on ResultSets.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "id-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry ids.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "id", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "VARCHAR", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "The prefix for the database table name.", "expressions-allowed" => true, "nillable" => true, "default" => "ispn_entry", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "timestamp-column" => { "type" => OBJECT, "description" => "A database column to hold cache entry timestamps.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "version", "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "The type of the database column.", "expressions-allowed" => true, "nillable" => true, "default" => "BIGINT", "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A cache store property with name and value.", "model-description" => {"*" => { "description" => "A cache store property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use \"properties\" attribute of the appropriate cache store resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the cache store property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } } } } } }} } } }} }} }, "jca" => { "description" => "The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "bean-validation" => { "description" => "Bean validation (JSR-303) for resource adapters", "model-description" => {"bean-validation" => { "description" => "Bean validation (JSR-303) for resource adapters", "attributes" => {"enabled" => { "type" => BOOLEAN, "description" => "Specify whether bean validation is enabled", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "cached-connection-manager" => { "description" => "Cached connection manager for resource adapters", "model-description" => {"cached-connection-manager" => { "description" => "Cached connection manager for resource adapters", "attributes" => { "debug" => { "type" => BOOLEAN, "description" => "Enable/disable debug information logging", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error" => { "type" => BOOLEAN, "description" => "Enable/disable error information logging", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ignore-unknown-connections" => { "type" => BOOLEAN, "description" => "Do not cache unknown connections", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "install" => { "type" => BOOLEAN, "description" => "Enable/disable the cached connection manager valve and interceptor", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "workmanager" => { "description" => "WorkManager for resource adapters", "model-description" => {"*" => { "description" => "WorkManager for resource adapters", "attributes" => {"name" => { "type" => STRING, "description" => "The name of the WorkManager", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }}, "operations" => undefined, "notifications" => undefined, "children" => { "short-running-threads" => { "description" => "boolean indicating if service for short running activated", "model-description" => {"*" => { "description" => "A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.", "attributes" => { "allow-core-timeout" => { "type" => BOOLEAN, "description" => "Whether core threads may time out.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "core-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "current-thread-count" => { "type" => INT, "description" => "The current number of threads in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "handoff-executor" => { "type" => STRING, "description" => "An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "keepalive-time" => { "type" => OBJECT, "description" => "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "time" => { "type" => LONG, "description" => "The time", "expressions-allowed" => true, "nillable" => false }, "unit" => { "type" => STRING, "description" => "The time unit", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "largest-thread-count" => { "type" => INT, "description" => "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the thread pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-size" => { "type" => INT, "description" => "The queue size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-count" => { "type" => INT, "description" => "The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-factory" => { "type" => STRING, "description" => "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "long-running-threads" => { "description" => "boolean indicating if service for long running activated", "model-description" => {"*" => { "description" => "A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.", "attributes" => { "allow-core-timeout" => { "type" => BOOLEAN, "description" => "Whether core threads may time out.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "core-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "current-thread-count" => { "type" => INT, "description" => "The current number of threads in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "handoff-executor" => { "type" => STRING, "description" => "An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "keepalive-time" => { "type" => OBJECT, "description" => "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "time" => { "type" => LONG, "description" => "The time", "expressions-allowed" => true, "nillable" => false }, "unit" => { "type" => STRING, "description" => "The time unit", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "largest-thread-count" => { "type" => INT, "description" => "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the thread pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-size" => { "type" => INT, "description" => "The queue size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-count" => { "type" => INT, "description" => "The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-factory" => { "type" => STRING, "description" => "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "archive-validation" => { "description" => "Archive validation for resource adapters", "model-description" => {"archive-validation" => { "description" => "Archive validation for resource adapters", "attributes" => { "enabled" => { "type" => BOOLEAN, "description" => "Specify whether archive validation is enabled", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "fail-on-error" => { "type" => BOOLEAN, "description" => "Should an archive validation error report fail the deployment", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "fail-on-warn" => { "type" => BOOLEAN, "description" => "Should an archive validation warning report fail the deployment", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "bootstrap-context" => { "description" => "Bootstrap context for resource adapters", "model-description" => {"*" => { "description" => "Bootstrap context for resource adapters", "attributes" => { "name" => { "type" => STRING, "description" => "The name of the BootstrapContext", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "workmanager" => { "type" => STRING, "description" => "The WorkManager instance for the BootstrapContext", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "tracer" => { "description" => "Tracer for resource adapters", "model-description" => {"tracer" => { "description" => "Tracer for resource adapters", "attributes" => {"enabled" => { "type" => BOOLEAN, "description" => "Specify whether tracer is enabled", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "distributed-workmanager" => { "description" => "DistributedWorkManager for resource adapters", "model-description" => {"*" => { "description" => "DistributedWorkManager for resource adapters", "capabilities" => [{ "name" => "org.wildfly.connector.workmanager", "dynamic" => false }], "attributes" => { "name" => { "type" => STRING, "description" => "The name of the DistributedWorkManager", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "policy" => { "type" => STRING, "description" => "The policy decides when to redistribute a Work instance", "expressions-allowed" => true, "nillable" => true, "default" => "WATERMARK", "allowed" => [ "NEVER", "ALWAYS", "WATERMARK" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "policy-options" => { "type" => OBJECT, "description" => "List of policy's options key/value pairs", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "selector" => { "type" => STRING, "description" => "The selector decides to which nodes in the network to redistribute the Work instance to", "expressions-allowed" => true, "nillable" => true, "default" => "PING_TIME", "allowed" => [ "FIRST_AVAILABLE", "PING_TIME", "MAX_FREE_THREADS" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "selector-options" => { "type" => OBJECT, "description" => "List of selector's options key/value pairs", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "short-running-threads" => { "description" => "boolean indicating if service for short running activated", "model-description" => {"*" => { "description" => "A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.", "attributes" => { "allow-core-timeout" => { "type" => BOOLEAN, "description" => "Whether core threads may time out.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "core-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "current-thread-count" => { "type" => INT, "description" => "The current number of threads in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "handoff-executor" => { "type" => STRING, "description" => "An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "keepalive-time" => { "type" => OBJECT, "description" => "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "time" => { "type" => LONG, "description" => "The time", "expressions-allowed" => true, "nillable" => false }, "unit" => { "type" => STRING, "description" => "The time unit", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "largest-thread-count" => { "type" => INT, "description" => "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the thread pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-size" => { "type" => INT, "description" => "The queue size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-count" => { "type" => INT, "description" => "The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-factory" => { "type" => STRING, "description" => "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "long-running-threads" => { "description" => "boolean indicating if service for long running activated", "model-description" => {"*" => { "description" => "A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.", "attributes" => { "allow-core-timeout" => { "type" => BOOLEAN, "description" => "Whether core threads may time out.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "core-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "current-thread-count" => { "type" => INT, "description" => "The current number of threads in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "handoff-executor" => { "type" => STRING, "description" => "An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "keepalive-time" => { "type" => OBJECT, "description" => "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "time" => { "type" => LONG, "description" => "The time", "expressions-allowed" => true, "nillable" => false }, "unit" => { "type" => STRING, "description" => "The time unit", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "largest-thread-count" => { "type" => INT, "description" => "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the thread pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-size" => { "type" => INT, "description" => "The queue size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-count" => { "type" => INT, "description" => "The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-factory" => { "type" => STRING, "description" => "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} } } }, "request-controller" => { "description" => "The request controller subsystem. Used for request limiting and graceful shutdown", "capabilities" => [{ "name" => "org.wildfly.request-controller", "dynamic" => false }], "attributes" => { "active-requests" => { "type" => INT, "description" => "The number of requests that are currently running in the server", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "max-requests" => { "type" => INT, "description" => "The maximum number of all types of requests that can be running in a server at a time", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "track-individual-endpoints" => { "type" => BOOLEAN, "description" => "If this is true requests are tracked at an endpoint level, which will allow individual deployments to be suspended", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "undertow" => { "description" => "Undertow subsystem", "attributes" => { "default-security-domain" => { "type" => STRING, "description" => "The default security domain used by web deployments", "expressions-allowed" => true, "nillable" => true, "default" => "other", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"security-domain-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-server" => { "type" => STRING, "description" => "The default server to use for deployments", "expressions-allowed" => false, "nillable" => true, "default" => "default-server", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-servlet-container" => { "type" => STRING, "description" => "The default servlet container to use for deployments", "expressions-allowed" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-virtual-host" => { "type" => STRING, "description" => "The default virtual host to use for deployments", "expressions-allowed" => false, "nillable" => true, "default" => "default-host", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "instance-id" => { "type" => STRING, "description" => "The cluster instance id", "expressions-allowed" => true, "nillable" => true, "default" => expression "${jboss.node.name}", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Configures if statistics are enabled", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "servlet-container" => { "description" => "A servlet container", "model-description" => {"*" => { "description" => "A servlet container", "attributes" => { "allow-non-standard-wrappers" => { "type" => BOOLEAN, "description" => "If true then request and response wrappers that do not extend the standard wrapper classes can be used", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-buffer-cache" => { "type" => STRING, "description" => "The buffer cache to use for caching static resources", "expressions-allowed" => true, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-encoding" => { "type" => STRING, "description" => "Default encoding to use for all deployed applications", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-session-timeout" => { "type" => INT, "description" => "The default session timeout (in minutes) for all applications deployed in the container.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "unit" => "MINUTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "directory-listing" => { "type" => BOOLEAN, "description" => "If directory listing should be enabled for default servlets.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disable-caching-for-secured-pages" => { "type" => BOOLEAN, "description" => "If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disable-file-watch-service" => { "type" => BOOLEAN, "description" => "If this is true then the file watch service will not be used to monitor exploded deployments for changes", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "eager-filter-initialization" => { "type" => BOOLEAN, "description" => "If true undertow calls filter init() on deployment start rather than when first requested.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ignore-flush" => { "type" => BOOLEAN, "description" => "Ignore flushes on the servlet output stream. In most cases these just hurt performance for no good reason.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-sessions" => { "type" => INT, "description" => "The maximum number of sessions that can be active at one time", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "proactive-authentication" => { "type" => BOOLEAN, "description" => "If proactive authentication should be used. If this is true a user will always be authenticated if credentials are present.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "session-id-length" => { "type" => INT, "description" => "The length of the generated session ID. Longer session ID's are more secure.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "min" => 16L, "max" => 200L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "stack-trace-on-error" => { "type" => STRING, "description" => "If an error page with the stack trace should be generated on error. Values are all, none and local-only", "expressions-allowed" => true, "nillable" => true, "default" => "local-only", "allowed" => [ "none", "local-only", "all" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-listener-encoding" => { "type" => BOOLEAN, "description" => "Use encoding defined on listener", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "welcome-file" => { "description" => "A welcome file", "model-description" => {"*" => { "description" => "The welcome file", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "setting" => { "description" => "The servlet container settings", "model-description" => { "crawler-session-management" => { "description" => "Configures special session handing for crawler bots", "attributes" => { "session-timeout" => { "type" => INT, "description" => "The session timeout for sessions that are owned by crawlers", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "user-agents" => { "type" => STRING, "description" => "Regular expression that is used to match the user agenet of a crawler", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "jsp" => { "description" => "JSP container configuration.", "attributes" => { "check-interval" => { "type" => INT, "description" => "Check interval for JSP updates using a background thread.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "development" => { "type" => BOOLEAN, "description" => "Enable Development mode which enables reloading JSP on-the-fly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disabled" => { "type" => BOOLEAN, "description" => "Enable the JSP container.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "display-source-fragment" => { "type" => BOOLEAN, "description" => "When a runtime error occurs, attempts to display corresponding JSP source fragment", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "dump-smap" => { "type" => BOOLEAN, "description" => "Write SMAP data to a file.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-on-use-bean-invalid-class-attribute" => { "type" => BOOLEAN, "description" => "Enable errors when using a bad class in useBean.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "generate-strings-as-char-arrays" => { "type" => BOOLEAN, "description" => "Generate String constants as char arrays.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "java-encoding" => { "type" => STRING, "description" => "Specify the encoding used for Java sources.", "expressions-allowed" => true, "nillable" => true, "default" => "UTF8", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "keep-generated" => { "type" => BOOLEAN, "description" => "Keep the generated Servlets.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "mapped-file" => { "type" => BOOLEAN, "description" => "Map to the JSP source.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "modification-test-interval" => { "type" => INT, "description" => "Minimum amount of time between two tests for updates, in seconds.", "expressions-allowed" => true, "nillable" => true, "default" => 4, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "optimize-scriptlets" => { "type" => BOOLEAN, "description" => "If JSP scriptlets should be optimised to remove string concatenation", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "recompile-on-fail" => { "type" => BOOLEAN, "description" => "Retry failed JSP compilations on each request.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scratch-dir" => { "type" => STRING, "description" => "Specify a different work directory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "smap" => { "type" => BOOLEAN, "description" => "Enable SMAP.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "source-vm" => { "type" => STRING, "description" => "Source VM level for compilation.", "expressions-allowed" => true, "nillable" => true, "default" => "1.8", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tag-pooling" => { "type" => BOOLEAN, "description" => "Enable tag pooling.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "target-vm" => { "type" => STRING, "description" => "Target VM level for compilation.", "expressions-allowed" => true, "nillable" => true, "default" => "1.8", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "trim-spaces" => { "type" => BOOLEAN, "description" => "Trim some spaces from the generated Servlet.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "x-powered-by" => { "type" => BOOLEAN, "description" => "Enable advertising the JSP engine in x-powered-by.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "persistent-sessions" => { "description" => "Session persistence sessions", "attributes" => { "path" => { "type" => STRING, "description" => "The path to the persistent session data directory. If this is null sessions will be stored in memory", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The directory the path is relative to", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "session-cookie" => { "description" => "Session cookie configuration", "attributes" => { "comment" => { "type" => STRING, "description" => "Cookie comment", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "domain" => { "type" => STRING, "description" => "Cookie domain", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http-only" => { "type" => BOOLEAN, "description" => "Is cookie http-only", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-age" => { "type" => INT, "description" => "Max age of cookie", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "Is cookie secure?", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "websockets" => { "description" => "If websockets are enabled for this container", "attributes" => { "buffer-pool" => { "type" => STRING, "description" => "The buffer pool to use for websocket deployments", "expressions-allowed" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "deflater-level" => { "type" => INT, "description" => "Configures the level of compression of the DEFLATE algorithm", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => 0L, "max" => 9L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "dispatch-to-worker" => { "type" => BOOLEAN, "description" => "If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "per-message-deflate" => { "type" => BOOLEAN, "description" => "Enables websocket's per-message compression extension, RFC-7692", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "The worker to use for websocket deployments", "expressions-allowed" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "mime-mapping" => { "description" => "Servlet mime mapping config", "model-description" => {"*" => { "description" => "The servlet container mime mapping config", "attributes" => {"value" => { "type" => STRING, "description" => "The mime type for this mapping", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "configuration" => { "description" => "null", "model-description" => { "filter" => { "description" => "Undertow filters", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "error-page" => { "description" => "The error pages", "model-description" => {"*" => { "description" => "The error pages", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "code" => { "type" => INT, "description" => "Error page code", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "Error page path", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "expression-filter" => { "description" => "A filter parsed from the undertow expression language", "model-description" => {"*" => { "description" => "A filter parsed from the undertow expression language", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "expression" => { "type" => STRING, "description" => "The expression that defines the filter", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Module to use to load the filter definitions", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "gzip" => { "description" => "Defines gzip filter", "model-description" => {"*" => { "description" => "Defines gzip filter", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "mod-cluster" => { "description" => "A mod-cluster front end load balancer", "model-description" => {"*" => { "description" => "A mod-cluster front end load balancer", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "advertise-frequency" => { "type" => INT, "description" => "The frequency (in milliseconds) that mod-cluster advertises itself on the network", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "advertise-path" => { "type" => STRING, "description" => "The path that mod-cluster is registered under, defaults to /", "expressions-allowed" => true, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "advertise-protocol" => { "type" => STRING, "description" => "The protocol that is in use, defaults to HTTP", "expressions-allowed" => true, "nillable" => true, "default" => "http", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "advertise-socket-binding" => { "type" => STRING, "description" => "The multicast group that is used to advertise", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "broken-node-timeout" => { "type" => INT, "description" => "The amount of time that must elapse before a broken node is removed from the table", "expressions-allowed" => true, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cached-connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be kept alive indefinitely", "expressions-allowed" => true, "nillable" => true, "default" => 40, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-idle-timeout" => { "type" => INT, "description" => "The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)", "expressions-allowed" => true, "nillable" => true, "default" => 60, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be maintained to backend servers, per IO thread. Defaults to 10.", "expressions-allowed" => true, "nillable" => true, "default" => 40, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enable-http2" => { "type" => BOOLEAN, "description" => "If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "health-check-interval" => { "type" => INT, "description" => "The frequency of health check pings to backend nodes", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If push should be enabled for HTTP/2 connections", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "management-access-predicate" => { "type" => STRING, "description" => "A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "management-socket-binding" => { "type" => STRING, "description" => "The socket binding of the mod_cluster management port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-ajp-packet-size" => { "type" => INT, "description" => "The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-request-time" => { "type" => INT, "description" => "The max amount of time that a request to a backend node can take before it is killed", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "request-queue-size" => { "type" => INT, "description" => "The number of requests that can be queued if the connection pool is full before requests are rejected with a 503", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-key" => { "type" => STRING, "description" => "The security key that is used for the mod-cluster group. All members must use the same security key.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm that provides the SSL configuration", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "4.0.0", "reason" => "Use the ssl-context attribute to reference a configured SSLContext directly." }, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this filter.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-alias" => { "type" => BOOLEAN, "description" => "If an alias check is performed", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "The XNIO worker that is used to send the advertise notifications", "expressions-allowed" => true, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"balancer" => { "description" => "Runtime representation of a mod_cluster balancer", "model-description" => {"*" => { "description" => "Runtime representation of a mod_cluster balancer", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "max-attempts" => { "type" => INT, "description" => "The number of attempts to send the request to a backend server", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "sticky-session" => { "type" => BOOLEAN, "description" => "If sticky sessions are enabled", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-cookie" => { "type" => STRING, "description" => "The session cookie name", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-force" => { "type" => BOOLEAN, "description" => "If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-path" => { "type" => STRING, "description" => "The path of the sticky session cookie", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-remove" => { "type" => BOOLEAN, "description" => "Remove the session cookie if the request cannot be routed to the correct host", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "wait-worker" => { "type" => INT, "description" => "The number of seconds to wait for an available worker", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "node" => { "description" => "Runtime representation of a mod_cluster node", "model-description" => {"*" => { "description" => "Runtime representation of a mod_cluster node", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "aliases" => { "type" => LIST, "description" => "The nodes aliases", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "cache-connections" => { "type" => INT, "description" => "The number of connections to keep alive indefinitely", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "elected" => { "type" => INT, "description" => "The elected count", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "flush-packets" => { "type" => BOOLEAN, "description" => "If received data should be immediately flushed", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "load" => { "type" => INT, "description" => "The current load of this node", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "load-balancing-group" => { "type" => STRING, "description" => "The load balancing group this node belongs to", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "max-connections" => { "type" => INT, "description" => "The maximum number of connections per IO thread", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "open-connections" => { "type" => INT, "description" => "The current number of open connections", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "ping" => { "type" => INT, "description" => "The nodes ping", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "queue-new-requests" => { "type" => BOOLEAN, "description" => "If a request is received and there is no worker immediately available should it be queued", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "read" => { "type" => LONG, "description" => "The number of bytes read from the node", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "request-queue-size" => { "type" => INT, "description" => "The size of the request queue", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "status" => { "type" => STRING, "description" => "The current status of this node", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "timeout" => { "type" => INT, "description" => "The request timeout", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "ttl" => { "type" => LONG, "description" => "The time connections will stay alive with no requests before being closed, if the number of connections is larger than cache-connections", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "uri" => { "type" => STRING, "description" => "The URI that the load balancer uses to connect to the node", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "written" => { "type" => LONG, "description" => "The number of bytes transferred to the node", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"context" => { "description" => "Runtime representation of a mod_cluster context", "model-description" => {"*" => { "description" => "Runtime representation of a mod_cluster context", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "requests" => { "type" => INT, "description" => "The number of requests against this context", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "status" => { "type" => STRING, "description" => "The status of this context", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "load-balancing-group" => { "description" => "A load balancing group", "model-description" => {"*" => { "description" => "A load balancing group", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }} }, "rewrite" => { "description" => "A rewrite (or redirect) filter", "model-description" => {"*" => { "description" => "A rewrite (or redirect) filter", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "redirect" => { "type" => BOOLEAN, "description" => "If this is true then a redirect will be done instead of a rewrite", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target" => { "type" => STRING, "description" => "The expression that defines the target. If you are redirecting to a constant target put single quotes around the value", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "response-header" => { "description" => "Response header filter allows you to add custom headers.", "model-description" => {"*" => { "description" => "Response header filter allows you to add custom headers.", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "header-name" => { "type" => STRING, "description" => "Header name", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "header-value" => { "type" => STRING, "description" => "Value for header", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "request-limit" => { "description" => "Concurrent request limiter handler", "model-description" => {"*" => { "description" => "Concurrent request limiter handler", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "max-concurrent-requests" => { "type" => INT, "description" => "Maximum number of concurrent requests", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "queue-size" => { "type" => INT, "description" => "Number of requests to queue before they start being rejected", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "custom-filter" => { "description" => "Custom filter", "model-description" => {"*" => { "description" => "Custom filter", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "Class name of HttpHandler", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Module name where class can be loaded from", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "parameters" => { "type" => OBJECT, "description" => "Filter parameters", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "handler" => { "description" => "Undertow handlers", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "file" => { "description" => "File handler", "model-description" => {"*" => { "description" => "File handler", "capabilities" => [{ "name" => "org.wildfly.extension.undertow.handler", "dynamic" => true }], "access-constraints" => {"sensitive" => {"undertow-handler" => {"type" => "undertow"}}}, "attributes" => { "cache-buffer-size" => { "type" => LONG, "description" => "Size of the buffers, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-buffers" => { "type" => LONG, "description" => "Number of buffers", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "case-sensitive" => { "type" => BOOLEAN, "description" => "Use case sensitive file handling", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "directory-listing" => { "type" => BOOLEAN, "description" => "Enable directory listing?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "follow-symlink" => { "type" => BOOLEAN, "description" => "Enable following symbolic links", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "Path on filesystem from where file handler will serve resources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "safe-symlink-paths" => { "type" => LIST, "description" => "Paths that are safe to be targets of symbolic links", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "reverse-proxy" => { "description" => "A reverse proxy handler", "model-description" => {"*" => { "description" => "A reverse proxy handler", "capabilities" => [{ "name" => "org.wildfly.extension.undertow.handler", "dynamic" => true }], "access-constraints" => {"sensitive" => {"undertow-handler" => {"type" => "undertow"}}}, "attributes" => { "cached-connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be kept alive indefinitely", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-idle-timeout" => { "type" => INT, "description" => "The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)", "expressions-allowed" => true, "nillable" => true, "default" => 60L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be maintained to backend servers, per IO thread. Defaults to 10.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-request-time" => { "type" => INT, "description" => "The maximum time that a proxy request can be active for, before being killed. Defaults to unlimited", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "problem-server-retry" => { "type" => INT, "description" => "Time in seconds to wait before attempting to reconnect to a server that is down", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "request-queue-size" => { "type" => INT, "description" => "The number of requests that can be queued if the connection pool is full before requests are rejected with a 503", "expressions-allowed" => true, "nillable" => true, "default" => 10, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "session-cookie-names" => { "type" => STRING, "description" => "Comma separated list of session cookie names. Generally this will just be JSESSIONID.", "expressions-allowed" => true, "nillable" => true, "default" => "JSESSIONID", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"host" => { "description" => "A host that the reverse proxy will forward requests to", "model-description" => {"*" => { "description" => "A host that the reverse proxy will forward requests to", "access-constraints" => {"sensitive" => {"undertow-handler" => {"type" => "undertow"}}}, "attributes" => { "instance-id" => { "type" => STRING, "description" => "The instance id (aka JVM route) that will be used to enable sticky sessions", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "outbound-socket-binding" => { "type" => STRING, "description" => "Outbound socket binding for this host", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "path" => { "type" => STRING, "description" => "Optional path if host is using non root resource", "expressions-allowed" => true, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "scheme" => { "type" => STRING, "description" => "What kind of scheme is used", "expressions-allowed" => true, "nillable" => true, "default" => "http", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm that provides the SSL configuration for the connection to the host", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } } } }, "application-security-domain" => { "description" => "A Mapping from a security domain references in a deployed application.", "model-description" => {"*" => { "description" => "A Mapping from a security domain references in a deployed application.", "capabilities" => [{ "name" => "org.wildfly.extension.undertow.application-security-domain", "dynamic" => true }], "attributes" => { "http-authentication-factory" => { "type" => STRING, "description" => "The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.security.http-authentication-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "override-deployment-config" => { "type" => BOOLEAN, "description" => "Should the authentication configuration in the deployment be overridden by the factory.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "referencing-deployments" => { "type" => LIST, "description" => "The deployments currently referencing this mapping.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "server" => { "description" => "A server", "model-description" => {"*" => { "description" => "A server", "attributes" => { "default-host" => { "type" => STRING, "description" => "The servers default virtual host", "expressions-allowed" => true, "nillable" => true, "default" => "default-host", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "servlet-container" => { "type" => STRING, "description" => "The servers default servlet container", "expressions-allowed" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "host" => { "description" => "The servers host", "model-description" => {"*" => { "description" => "An Undertow host", "attributes" => { "alias" => { "type" => LIST, "description" => "Aliases for the host", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-response-code" => { "type" => INT, "description" => "If set, this will be response code sent back in case requested context does not exist on server.", "expressions-allowed" => true, "nillable" => true, "default" => 404, "min" => 400L, "max" => 599L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "default-web-module" => { "type" => STRING, "description" => "Default web module", "expressions-allowed" => false, "nillable" => true, "default" => "ROOT.war", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "disable-console-redirect" => { "type" => BOOLEAN, "description" => "if set to true, /console redirect wont be enabled for this host, default is false", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "location" => { "description" => "Holds configuration of location resource", "model-description" => {"*" => { "description" => "Holds configuration of location resource", "attributes" => {"handler" => { "type" => STRING, "description" => "Default handler for this location", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"filter-ref" => { "description" => "Reference to filter", "model-description" => {"*" => { "description" => "Reference to filter", "attributes" => { "predicate" => { "type" => STRING, "description" => "Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "priority" => { "type" => INT, "description" => "Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "setting" => { "description" => "Settings", "model-description" => { "access-log" => { "description" => "The access log configuration for this virtual server.", "access-constraints" => {"sensitive" => {"web-access-log" => {"type" => "undertow"}}}, "attributes" => { "directory" => { "type" => STRING, "description" => "Directory in which to save logs", "expressions-allowed" => true, "nillable" => true, "default" => expression "${jboss.server.log.dir}", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "extended" => { "type" => BOOLEAN, "description" => "If the log uses the extended log file format", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pattern" => { "type" => STRING, "description" => "The access log pattern.", "expressions-allowed" => false, "nillable" => true, "default" => "common", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "predicate" => { "type" => STRING, "description" => "Predicate that determines if the request should be logged", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prefix" => { "type" => STRING, "description" => "Prefix for the log file name.", "expressions-allowed" => true, "nillable" => true, "default" => "access_log.", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "relative-to" => { "type" => STRING, "description" => "The directory the path is relative to", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate" => { "type" => BOOLEAN, "description" => "Rotate the access log every day.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Suffix for the log file name.", "expressions-allowed" => true, "nillable" => true, "default" => "log", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-server-log" => { "type" => BOOLEAN, "description" => "If the log should be written to the server log, rather than a separate file. Defaults to false.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker" => { "type" => STRING, "description" => "Name of the worker to use for logging", "expressions-allowed" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "single-sign-on" => { "description" => "The SSO configuration for this virtual server.", "attributes" => { "cookie-name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "nillable" => true, "default" => "JSESSIONIDSSO", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "domain" => { "type" => STRING, "description" => "The cookie domain that will be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "http-only" => { "type" => BOOLEAN, "description" => "Set Cookie httpOnly attribute.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "Cookie path.", "expressions-allowed" => true, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "secure" => { "type" => BOOLEAN, "description" => "Set Cookie secure attribute.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "filter-ref" => { "description" => "Reference to filter", "model-description" => {"*" => { "description" => "Reference to filter", "attributes" => { "predicate" => { "type" => STRING, "description" => "Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "priority" => { "type" => INT, "description" => "Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "http-listener" => { "description" => "A HTTP listener", "model-description" => {"*" => { "description" => "http listener", "capabilities" => [{ "name" => "org.wildfly.undertow.listener", "dynamic" => true }], "access-constraints" => {"sensitive" => {"web-connector" => {"type" => "undertow"}}}, "attributes" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "bytes-received" => { "type" => LONG, "description" => "The number of bytes that have been received by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "bytes-sent" => { "type" => LONG, "description" => "The number of bytes that have been sent out on this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "certificate-forwarding" => { "type" => BOOLEAN, "description" => "If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "nillable" => true, "default" => ["TRACE"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enable-http2" => { "type" => BOOLEAN, "description" => "Enables HTTP2 support for this listener", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems with capabilities" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-count" => { "type" => LONG, "description" => "The number of 500 responses that have been sent by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If server push is enabled for this connection", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "nillable" => true, "default" => 16384, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 10485760L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-processing-time" => { "type" => LONG, "description" => "The maximum processing time taken by a request on this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container, defaults to 60000 (one minute)", "expressions-allowed" => true, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "processing-time" => { "type" => LONG, "description" => "The total processing time of all requests handed by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "proxy-address-forwarding" => { "type" => BOOLEAN, "description" => "enables x-forwarded-host and similar headers and set a remote ip address and hostname", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redirect-socket" => { "type" => STRING, "description" => "If this listener is supporting non-SSL requests, and a request is received for which a matching requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "request-count" => { "type" => LONG, "description" => "The number of requests this listener has served", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "require-host-http11" => { "type" => BOOLEAN, "description" => "Require the Host header when using the HTTP/1.1 protocol", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "ajp-listener" => { "description" => "An AJP listener", "model-description" => {"*" => { "description" => "http listener", "capabilities" => [{ "name" => "org.wildfly.undertow.listener", "dynamic" => true }], "access-constraints" => {"sensitive" => {"web-connector" => {"type" => "undertow"}}}, "attributes" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "bytes-received" => { "type" => LONG, "description" => "The number of bytes that have been received by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "bytes-sent" => { "type" => LONG, "description" => "The number of bytes that have been sent out on this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "nillable" => true, "default" => ["TRACE"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems with capabilities" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-count" => { "type" => LONG, "description" => "The number of 500 responses that have been sent by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-ajp-packet-size" => { "type" => INT, "description" => "The maximum supported size of AJP packets. If this is modified it has to be increased on the load balancer and the backend server.", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "nillable" => true, "default" => 16384, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 10485760L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-processing-time" => { "type" => LONG, "description" => "The maximum processing time taken by a request on this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container, defaults to 60000 (one minute)", "expressions-allowed" => true, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "processing-time" => { "type" => LONG, "description" => "The total processing time of all requests handed by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redirect-socket" => { "type" => STRING, "description" => "If this listener is supporting non-SSL requests, and a request is received for which a matching requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "request-count" => { "type" => LONG, "description" => "The number of requests this listener has served", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "scheme" => { "type" => STRING, "description" => "The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "https-listener" => { "description" => "A HTTPS listener", "model-description" => {"*" => { "description" => "http listener", "capabilities" => [{ "name" => "org.wildfly.undertow.listener", "dynamic" => true }], "access-constraints" => {"sensitive" => {"web-connector" => {"type" => "undertow"}}}, "attributes" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "bytes-received" => { "type" => LONG, "description" => "The number of bytes that have been received by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "bytes-sent" => { "type" => LONG, "description" => "The number of bytes that have been sent out on this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "certificate-forwarding" => { "type" => BOOLEAN, "description" => "If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "nillable" => true, "default" => ["TRACE"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enable-http2" => { "type" => BOOLEAN, "description" => "Enables HTTP2 support for this listener", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enable-spdy" => { "type" => BOOLEAN, "description" => "Enables SPDY support for this listener. This has been deprecated and has no effect, HTTP/2 should be used instead", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "3.2.0", "reason" => "SPDY has been replaced by HTTP/2" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems with capabilities" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled-cipher-suites" => { "type" => STRING, "description" => "Configures Enabled SSL ciphers", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is referenced it should be configured with the cipher suites to be supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled-protocols" => { "type" => STRING, "description" => "Configures SSL protocols", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is references it should be configured with the supported protocols." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-count" => { "type" => LONG, "description" => "The number of 500 responses that have been sent by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If server push is enabled for this connection", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "nillable" => true, "unit" => "BYTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "nillable" => true, "default" => 16384, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "nillable" => true, "default" => 200, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "nillable" => true, "default" => 1000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 10485760L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-processing-time" => { "type" => LONG, "description" => "The maximum processing time taken by a request on this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container, defaults to 60000 (one minute)", "expressions-allowed" => true, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "processing-time" => { "type" => LONG, "description" => "The total processing time of all requests handed by this listener", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "proxy-address-forwarding" => { "type" => BOOLEAN, "description" => "enables x-forwarded-host and similar headers and set a remote ip address and hostname", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "request-count" => { "type" => LONG, "description" => "The number of requests this listener has served", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "require-host-http11" => { "type" => BOOLEAN, "description" => "Require the Host header when using the HTTP/1.1 protocol", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "security-realm" => { "type" => STRING, "description" => "The listeners security realm", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "4.0.0", "reason" => "Use the ssl-context attribute to reference a configured SSLContext directly." }, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this listener.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-session-cache-size" => { "type" => INT, "description" => "The maximum number of active SSL sessions", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "ssl-session-timeout" => { "type" => INT, "description" => "The timeout for SSL sessions, in seconds", "expressions-allowed" => true, "nillable" => true, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "verify-client" => { "type" => STRING, "description" => "The desired SSL client authentication mode for SSL channels", "expressions-allowed" => true, "nillable" => true, "default" => "NOT_REQUESTED", "allowed" => [ "NOT_REQUESTED", "REQUESTED", "REQUIRED" ], "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is referenced it should be configured directly for the required mode of client verification." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "buffer-cache" => { "description" => "The buffer cache used to cache static content", "model-description" => {"*" => { "description" => "The buffer cache used to cache static content", "attributes" => { "buffer-size" => { "type" => INT, "description" => "The size of an individual buffer, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "buffers-per-region" => { "type" => INT, "description" => "The numbers of buffers in a region", "expressions-allowed" => true, "nillable" => true, "default" => 1024, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-regions" => { "type" => INT, "description" => "The maximum number of regions", "expressions-allowed" => true, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "security-manager" => { "description" => "Security Manager subsystem", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"deployment-permissions" => { "description" => "The permissions that are to be granted to deployments", "model-description" => {"default" => { "description" => "The permissions that are to be granted to deployments", "attributes" => { "maximum-permissions" => { "type" => LIST, "description" => "The maximum set of permissions that can be granted to a deployment or jars.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "class" => { "type" => STRING, "description" => "The permission fully-qualified class name", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "name" => { "type" => STRING, "description" => "The permission target name", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "actions" => { "type" => STRING, "description" => "The permission actions", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "module" => { "type" => STRING, "description" => "The module to load the permission from. If not specified it will be loaded using the class loader of the security manager subsystem.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "minimum-permissions" => { "type" => LIST, "description" => "The minimum set of permissions to be granted to a deployment or jars.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "class" => { "type" => STRING, "description" => "The permission fully-qualified class name", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "name" => { "type" => STRING, "description" => "The permission target name", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "actions" => { "type" => STRING, "description" => "The permission actions", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "module" => { "type" => STRING, "description" => "The module to load the permission from. If not specified it will be loaded using the class loader of the security manager subsystem.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "datasources" => { "description" => "The data-sources subsystem, used to declare JDBC data-sources", "attributes" => {"installed-drivers" => { "type" => LIST, "description" => "List of JDBC drivers that have been installed in the runtime", "expressions-allowed" => false, "nillable" => false, "value-type" => { "deployment-name" => { "type" => STRING, "description" => "The name of the deployment unit from which the driver was loaded", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "driver-module-name" => { "type" => STRING, "description" => "The name of the module from which the driver was loaded, if it was loaded from the module path", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "module-slot" => { "type" => STRING, "description" => "The slot of the module from which the driver was loaded, if it was loaded from the module path", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "driver-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the java.sql.Driver implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "driver-datasource-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the javax.sql.DataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "driver-xa-datasource-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the javax.sql.XADataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "xa-datasource-class" => { "type" => STRING, "description" => "XA datasource class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "driver-major-version" => { "type" => INT, "description" => "The driver's major version number", "expressions-allowed" => true, "nillable" => true }, "driver-minor-version" => { "type" => INT, "description" => "The driver's minor version number", "expressions-allowed" => true, "nillable" => true }, "jdbc-compliant" => { "type" => BOOLEAN, "description" => "Whether or not the driver is JDBC compliant", "expressions-allowed" => true, "nillable" => true }, "profile" => { "type" => STRING, "description" => "Domain Profile in which driver is defined. Null in case of standalone server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => { "jdbc-driver" => { "description" => "Service that make a JDBC driver available for use in the runtime", "model-description" => {"*" => { "description" => "Service that make a JDBC driver available for use in the runtime", "access-constraints" => {"application" => {"jdbc-driver" => {"type" => "datasources"}}}, "attributes" => { "deployment-name" => { "type" => STRING, "description" => "The name of the deployment unit from which the driver was loaded", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "driver-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the java.sql.Driver implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "driver-datasource-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the javax.sql.DataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "driver-major-version" => { "type" => INT, "description" => "The driver's major version number", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "driver-minor-version" => { "type" => INT, "description" => "The driver's minor version number", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "driver-module-name" => { "type" => STRING, "description" => "The name of the module from which the driver was loaded, if it was loaded from the module path", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "driver-xa-datasource-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the javax.sql.XADataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "jdbc-compliant" => { "type" => BOOLEAN, "description" => "Whether or not the driver is JDBC compliant", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "module-slot" => { "type" => STRING, "description" => "The slot of the module from which the driver was loaded, if it was loaded from the module path", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "profile" => { "type" => STRING, "description" => "Domain Profile in which driver is defined. Null in case of standalone server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "4.0.0", "reason" => "The server's profile can be determined by the profile-name attribute on the server's root resource." }, "access-type" => "read-only", "storage" => "configuration" }, "xa-datasource-class" => { "type" => STRING, "description" => "XA datasource class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "data-source" => { "description" => "A JDBC data-source configuration", "model-description" => {"*" => { "description" => "A JDBC data-source configuration", "capabilities" => [{ "name" => "org.wildfly.data-source", "dynamic" => true }], "access-constraints" => {"application" => {"data-source" => {"type" => "datasources"}}}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-multiple-users" => { "type" => BOOLEAN, "description" => "Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to be injected in class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to be injected in class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "check-valid-connection-sql" => { "type" => STRING, "description" => "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-listener-class" => { "type" => STRING, "description" => "Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-listener-property" => { "type" => OBJECT, "description" => "Properties to be injected in class specidied in connection-listener-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-url" => { "type" => STRING, "description" => "The JDBC driver connection URL", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "datasource-class" => { "type" => STRING, "description" => "The fully qualified name of the JDBC datasource class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "driver-class" => { "type" => STRING, "description" => "The fully qualified name of the JDBC driver class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "exception-sorter-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "exception-sorter-properties" => { "type" => OBJECT, "description" => "The exception sorter properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["exception-sorter-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "initial-pool-size" => { "type" => INT, "description" => "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the datasource", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jta" => { "type" => BOOLEAN, "description" => "Enable JTA integration", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-pool-size" => { "type" => INT, "description" => "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "min-pool-size" => { "type" => INT, "description" => "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "new-connection-sql" => { "type" => STRING, "description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "password" => { "type" => STRING, "description" => "Specifies the password used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "requires" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool should use be fair", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prepared-statements-cache-size" => { "type" => LONG, "description" => "The number of prepared statements per connection in an LRU cache", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "query-timeout" => { "type" => LONG, "description" => "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reauth-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reauth-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the reauthentication plugin", "expressions-allowed" => true, "nillable" => true, "requires" => ["reauth-plugin-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "set-tx-query-timeout" => { "type" => BOOLEAN, "description" => "Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "share-prepared-statements" => { "type" => BOOLEAN, "description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "spy" => { "type" => BOOLEAN, "description" => "Enable spying of SQL statements", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "stale-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "stale-connection-checker-properties" => { "type" => OBJECT, "description" => "The stale connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["stale-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "track-statements" => { "type" => STRING, "description" => "Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: \"false\" - do not track statements, \"true\" - track statements and result sets and warn when they are not closed, \"nowarn\" - track statements but do not warn about them being unclosed", "expressions-allowed" => true, "nillable" => true, "default" => "NOWARN", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transaction-isolation" => { "type" => STRING, "description" => "Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-delimiter" => { "type" => STRING, "description" => "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-selector-strategy-class-name" => { "type" => STRING, "description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-try-lock" => { "type" => LONG, "description" => "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "user-name" => { "type" => STRING, "description" => "Specify the user name used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "valid-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "valid-connection-checker-properties" => { "type" => OBJECT, "description" => "The valid connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["valid-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"connection-properties" => { "description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method", "model-description" => {"*" => { "description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method", "access-constraints" => {"application" => {"data-source" => {"type" => "datasources"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "xa-data-source" => { "description" => "A JDBC XA data-source configuration", "model-description" => {"*" => { "description" => "A JDBC XA data-source configuration", "capabilities" => [{ "name" => "org.wildfly.data-source", "dynamic" => true }], "access-constraints" => {"application" => {"xa-data-source" => {"type" => "datasources"}}}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-multiple-users" => { "type" => BOOLEAN, "description" => "Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "check-valid-connection-sql" => { "type" => STRING, "description" => "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR for this datasource. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-listener-class" => { "type" => STRING, "description" => "Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connection-listener-property" => { "type" => OBJECT, "description" => "Properties to be injected in class specified in connection-listener-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "exception-sorter-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "exception-sorter-properties" => { "type" => OBJECT, "description" => "The exception sorter properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["exception-sorter-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "initial-pool-size" => { "type" => INT, "description" => "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "interleaving" => { "type" => BOOLEAN, "description" => "An element to enable interleaving for XA connections", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the datasource", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-pool-size" => { "type" => INT, "description" => "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "min-pool-size" => { "type" => INT, "description" => "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "new-connection-sql" => { "type" => STRING, "description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-recovery" => { "type" => BOOLEAN, "description" => "Specifies if the connection pool should be excluded from recovery", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-tx-separate-pool" => { "type" => BOOLEAN, "description" => "Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pad-xid" => { "type" => BOOLEAN, "description" => "Should the Xid be padded", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "password" => { "type" => STRING, "description" => "Specifies the password used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "requires" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool should use be fair", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "prepared-statements-cache-size" => { "type" => LONG, "description" => "The number of prepared statements per connection in an LRU cache", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "query-timeout" => { "type" => LONG, "description" => "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reauth-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reauth-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the reauthentication plugin", "expressions-allowed" => true, "nillable" => true, "requires" => ["reauth-plugin-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-password" => { "type" => STRING, "description" => "The password used for recovery", "expressions-allowed" => true, "nillable" => true, "requires" => ["recovery-username"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the recovery plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the recovery plugin", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-security-domain" => { "type" => STRING, "description" => "The security domain used for recovery", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["recovery-username"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-username" => { "type" => STRING, "description" => "The user name used for recovery", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["recovery-security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "same-rm-override" => { "type" => BOOLEAN, "description" => "The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "set-tx-query-timeout" => { "type" => BOOLEAN, "description" => "Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "share-prepared-statements" => { "type" => BOOLEAN, "description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "spy" => { "type" => BOOLEAN, "description" => "Enable spying of SQL statements", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "stale-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "stale-connection-checker-properties" => { "type" => OBJECT, "description" => "The stale connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["stale-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "track-statements" => { "type" => STRING, "description" => "Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: \"false\" - do not track statements, \"true\" - track statements and result sets and warn when they are not closed, \"nowarn\" - track statements but do not warn about them being unclosed", "expressions-allowed" => true, "nillable" => true, "default" => "NOWARN", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transaction-isolation" => { "type" => STRING, "description" => "Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-delimiter" => { "type" => STRING, "description" => "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-property" => { "type" => STRING, "description" => "Specifies the property for the URL property in the xa-datasource-property values", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-selector-strategy-class-name" => { "type" => STRING, "description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-try-lock" => { "type" => LONG, "description" => "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "user-name" => { "type" => STRING, "description" => "Specify the user name used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "valid-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "valid-connection-checker-properties" => { "type" => OBJECT, "description" => "The valid connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["valid-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wrap-xa-resource" => { "type" => BOOLEAN, "description" => "Should the XAResource instances be wrapped in an org.jboss.tm.XAResourceWrapper instance", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "xa-datasource-class" => { "type" => STRING, "description" => "The fully qualified name of the javax.sql.XADataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "xa-resource-timeout" => { "type" => INT, "description" => "The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"xa-datasource-properties" => { "description" => "List of xa-datasource-property", "model-description" => {"*" => { "description" => "List of xa-datasource-property", "access-constraints" => {"application" => {"xa-data-source" => {"type" => "datasources"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } }, "logging" => { "description" => "The configuration of the logging subsystem.", "attributes" => { "add-logging-api-dependencies" => { "type" => BOOLEAN, "description" => "Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-deployment-logging-config" => { "type" => BOOLEAN, "description" => "Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file was found in the deployments META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set false the servers logging configuration will be used regardless of any logging configuration files supplied in the deployment.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "periodic-rotating-file-handler" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.", "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "periodic-size-rotating-file-handler" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string or after the size of the file grows beyond a certain point and keeping a fixed number of backups. The suffix should be in a format understood by the java.text.SimpleDateFormat. Any backups rotated by the suffix will not be purged during a size rotation.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string or after the size of the file grows beyond a certain point and keeping a fixed number of backups. The suffix should be in a format understood by the java.text.SimpleDateFormat. Any backups rotated by the suffix will not be purged during a size rotation.", "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-backup-index" => { "type" => INT, "description" => "The maximum number of backups to keep.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-on-boot" => { "type" => BOOLEAN, "description" => "Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-size" => { "type" => STRING, "description" => "The size at which to rotate the log file.", "expressions-allowed" => true, "nillable" => true, "default" => "2m", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "async-handler" => { "description" => "Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.", "model-description" => {"*" => { "description" => "Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.", "attributes" => { "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "overflow-action" => { "type" => STRING, "description" => "Specify what action to take when the overflowing. The valid options are 'block' and 'discard'", "expressions-allowed" => true, "nillable" => true, "default" => "BLOCK", "allowed" => [ "BLOCK", "DISCARD" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "queue-length" => { "type" => INT, "description" => "The queue length to use before flushing writing", "expressions-allowed" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "subhandlers" => { "type" => LIST, "description" => "The Handlers associated with this async handler.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "syslog-handler" => { "description" => "Defines a syslog handler.", "model-description" => {"*" => { "description" => "Defines a syslog handler.", "attributes" => { "app-name" => { "type" => STRING, "description" => "The app name used when formatting the message in RFC5424 format. By default the app name is \"java\".", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "facility" => { "type" => STRING, "description" => "Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).", "expressions-allowed" => true, "nillable" => true, "default" => "user-level", "allowed" => [ "kernel", "user-level", "mail-system", "system-daemons", "security", "syslogd", "line-printer", "network-news", "uucp", "clock-daemon", "security2", "ftp-daemon", "ntp", "log-audit", "log-alert", "clock-daemon2", "local-use-0", "local-use-1", "local-use-2", "local-use-3", "local-use-4", "local-use-5", "local-use-6", "local-use-7" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "hostname" => { "type" => STRING, "description" => "The name of the host the messages are being sent from. For example the name of the host the application server is running on.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "port" => { "type" => INT, "description" => "The port the syslog server is listening on.", "expressions-allowed" => true, "nillable" => true, "default" => 514, "min" => 0L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-address" => { "type" => STRING, "description" => "The address of the syslog server.", "expressions-allowed" => true, "nillable" => true, "default" => "localhost", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "syslog-format" => { "type" => STRING, "description" => "Formats the log message according to the RFC specification.", "expressions-allowed" => true, "nillable" => true, "default" => "RFC5424", "allowed" => [ "RFC5424", "RFC3164" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "file-handler" => { "description" => "Defines a handler which writes to a file.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file.", "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "root-logger" => { "description" => "Defines the root logger for this log context.", "model-description" => {"ROOT" => { "description" => "Defines the root logger for this log context.", "attributes" => { "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "handlers" => { "type" => LIST, "description" => "The handlers associated with the root logger.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by the root logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "logging-profile" => { "description" => "A profile that can be assigned to a deployment for it's logging configuration.", "model-description" => {"*" => { "description" => "The configuration of the logging subsystem.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "periodic-rotating-file-handler" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "periodic-size-rotating-file-handler" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string or after the size of the file grows beyond a certain point and keeping a fixed number of backups. The suffix should be in a format understood by the java.text.SimpleDateFormat. Any backups rotated by the suffix will not be purged during a size rotation.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string or after the size of the file grows beyond a certain point and keeping a fixed number of backups. The suffix should be in a format understood by the java.text.SimpleDateFormat. Any backups rotated by the suffix will not be purged during a size rotation.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-backup-index" => { "type" => INT, "description" => "The maximum number of backups to keep.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-on-boot" => { "type" => BOOLEAN, "description" => "Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-size" => { "type" => STRING, "description" => "The size at which to rotate the log file.", "expressions-allowed" => true, "nillable" => true, "default" => "2m", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "async-handler" => { "description" => "Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.", "model-description" => {"*" => { "description" => "Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "overflow-action" => { "type" => STRING, "description" => "Specify what action to take when the overflowing. The valid options are 'block' and 'discard'", "expressions-allowed" => true, "nillable" => true, "default" => "BLOCK", "allowed" => [ "BLOCK", "DISCARD" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "queue-length" => { "type" => INT, "description" => "The queue length to use before flushing writing", "expressions-allowed" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "subhandlers" => { "type" => LIST, "description" => "The Handlers associated with this async handler.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "syslog-handler" => { "description" => "Defines a syslog handler.", "model-description" => {"*" => { "description" => "Defines a syslog handler.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "app-name" => { "type" => STRING, "description" => "The app name used when formatting the message in RFC5424 format. By default the app name is \"java\".", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "facility" => { "type" => STRING, "description" => "Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).", "expressions-allowed" => true, "nillable" => true, "default" => "user-level", "allowed" => [ "kernel", "user-level", "mail-system", "system-daemons", "security", "syslogd", "line-printer", "network-news", "uucp", "clock-daemon", "security2", "ftp-daemon", "ntp", "log-audit", "log-alert", "clock-daemon2", "local-use-0", "local-use-1", "local-use-2", "local-use-3", "local-use-4", "local-use-5", "local-use-6", "local-use-7" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "hostname" => { "type" => STRING, "description" => "The name of the host the messages are being sent from. For example the name of the host the application server is running on.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "port" => { "type" => INT, "description" => "The port the syslog server is listening on.", "expressions-allowed" => true, "nillable" => true, "default" => 514, "min" => 0L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-address" => { "type" => STRING, "description" => "The address of the syslog server.", "expressions-allowed" => true, "nillable" => true, "default" => "localhost", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "syslog-format" => { "type" => STRING, "description" => "Formats the log message according to the RFC specification.", "expressions-allowed" => true, "nillable" => true, "default" => "RFC5424", "allowed" => [ "RFC5424", "RFC3164" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "file-handler" => { "description" => "Defines a handler which writes to a file.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "root-logger" => { "description" => "Defines the root logger for this log context.", "model-description" => {"ROOT" => { "description" => "Defines the root logger for this log context.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "handlers" => { "type" => LIST, "description" => "The handlers associated with the root logger.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by the root logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "custom-handler" => { "description" => "Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.", "model-description" => {"*" => { "description" => "Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "class" => { "type" => STRING, "description" => "The logging handler class to be used.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "The module that the logging handler depends on.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "properties" => { "type" => OBJECT, "description" => "Defines the properties used for the logging handler. All properties must be accessible via a setter method.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "size-rotating-file-handler" => { "description" => "Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-backup-index" => { "type" => INT, "description" => "The maximum number of backups to keep.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-on-boot" => { "type" => BOOLEAN, "description" => "Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-size" => { "type" => STRING, "description" => "The size at which to rotate the log file.", "expressions-allowed" => true, "nillable" => true, "default" => "2m", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The suffix does not determine when the file should be rotated.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "console-handler" => { "description" => "Defines a handler which writes to the console.", "model-description" => {"*" => { "description" => "Defines a handler which writes to the console.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target" => { "type" => STRING, "description" => "Defines the target of the console handler. The value can be System.out, System.err or console.", "expressions-allowed" => true, "nillable" => true, "default" => "System.out", "allowed" => [ "console", "System.out", "System.err" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "custom-formatter" => { "description" => "A custom formatter to be used with handlers. Note that most log records are formatted in the printf format. Formatters may require invocation of the org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.", "model-description" => {"*" => { "description" => "A custom formatter to be used with handlers. Note that most log records are formatted in the printf format. Formatters may require invocation of the org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "class" => { "type" => STRING, "description" => "The logging handler class to be used.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module that the logging handler depends on.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "Defines the properties used for the logging handler. All properties must be accessible via a setter method.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "log-file" => { "description" => "Log files that are available to be read.", "model-description" => {"*" => { "description" => "Log files that are available to be read.", "storage" => "runtime-only", "access-constraints" => { "sensitive" => {"view-server-logs" => {"type" => "logging"}}, "application" => {"logging-profile" => {"type" => "logging"}} }, "attributes" => { "file-size" => { "type" => LONG, "description" => "The size of the log file in bytes.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "last-modified-time" => { "type" => LONG, "description" => "The date, in milliseconds, the file was last modified.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "last-modified-timestamp" => { "type" => STRING, "description" => "The date, in ISO 8601 format, the file was last modified.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "stream" => { "type" => STRING, "description" => "Provides the server log as a response attachment. The response result value is the unique id of the attachment.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "pattern-formatter" => { "description" => "A pattern formatter to be used with handlers.", "model-description" => {"*" => { "description" => "A pattern formatter to be used with handlers.", "access-constraints" => {"application" => {"logging-profile" => {"type" => "logging"}}}, "attributes" => { "color-map" => { "type" => STRING, "description" => "The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pattern" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "logger" => { "description" => "Defines a logger category.", "model-description" => {"*" => { "description" => "Defines a logger category.", "access-constraints" => {"application" => { "logger" => {"type" => "logging"}, "logging-profile" => {"type" => "logging"} }}, "attributes" => { "category" => { "type" => STRING, "description" => "Specifies the category for the logger.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "handlers" => { "type" => LIST, "description" => "The handlers associated with the logger.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by the logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-parent-handlers" => { "type" => BOOLEAN, "description" => "Specifies whether or not this logger should send its output to it's parent Logger.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "custom-handler" => { "description" => "Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.", "model-description" => {"*" => { "description" => "Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.", "attributes" => { "class" => { "type" => STRING, "description" => "The logging handler class to be used.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "The module that the logging handler depends on.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "properties" => { "type" => OBJECT, "description" => "Defines the properties used for the logging handler. All properties must be accessible via a setter method.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "size-rotating-file-handler" => { "description" => "Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.", "model-description" => {"*" => { "description" => "Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.", "attributes" => { "append" => { "type" => BOOLEAN, "description" => "Specify whether to append to the target file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "file" => { "type" => OBJECT, "description" => "The file description consisting of the path and optional relative to path.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "path" => { "type" => STRING, "description" => "The filesystem path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-backup-index" => { "type" => INT, "description" => "The maximum number of backups to keep.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-on-boot" => { "type" => BOOLEAN, "description" => "Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-size" => { "type" => STRING, "description" => "The size at which to rotate the log file.", "expressions-allowed" => true, "nillable" => true, "default" => "2m", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The suffix does not determine when the file should be rotated.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "console-handler" => { "description" => "Defines a handler which writes to the console.", "model-description" => {"*" => { "description" => "Defines a handler which writes to the console.", "attributes" => { "autoflush" => { "type" => BOOLEAN, "description" => "Automatically flush after each write.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "encoding" => { "type" => STRING, "description" => "The character encoding used by this Handler.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "formatter" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" => ["named-formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "The name attribute should not be used as the handler's address contains the name." }, "access-type" => "read-only", "storage" => "configuration" }, "named-formatter" => { "type" => STRING, "description" => "The name of the defined formatter to be used on the handler.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["formatter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "target" => { "type" => STRING, "description" => "Defines the target of the console handler. The value can be System.out, System.err or console.", "expressions-allowed" => true, "nillable" => true, "default" => "System.out", "allowed" => [ "console", "System.out", "System.err" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "custom-formatter" => { "description" => "A custom formatter to be used with handlers. Note that most log records are formatted in the printf format. Formatters may require invocation of the org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.", "model-description" => {"*" => { "description" => "A custom formatter to be used with handlers. Note that most log records are formatted in the printf format. Formatters may require invocation of the org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.", "attributes" => { "class" => { "type" => STRING, "description" => "The logging handler class to be used.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module that the logging handler depends on.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "Defines the properties used for the logging handler. All properties must be accessible via a setter method.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "log-file" => { "description" => "Log files that are available to be read.", "model-description" => {"*" => { "description" => "Log files that are available to be read.", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"view-server-logs" => {"type" => "logging"}}}, "attributes" => { "file-size" => { "type" => LONG, "description" => "The size of the log file in bytes.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "last-modified-time" => { "type" => LONG, "description" => "The date, in milliseconds, the file was last modified.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "last-modified-timestamp" => { "type" => STRING, "description" => "The date, in ISO 8601 format, the file was last modified.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "stream" => { "type" => STRING, "description" => "Provides the server log as a response attachment. The response result value is the unique id of the attachment.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "pattern-formatter" => { "description" => "A pattern formatter to be used with handlers.", "model-description" => {"*" => { "description" => "A pattern formatter to be used with handlers.", "attributes" => { "color-map" => { "type" => STRING, "description" => "The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pattern" => { "type" => STRING, "description" => "Defines a pattern for the formatter.", "expressions-allowed" => true, "nillable" => true, "default" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "logger" => { "description" => "Defines a logger category.", "model-description" => {"*" => { "description" => "Defines a logger category.", "access-constraints" => {"application" => {"logger" => {"type" => "logging"}}}, "attributes" => { "category" => { "type" => STRING, "description" => "Specifies the category for the logger.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "filter" => { "type" => OBJECT, "description" => "Defines a simple filter type.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["filter-spec"], "deprecated" => { "since" => "1.2.0", "reason" => "Use filter-spec." }, "value-type" => { "all" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be unloggable,the message will not be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "any" => { "type" => OBJECT, "description" => "A filter consisting of several filters in a chain. If any filter finds the log message to be loggable, the message will be logged and subsequent filters will not be checked.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "not" => { "type" => OBJECT, "description" => "A filter that inverts the filter that is nested.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "accept" => { "type" => BOOLEAN, "description" => "Accepts all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "change-level" => { "type" => STRING, "description" => "A filter which modifies the log record with a new level if the nested filter evaluates true for that record.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "deny" => { "type" => BOOLEAN, "description" => "Denys all log messages.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "level" => { "type" => STRING, "description" => "A filter which excludes a message with the specified level.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "level-range" => { "type" => OBJECT, "description" => "A filter which logs only messages that fall within a level range.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "min-level" => { "type" => STRING, "description" => "The minimum (least severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "min-inclusive" => { "type" => BOOLEAN, "description" => "True if the min-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true }, "max-level" => { "type" => STRING, "description" => "The maximum (most severe) level, inclusive.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ] }, "max-inclusive" => { "type" => BOOLEAN, "description" => "True if the max-level value is inclusive, false if it is exclusive.", "expressions-allowed" => false, "nillable" => true, "default" => true } } }, "match" => { "type" => STRING, "description" => "A regular-expression-based filter. Used to exclude log records which match or don't match the expression. The regular expression is checked against the raw (unformatted) message.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } } }, "replace" => { "type" => OBJECT, "description" => "A filter which applies a text substitution on the message if the nested filter matches.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "pattern" => { "type" => STRING, "description" => "The pattern to match", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replacement" => { "type" => STRING, "description" => "The string replacement", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "replace-all" => { "type" => BOOLEAN, "description" => "True if all occurrences should be replaced; false if only the first occurrence", "expressions-allowed" => false, "nillable" => true, "default" => true } } } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "filter-spec" => { "type" => STRING, "description" => "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "handlers" => { "type" => LIST, "description" => "The handlers associated with the logger.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by the logger. Message levels lower than this value will be discarded.", "expressions-allowed" => true, "nillable" => true, "default" => "ALL", "allowed" => [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-parent-handlers" => { "type" => BOOLEAN, "description" => "Specifies whether or not this logger should send its output to it's parent Logger.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "naming" => { "description" => "The configuration of the naming subsystem.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "service" => { "description" => "Naming based services", "model-description" => {"remote-naming" => { "description" => "The remote naming server", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "binding" => { "description" => "JNDI bindings for primitive types", "model-description" => {"*" => { "description" => "JNDI bindings for primitive types", "access-constraints" => { "application" => {"binding" => {"type" => "naming"}}, "sensitive" => {"naming-binding" => {"type" => "naming"}} }, "attributes" => { "binding-type" => { "type" => STRING, "description" => "The type of binding to create, may be simple, lookup, external-context or object-factory", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "simple", "object-factory", "lookup", "external-context" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache" => { "type" => BOOLEAN, "description" => "If the external context should be cached", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "class" => { "type" => STRING, "description" => "The object factory class name for object factory bindings", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "environment" => { "type" => OBJECT, "description" => "The environment to use on object factory instance retrieval", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "lookup" => { "type" => STRING, "description" => "The entry to lookup in JNDI for lookup bindings", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module to load the object factory from for object factory bindings", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "type" => { "type" => STRING, "description" => "The type of the value to bind for simple bindings, this must be a primitive type", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "value" => { "type" => STRING, "description" => "The value to bind for simple bindings", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "webservices" => { "description" => "The configuration of the web services subsystem.", "attributes" => { "modify-wsdl-address" => { "type" => BOOLEAN, "description" => "Whether the soap address can be modified.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Whether statistics are to be gathered for endpoints, default value is 'false'.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wsdl-host" => { "type" => STRING, "description" => "The WSDL, that is a required deployment artifact for an endpoint, has a element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the ", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wsdl-path-rewrite-rule" => { "type" => STRING, "description" => "This string defines a SED substitution command (e.g., 's/regexp/replacement/g') that JBossWS executes against the path component of each URL published from the server. When wsdl-path-rewrite-rule is not defined, JBossWS retains the original path component of each URL. When 'modify-wsdl-address' is set to \"false\" this element is ignored.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wsdl-port" => { "type" => INT, "description" => "The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.", "expressions-allowed" => true, "nillable" => true, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wsdl-secure-port" => { "type" => INT, "description" => "The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.", "expressions-allowed" => true, "nillable" => true, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wsdl-uri-scheme" => { "type" => STRING, "description" => "The URI scheme to use for rewriting . Valid values are 'http' and 'https'. This configuration overrides scheme computed by processing the endpoint (even if a transport guarantee is specified). The provided values for 'wsdl-port' and 'wsdl-secure-port' (or their default values) are used depending on specified scheme.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "http", "https" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "client-config" => { "description" => "Webservice client configuration", "model-description" => {"*" => { "description" => "Webservice client configuration", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "pre-handler-chain" => { "description" => "Client configuration PRE handler chain", "model-description" => {"*" => { "description" => "Endpoint configuration PRE handler chain", "attributes" => {"protocol-bindings" => { "type" => STRING, "description" => "Protocol binding", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"handler" => { "description" => "Handler", "model-description" => {"*" => { "description" => "Endpoint handler", "attributes" => {"class" => { "type" => STRING, "description" => "Handler class", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "post-handler-chain" => { "description" => "Client configuration POST handler chain", "model-description" => {"*" => { "description" => "Endpoint configuration POST handler chain", "attributes" => {"protocol-bindings" => { "type" => STRING, "description" => "Protocol binding", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"handler" => { "description" => "Handler", "model-description" => {"*" => { "description" => "Endpoint handler", "attributes" => {"class" => { "type" => STRING, "description" => "Handler class", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "property" => { "description" => "Client configuration property", "model-description" => {"*" => { "description" => "Endpoint configuration property", "attributes" => {"value" => { "type" => STRING, "description" => "Endpoint configuration property value", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "endpoint-config" => { "description" => "Webservice endpoint configuration", "model-description" => {"*" => { "description" => "Webservice endpoint configuration", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "pre-handler-chain" => { "description" => "Pre handler chain", "model-description" => {"*" => { "description" => "Endpoint configuration PRE handler chain", "attributes" => {"protocol-bindings" => { "type" => STRING, "description" => "Protocol binding", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"handler" => { "description" => "Handler", "model-description" => {"*" => { "description" => "Endpoint handler", "attributes" => {"class" => { "type" => STRING, "description" => "Handler class", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "post-handler-chain" => { "description" => "Post handler chain", "model-description" => {"*" => { "description" => "Endpoint configuration POST handler chain", "attributes" => {"protocol-bindings" => { "type" => STRING, "description" => "Protocol binding", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"handler" => { "description" => "Handler", "model-description" => {"*" => { "description" => "Endpoint handler", "attributes" => {"class" => { "type" => STRING, "description" => "Handler class", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "property" => { "description" => "Configuration property", "model-description" => {"*" => { "description" => "Endpoint configuration property", "attributes" => {"value" => { "type" => STRING, "description" => "Endpoint configuration property value", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} } } }, "jdr" => { "description" => "JBoss Diagnostic Reporter (JDR) Subsystem.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "deployment-scanner" => { "description" => "An individual deployment scanner that scans a particular location", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"scanner" => { "description" => "The scanners maintained by the subsystem.", "model-description" => {"*" => { "description" => "The configuration of the deployment scanner subsystem", "attributes" => { "auto-deploy-exploded" => { "type" => BOOLEAN, "description" => "Allows the automatic deployment of exploded content without requiring a .dodeploy marker file. Recommended for only basic development scenarios to prevent exploded application deployment from occurring during changes by the developer or operating system.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "auto-deploy-xml" => { "type" => BOOLEAN, "description" => "Allows automatic deployment of XML content without requiring a .dodeploy marker file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "auto-deploy-zipped" => { "type" => BOOLEAN, "description" => "Allows automatic deployment of zipped content without requiring a .dodeploy marker file.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "deployment-timeout" => { "type" => LONG, "description" => "The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.", "expressions-allowed" => true, "nillable" => true, "default" => 600, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "The actual filesystem path to be scanned. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "relative-to" => { "type" => STRING, "description" => "Reference to a filesystem path defined in the \"paths\" section of the server configuration.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "runtime-failure-causes-rollback" => { "type" => BOOLEAN, "description" => "Flag indicating whether a runtime failure of a deployment causes a rollback of the deployment as well as all other (maybe unrelated) deployments as part of the scan operation.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "scan-enabled" => { "type" => BOOLEAN, "description" => "Flag indicating if all scanning (including initial scanning at startup) is enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "scan-interval" => { "type" => INT, "description" => "Periodic interval, in milliseconds, at which the repository should be scanned for changes. A value of less than 1 indicates the repository should only be scanned at initial startup.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "mail" => { "description" => "The mail subsystem", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"mail-session" => { "description" => "Mail session definition", "model-description" => {"*" => { "description" => "Mail session definition", "access-constraints" => {"application" => {"mail-session" => {"type" => "mail"}}}, "attributes" => { "debug" => { "type" => BOOLEAN, "description" => "Enables JavaMail debugging", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "from" => { "type" => STRING, "description" => "From address that is used as default from, if not set when sending", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "jndi-name" => { "type" => STRING, "description" => "JNDI name to where mail session should be bound", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "server" => { "description" => "Mail session server", "model-description" => { "smtp" => { "description" => "Mail session server", "access-constraints" => {"application" => {"mail-session" => {"type" => "mail"}}}, "attributes" => { "outbound-socket-binding-ref" => { "type" => STRING, "description" => "Outbound Socket binding to mail server", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "Password to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl" => { "type" => BOOLEAN, "description" => "Does server require SSL?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tls" => { "type" => BOOLEAN, "description" => "Does server require TLS?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "username" => { "type" => STRING, "description" => "Username to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "pop3" => { "description" => "Mail session server", "access-constraints" => {"application" => {"mail-session" => {"type" => "mail"}}}, "attributes" => { "outbound-socket-binding-ref" => { "type" => STRING, "description" => "Outbound Socket binding to mail server", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "Password to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl" => { "type" => BOOLEAN, "description" => "Does server require SSL?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tls" => { "type" => BOOLEAN, "description" => "Does server require TLS?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "username" => { "type" => STRING, "description" => "Username to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "imap" => { "description" => "Mail session server", "access-constraints" => {"application" => {"mail-session" => {"type" => "mail"}}}, "attributes" => { "outbound-socket-binding-ref" => { "type" => STRING, "description" => "Outbound Socket binding to mail server", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "Password to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl" => { "type" => BOOLEAN, "description" => "Does server require SSL?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tls" => { "type" => BOOLEAN, "description" => "Does server require TLS?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "username" => { "type" => STRING, "description" => "Username to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "custom" => { "description" => "Custom mail server configuration", "model-description" => {"*" => { "description" => "Mail session server", "access-constraints" => {"application" => {"mail-session" => {"type" => "mail"}}}, "attributes" => { "outbound-socket-binding-ref" => { "type" => STRING, "description" => "Outbound Socket binding to mail server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "password" => { "type" => STRING, "description" => "Password to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "properties" => { "type" => OBJECT, "description" => "JavaMail properties", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "ssl" => { "type" => BOOLEAN, "description" => "Does server require SSL?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tls" => { "type" => BOOLEAN, "description" => "Does server require TLS?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"mail-server-security" => {"type" => "mail"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "username" => { "type" => STRING, "description" => "Username to authenticate on server", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "mail-server-security" => {"type" => "mail"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }, "sar" => { "description" => "The SAR subsystem allowing you to deploy sar archives containing MBeans configured by META-INF/jboss-service.xml", "capabilities" => [{ "name" => "org.wildfly.sar-deployment", "dynamic" => false }], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "resource-adapters" => { "description" => "Configuration of the resource adapters subsystem.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"resource-adapter" => { "description" => "The configuration of the resource adapters.", "model-description" => {"*" => { "description" => "The configuration of a resource adapter.", "access-constraints" => {"application" => {"resource-adapter" => {"type" => "resource-adapters"}}}, "attributes" => { "archive" => { "type" => STRING, "description" => "Specifies the resource adapter archive.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["module"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "beanvalidationgroups" => { "type" => LIST, "description" => "Specifies the bean validation groups that should be used.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "bootstrap-context" => { "type" => STRING, "description" => "Specifies the unique name of the bootstrap context that should be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "config-properties" => { "type" => STRING, "description" => "Custom defined config properties.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Specifies the module from which resource adapter will be loaded", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["archive"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transaction-support" => { "type" => STRING, "description" => "Specifies the transaction support level of the resource adapter.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "NoTransaction", "LocalTransaction", "XATransaction" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security" => { "type" => BOOLEAN, "description" => "Toggle on/off wm.security for this resource adapter. In case of false all wm-security-* parameters are ignored, even the defaults.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security-default-groups" => { "type" => LIST, "description" => "Defines a default groups list that should be added to the used Subject instance.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security-default-principal" => { "type" => STRING, "description" => "Defines a default principal name that should be added to the used Subject instance.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security-domain" => { "type" => STRING, "description" => "Defines the name of the security domain that should be used.", "expressions-allowed" => true, "nillable" => true, "default" => "other", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security-mapping-groups" => { "type" => LIST, "description" => "List of groups mappings.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "from" => { "type" => STRING, "description" => "Specify the original value in a mapping pair.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "to" => { "type" => STRING, "description" => "Specify the mapped value in a mapping pair.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security-mapping-required" => { "type" => BOOLEAN, "description" => "Defines if a mapping is required for security credentials.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wm-security-mapping-users" => { "type" => LIST, "description" => "List of user mappings.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "from" => { "type" => STRING, "description" => "Specify the original value in a mapping pair.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "to" => { "type" => STRING, "description" => "Specify the mapped value in a mapping pair.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "admin-objects" => { "description" => "The configuration of this resource adapter's admin objects.", "model-description" => {"*" => { "description" => "Specifies an administration object.", "access-constraints" => {"application" => {"resource-adapter" => {"type" => "resource-adapters"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "Specifies the fully qualified class name of an administration object.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the administration object should be enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the administration object.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the object into global JNDI.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"config-properties" => { "description" => "Custom defined config properties.", "model-description" => {"*" => { "description" => "A custom defined config property.", "access-constraints" => {"application" => {"resource-adapter" => {"type" => "resource-adapters"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "Custom defined config property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "config-properties" => { "description" => "Custom defined config properties.", "model-description" => {"*" => { "description" => "A custom defined config property.", "access-constraints" => {"application" => {"resource-adapter" => {"type" => "resource-adapters"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "Custom defined config property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "connection-definitions" => { "description" => "The configuration of this resource adapter's connection definitions.", "model-description" => {"*" => { "description" => "Specifies a connection definition.", "access-constraints" => {"application" => {"resource-adapter" => {"type" => "resource-adapters"}}}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart.", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time.", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for decrementing connections in the pool.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for incrementing connections in the pool.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "class-name" => { "type" => STRING, "description" => "Specifies the fully qualified class name of a managed connection factory or admin object.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the resource adapter should be enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enlistment" => { "type" => BOOLEAN, "description" => "Defines if lazy enlistment should be used if supported by the resource adapter.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flushed in case of an error. Valid values are: FailingConnectionOnly, IdleConnections, and EntirePool.", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "Specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "initial-pool-size" => { "type" => INT, "description" => "Specifies the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "interleaving" => { "type" => BOOLEAN, "description" => "An element to enable interleaving for XA connections.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the connection factory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-pool-size" => { "type" => INT, "description" => "Specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "min-pool-size" => { "type" => INT, "description" => "Specifies the minimum number of connections for a pool.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-recovery" => { "type" => BOOLEAN, "description" => "Specifies if the connection pool should be excluded from recovery.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-tx-separate-pool" => { "type" => BOOLEAN, "description" => "Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pad-xid" => { "type" => BOOLEAN, "description" => "Specifies whether the Xid should be padded.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool use should be fair.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Specifies if the pool should be prefilled. Changing this value requires a server restart.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strict.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-password" => { "type" => STRING, "description" => "The password used for recovery.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "resource-adapter-security" => {"type" => "resource-adapters"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the recovery plugin implementation.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the recovery plugin.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-security-domain" => { "type" => STRING, "description" => "The security domain used for recovery.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "resource-adapter-security" => {"type" => "resource-adapters"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "recovery-username" => { "type" => STRING, "description" => "The user name used for recovery.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "resource-adapter-security" => {"type" => "resource-adapters"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "same-rm-override" => { "type" => BOOLEAN, "description" => "Using this attribute, you can unconditionally set whether javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-application" => { "type" => BOOLEAN, "description" => "Indicates that application-supplied parameters, such as from getConnection(user, pw), are used to distinguish connections in the pool.", "expressions-allowed" => true, "nillable" => true, "default" => false, "alternatives" => [ "security-domain", "security-domain-and-application" ], "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "resource-adapter-security" => {"type" => "resource-adapters"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.", "expressions-allowed" => true, "nillable" => true, "alternatives" => [ "security-domain-and-application", "security-application" ], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "resource-adapter-security" => {"type" => "resource-adapters"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-domain-and-application" => { "type" => STRING, "description" => "Indicates that either application-supplied parameters, such as from getConnection(user, pw), or Subject (from security domain), are used to distinguish connections in the pool.", "expressions-allowed" => true, "nillable" => true, "alternatives" => [ "security-domain", "security-application" ], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "resource-adapter-security" => {"type" => "resource-adapters"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "sharable" => { "type" => BOOLEAN, "description" => "Enable the use of sharable connections, which allows lazy association to be enabled if supported.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false).", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the object into global JNDI.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "This specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "wrap-xa-resource" => { "type" => BOOLEAN, "description" => "Specifies whether XAResource instances should be wrapped in an org.jboss.tm.XAResourceWrapper instance.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "xa-resource-timeout" => { "type" => INT, "description" => "The value is passed to XAResource.setTransactionTimeout(), in seconds.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"config-properties" => { "description" => "Custom defined config properties.", "model-description" => {"*" => { "description" => "A custom defined config property.", "access-constraints" => {"application" => {"resource-adapter" => {"type" => "resource-adapters"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "Custom defined config property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } }} }} }, "jaxrs" => { "description" => "The configuration of the JAX-RS subsystem.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "ee" => { "description" => "The configuration of the EE subsystem.", "attributes" => { "annotation-property-replacement" => { "type" => BOOLEAN, "description" => "Flag indicating whether Java EE annotations will have property replacements applied", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "ear-subdeployments-isolated" => { "type" => BOOLEAN, "description" => "Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "global-modules" => { "type" => LIST, "description" => "A list of modules that should be made available to all deployments.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "name" => { "type" => STRING, "description" => "The name of the module", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "slot" => { "type" => STRING, "description" => "The module's slot", "expressions-allowed" => false, "nillable" => true, "default" => "main", "min-length" => 1L, "max-length" => 2147483647L }, "annotations" => { "type" => BOOLEAN, "description" => "If a pre-computed annotation index should be imported from META-INF/jandex.idx", "expressions-allowed" => true, "nillable" => true, "default" => false }, "services" => { "type" => BOOLEAN, "description" => "If any services exposed in META-INF/services should be made available to the deployments class loader", "expressions-allowed" => true, "nillable" => true, "default" => false }, "meta-inf" => { "type" => BOOLEAN, "description" => "If a modules META-INF directory should be made available to the deployments class loader", "expressions-allowed" => true, "nillable" => true, "default" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jboss-descriptor-property-replacement" => { "type" => BOOLEAN, "description" => "Flag indicating whether JBoss specific deployment descriptors will have property replacements applied", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "spec-descriptor-property-replacement" => { "type" => BOOLEAN, "description" => "Flag indicating whether descriptors defined by the Java EE specification will have property replacements applied", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "managed-scheduled-executor-service" => { "description" => "A managed scheduled executor service", "model-description" => {"*" => { "description" => "A managed scheduled executor service", "attributes" => { "context-service" => { "type" => STRING, "description" => "The name of the context service to be used by the scheduled executor.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "core-threads" => { "type" => INT, "description" => "The minimum number of threads to be used by the scheduled executor.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "hung-task-threshold" => { "type" => LONG, "description" => "The runtime, in milliseconds, for tasks to be considered hung by the scheduled executor. If 0 tasks are never considered hung.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "jndi-name" => { "type" => STRING, "description" => "The JNDI Name to lookup the managed scheduled executor service.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keepalive-time" => { "type" => LONG, "description" => "When the number of threads is greater than the core, this is the maximum time, in milliseconds, that excess idle threads will wait for new tasks before terminating.", "expressions-allowed" => true, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "long-running-tasks" => { "type" => BOOLEAN, "description" => "Flag which hints the duration of tasks executed by the scheduled executor.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "reject-policy" => { "type" => STRING, "description" => "The policy to be applied to aborted tasks.", "expressions-allowed" => true, "nillable" => true, "default" => "ABORT", "allowed" => [ "ABORT", "RETRY_ABORT" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-factory" => { "type" => STRING, "description" => "The name of the thread factory to be used by the scheduled executor.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "service" => { "description" => "Centrally configurable services that are part of the EE subsystem.", "model-description" => {"default-bindings" => { "description" => "The JNDI names for the default EE bindings", "attributes" => { "context-service" => { "type" => STRING, "description" => "The JNDI name where the default EE Context Service can be found", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "datasource" => { "type" => STRING, "description" => "The JNDI name where the default EE Datasource can be found", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "jms-connection-factory" => { "type" => STRING, "description" => "The JNDI name where the default EE JMS Connection Factory can be found", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "managed-executor-service" => { "type" => STRING, "description" => "The JNDI name where the default EE Managed Executor Service can be found", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "managed-scheduled-executor-service" => { "type" => STRING, "description" => "The JNDI name where the default EE Managed Scheduled Executor Service can be found", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "managed-thread-factory" => { "type" => STRING, "description" => "The JNDI name where the default EE Managed Thread Factory can be found", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "managed-thread-factory" => { "description" => "A managed thread factory", "model-description" => {"*" => { "description" => "A managed thread factory", "attributes" => { "context-service" => { "type" => STRING, "description" => "The name of the context service to be used by the managed thread factory", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "jndi-name" => { "type" => STRING, "description" => "The JNDI Name to lookup the managed thread factory.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "priority" => { "type" => INT, "description" => "The priority applied to threads created by the factory", "expressions-allowed" => true, "nillable" => true, "default" => 5, "min" => 1L, "max" => 10L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "context-service" => { "description" => "A context service", "model-description" => {"*" => { "description" => "A context service", "attributes" => { "jndi-name" => { "type" => STRING, "description" => "The JNDI Name to lookup the context service.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "use-transaction-setup-provider" => { "type" => BOOLEAN, "description" => "Flag which indicates if the transaction setup provider should be used", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "managed-executor-service" => { "description" => "A managed executor service", "model-description" => {"*" => { "description" => "A managed executor service", "attributes" => { "context-service" => { "type" => STRING, "description" => "The name of the context service to be used by the executor.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "core-threads" => { "type" => INT, "description" => "The minimum number of threads to be used by the executor. If left undefined the default core-size is calculated based on the number of processors. A value of zero is not advised and in some cases invalid. See the queue-length attribute for details on how this value is used to determine the queuing strategy.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "hung-task-threshold" => { "type" => LONG, "description" => "The runtime, in milliseconds, for tasks to be considered hung by the managed executor service. If value is 0 tasks are never considered hung.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "jndi-name" => { "type" => STRING, "description" => "The JNDI Name to lookup the managed executor service.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keepalive-time" => { "type" => LONG, "description" => "When the number of threads is greater than the core, this is the maximum time, in milliseconds, that excess idle threads will wait for new tasks before terminating.", "expressions-allowed" => true, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "long-running-tasks" => { "type" => BOOLEAN, "description" => "Flag which hints the duration of tasks executed by the executor.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum number of threads to be used by the executor. If left undefined the value from core-size will be used. This value is ignored if an unbounded queue is used (only core-threads will be used in that case).", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The executors task queue capacity. A length of 0 means direct hand-off and possible rejection will occur. An undefined length (the default), or Integer.MAX_VALUE, indicates that an unbounded queue should be used. All other values specify an exact queue size. If an unbounded queue or direct hand-off is used, a core-threads value greater than zero is required.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "reject-policy" => { "type" => STRING, "description" => "The policy to be applied to aborted tasks.", "expressions-allowed" => true, "nillable" => true, "default" => "ABORT", "allowed" => [ "ABORT", "RETRY_ABORT" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-factory" => { "type" => STRING, "description" => "The name of the thread factory to be used by the executor.", "expressions-allowed" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "remoting" => { "description" => "The configuration of the Remoting subsystem.", "capabilities" => [{ "name" => "org.wildfly.remoting.endpoint", "dynamic" => false }], "attributes" => { "worker-read-threads" => { "type" => INT, "description" => "The number of read threads to create for the remoting worker.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use IO subsystem worker configuration" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker-task-core-threads" => { "type" => INT, "description" => "The number of core threads for the remoting worker task thread pool.", "expressions-allowed" => true, "nillable" => true, "default" => 4, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use IO subsystem worker configuration" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker-task-keepalive" => { "type" => INT, "description" => "The number of milliseconds to keep non-core remoting worker task threads alive.", "expressions-allowed" => true, "nillable" => true, "default" => 60, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use IO subsystem worker configuration" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker-task-limit" => { "type" => INT, "description" => "The maximum number of remoting worker tasks to allow before rejecting.", "expressions-allowed" => true, "nillable" => true, "default" => 16384, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use IO subsystem worker configuration" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker-task-max-threads" => { "type" => INT, "description" => "The maximum number of threads for the remoting worker task thread pool.", "expressions-allowed" => true, "nillable" => true, "default" => 16, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use IO subsystem worker configuration" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker-write-threads" => { "type" => INT, "description" => "The number of write threads to create for the remoting worker.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use IO subsystem worker configuration" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "http-connector" => { "description" => "The remoting HTTP Upgrade connectors.", "model-description" => {"*" => { "description" => "The configuration of a HTTP Upgrade based Remoting connector.", "attributes" => { "authentication-provider" => { "type" => STRING, "description" => "The \"authentication-provider\" element contains the name of the authentication provider to use for incoming connections.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "connector-ref" => { "type" => STRING, "description" => "The name (or names) of a connector in the Undertow subsystem to connect to.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "sasl-protocol" => { "type" => STRING, "description" => "The protocol to pass into the SASL mechanisms used for authentication.", "expressions-allowed" => true, "nillable" => true, "default" => "remote", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "The associated security realm to use for authentication for this connector.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-realm-ref" => {"type" => "core"}, "remoting-security" => {"type" => "remoting"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-name" => { "type" => STRING, "description" => "The server name to send in the initial message exchange and for SASL based authentication.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "security" => { "description" => "Configuration of security for this connector.", "model-description" => {"sasl" => { "description" => "The \"sasl\" element contains the SASL authentication configuration for this connector.", "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "attributes" => { "include-mechanisms" => { "type" => LIST, "description" => "The optional nested \"include-mechanisms\" element contains a whitelist of allowed SASL mechanism names. No mechanisms will be allowed which are not present in this list.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "qop" => { "type" => LIST, "description" => "The optional nested \"qop\" element contains a list of quality-of-protection values, in decreasing order of preference.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reuse-session" => { "type" => BOOLEAN, "description" => "The optional nested \"reuse-session\" boolean element specifies whether or not the server should attempt to reuse previously authenticated session information. The mechanism may or may not support such reuse, and other factors may also prevent it.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-auth" => { "type" => BOOLEAN, "description" => "The optional nested \"server-auth\" boolean element specifies whether the server should authenticate to the client. Not all mechanisms may support this setting.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "strength" => { "type" => LIST, "description" => "The optional nested \"strength\" element contains a list of cipher strength values, in decreasing order of preference.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "sasl-policy" => { "description" => "Specifies an optional policy to use to narrow down the available set of mechanisms.", "model-description" => {"policy" => { "description" => "The policy configuration.", "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "attributes" => { "forward-secrecy" => { "type" => BOOLEAN, "description" => "The optional nested \"forward-secrecy\" element contains a boolean value which specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-active" => { "type" => BOOLEAN, "description" => "The optional nested \"no-active\" element contains a boolean value which specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-anonymous" => { "type" => BOOLEAN, "description" => "The optional nested \"no-anonymous\" element contains a boolean value which specifies whether mechanisms that accept anonymous login are permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-dictionary" => { "type" => BOOLEAN, "description" => "The optional nested \"no-dictionary\" element contains a boolean value which specifies whether mechanisms susceptible to passive dictionary attacks are permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-plain-text" => { "type" => BOOLEAN, "description" => "The optional nested \"no-plain-text\" element contains a boolean value which specifies whether mechanisms susceptible to simple plain passive attacks (e.g., \"PLAIN\") are not permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pass-credentials" => { "type" => BOOLEAN, "description" => "The optional nested \"pass-credentials\" element contains a boolean value which specifies whether mechanisms that pass client credentials are required.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "Properties to further configure sasl.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "property" => { "description" => "Properties to further configure the connector.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "outbound-connection" => { "description" => "Remoting outbound connections.", "model-description" => {"*" => { "description" => "Remoting outbound connection.", "capabilities" => [{ "name" => "org.wildfly.remoting.outbound-connection", "dynamic" => true }], "attributes" => {"uri" => { "type" => STRING, "description" => "The connection URI for the outbound connection.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "The XNIO Options that will be used during the connection creation.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "local-outbound-connection" => { "description" => "Remoting outbound connections for local:// URI scheme.", "model-description" => {"*" => { "description" => "Remoting outbound connection with an implicit local:// URI scheme.", "capabilities" => [{ "name" => "org.wildfly.remoting.outbound-connection", "dynamic" => true }], "attributes" => {"outbound-socket-binding-ref" => { "type" => STRING, "description" => "Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.", "expressions-allowed" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "The XNIO Options that will be used during the connection creation.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "connector" => { "description" => "The remoting connectors.", "model-description" => {"*" => { "description" => "The configuration of a Remoting connector.", "capabilities" => [{ "name" => "org.wildfly.remoting.connector", "dynamic" => true }], "attributes" => { "authentication-provider" => { "type" => STRING, "description" => "The \"authentication-provider\" element contains the name of the authentication provider to use for incoming connections.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "sasl-protocol" => { "type" => STRING, "description" => "The protocol to pass into the SASL mechanisms used for authentication.", "expressions-allowed" => true, "nillable" => true, "default" => "remote", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "The associated security realm to use for authentication for this connector.", "expressions-allowed" => false, "nillable" => true, "nil-significant" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-realm-ref" => {"type" => "core"}, "remoting-security" => {"type" => "remoting"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-name" => { "type" => STRING, "description" => "The server name to send in the initial message exchange and for SASL based authentication.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The name of the socket binding to attach to.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "security" => { "description" => "Configuration of security for this connector.", "model-description" => {"sasl" => { "description" => "The \"sasl\" element contains the SASL authentication configuration for this connector.", "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "attributes" => { "include-mechanisms" => { "type" => LIST, "description" => "The optional nested \"include-mechanisms\" element contains a whitelist of allowed SASL mechanism names. No mechanisms will be allowed which are not present in this list.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "qop" => { "type" => LIST, "description" => "The optional nested \"qop\" element contains a list of quality-of-protection values, in decreasing order of preference.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reuse-session" => { "type" => BOOLEAN, "description" => "The optional nested \"reuse-session\" boolean element specifies whether or not the server should attempt to reuse previously authenticated session information. The mechanism may or may not support such reuse, and other factors may also prevent it.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-auth" => { "type" => BOOLEAN, "description" => "The optional nested \"server-auth\" boolean element specifies whether the server should authenticate to the client. Not all mechanisms may support this setting.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "strength" => { "type" => LIST, "description" => "The optional nested \"strength\" element contains a list of cipher strength values, in decreasing order of preference.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "sasl-policy" => { "description" => "Specifies an optional policy to use to narrow down the available set of mechanisms.", "model-description" => {"policy" => { "description" => "The policy configuration.", "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "attributes" => { "forward-secrecy" => { "type" => BOOLEAN, "description" => "The optional nested \"forward-secrecy\" element contains a boolean value which specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-active" => { "type" => BOOLEAN, "description" => "The optional nested \"no-active\" element contains a boolean value which specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-anonymous" => { "type" => BOOLEAN, "description" => "The optional nested \"no-anonymous\" element contains a boolean value which specifies whether mechanisms that accept anonymous login are permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-dictionary" => { "type" => BOOLEAN, "description" => "The optional nested \"no-dictionary\" element contains a boolean value which specifies whether mechanisms susceptible to passive dictionary attacks are permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "no-plain-text" => { "type" => BOOLEAN, "description" => "The optional nested \"no-plain-text\" element contains a boolean value which specifies whether mechanisms susceptible to simple plain passive attacks (e.g., \"PLAIN\") are not permitted. \"false\" to permit, \"true\" to deny.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "pass-credentials" => { "type" => BOOLEAN, "description" => "The optional nested \"pass-credentials\" element contains a boolean value which specifies whether mechanisms that pass client credentials are required.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "Properties to further configure sasl.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "access-constraints" => {"sensitive" => {"remoting-security" => {"type" => "remoting"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "property" => { "description" => "Properties to further configure the connector.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "remote-outbound-connection" => { "description" => "Remoting outbound connections for remote:// URI scheme.", "model-description" => {"*" => { "description" => "Remoting outbound connection with an implicit remote:// URI scheme.", "capabilities" => [{ "name" => "org.wildfly.remoting.outbound-connection", "dynamic" => true }], "attributes" => { "outbound-socket-binding-ref" => { "type" => STRING, "description" => "Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.", "expressions-allowed" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "protocol" => { "type" => STRING, "description" => "The protocol to use for the remote connection. Defaults to remote+http.", "expressions-allowed" => true, "nillable" => true, "default" => "http-remoting", "allowed" => [ "remote", "remote+http", "http-remoting", "https-remoting", "remote+https" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "Reference to the security realm to use to obtain the password and SSL configuration.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-realm-ref" => {"type" => "core"}, "remoting-security" => {"type" => "remoting"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "username" => { "type" => STRING, "description" => "The user name to use when authenticating against the remote server.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "remoting-security" => {"type" => "remoting"} }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "The XNIO Options that will be used during the connection creation.", "model-description" => {"*" => { "description" => "Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.", "attributes" => {"value" => { "type" => STRING, "description" => "The property value.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "configuration" => { "description" => "Configuration options", "model-description" => {"endpoint" => { "description" => "Endpoint configuration", "attributes" => { "auth-realm" => { "type" => STRING, "description" => "The authentication realm to use if no authentication {@code CallbackHandler} is specified.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "authentication-retries" => { "type" => INT, "description" => "Specify the number of times a client is allowed to retry authentication before closing the connection.", "expressions-allowed" => true, "nillable" => true, "default" => 3, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "authorize-id" => { "type" => STRING, "description" => "The SASL authorization ID. Used as authentication user name to use if no authentication {@code CallbackHandler} is specifiedand the selected SASL mechanism demands a user name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-region-size" => { "type" => INT, "description" => "The size of allocated buffer regions.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "heartbeat-interval" => { "type" => INT, "description" => "The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound directionfor this amount of time, a ping message will be sent, which will trigger a corresponding reply message.", "expressions-allowed" => true, "nillable" => true, "default" => 2147483647, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-inbound-channels" => { "type" => INT, "description" => "The maximum number of concurrent inbound messages on a channel.", "expressions-allowed" => true, "nillable" => true, "default" => 40, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-inbound-message-size" => { "type" => LONG, "description" => "The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.", "expressions-allowed" => true, "nillable" => true, "default" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-inbound-messages" => { "type" => INT, "description" => "The maximum number of inbound channels to support for a connection.", "expressions-allowed" => true, "nillable" => true, "default" => 80, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-outbound-channels" => { "type" => INT, "description" => "The maximum number of concurrent outbound messages on a channel.", "expressions-allowed" => true, "nillable" => true, "default" => 40, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-outbound-message-size" => { "type" => LONG, "description" => "The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.", "expressions-allowed" => true, "nillable" => true, "default" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-outbound-messages" => { "type" => INT, "description" => "The maximum number of outbound channels to support for a connection.", "expressions-allowed" => true, "nillable" => true, "default" => 65535, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer-size" => { "type" => INT, "description" => "The size of the largest buffer that this endpoint will accept over a connection.", "expressions-allowed" => true, "nillable" => true, "default" => 8192, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-window-size" => { "type" => INT, "description" => "The maximum window size of the receive direction for connection channels, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 131072, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "sasl-protocol" => { "type" => STRING, "description" => "Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.", "expressions-allowed" => true, "nillable" => true, "default" => "remoting", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "send-buffer-size" => { "type" => INT, "description" => "The size of the largest buffer that this endpoint will transmit over a connection.", "expressions-allowed" => true, "nillable" => true, "default" => 8192, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-name" => { "type" => STRING, "description" => "The server side of the connection passes it's name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "transmit-window-size" => { "type" => INT, "description" => "The maximum window size of the transmit direction for connection channels, in bytes.", "expressions-allowed" => true, "nillable" => true, "default" => 131072, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker" => { "type" => STRING, "description" => "Worker to use", "expressions-allowed" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "jmx" => { "description" => "The configuration of the JMX subsystem.", "capabilities" => [{ "name" => "org.wildfly.management.jmx", "dynamic" => false }], "access-constraints" => {"sensitive" => {"jmx" => {"type" => "jmx"}}}, "attributes" => { "non-core-mbean-sensitivity" => { "type" => BOOLEAN, "description" => "Whether or not core MBeans, i.e. mbeans not coming from the model controller, should be considered sensitive.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "show-model" => { "type" => BOOLEAN, "description" => "Alias for the existence of the 'resolved' model controller jmx facade. When writing, if set to 'true' it will add the 'resolved' model controller jmx facade resource with the default domain name.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "configuration" => { "description" => "Configuration of the JMX audit logger.", "model-description" => {"audit-log" => { "description" => "The management audit logging top-level resource.", "access-constraints" => {"sensitive" => {"jmx" => {"type" => "jmx"}}}, "attributes" => { "enabled" => { "type" => BOOLEAN, "description" => "Whether audit logging is enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "log-boot" => { "type" => BOOLEAN, "description" => "Whether operations should be logged on server boot.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "log-read-only" => { "type" => BOOLEAN, "description" => "Whether operations that do not modify the configuration or any runtime services should be logged.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"handler" => { "description" => "A reference to a file or syslog audit log handler. The name of the handler is denoted by the value of the address.", "model-description" => {"*" => { "description" => "A reference to a file or syslog audit log handler. The name of the handler is denoted by the value of the address.", "access-constraints" => {"sensitive" => {"jmx" => {"type" => "jmx"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "remoting-connector" => { "description" => "JBoss remoting connectors for the JMX subsystem.", "model-description" => {"jmx" => { "description" => "A JBoss remoting connector for the JMX subsystem.", "capabilities" => [{ "name" => "org.wildfly.management.jmx.remote", "dynamic" => false }], "access-constraints" => {"sensitive" => {"jmx" => {"type" => "jmx"}}}, "attributes" => {"use-management-endpoint" => { "type" => BOOLEAN, "description" => "If true the connector will use the management endpoint, otherwise it will use the remoting subsystem one", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "expose-model" => { "description" => "Expose the model controller in the MBeanServer. The recommended is the 'expression' child.", "model-description" => { "resolved" => { "description" => "The configuration for exposing the 'resolved' model controller in the MBeanServer. This facade will expose all simple attributes and operation parameters as their type in the underlying model. Reads return the resolved expression if used, or the raw value. You may not use expressions when writing attributes and setting operation parameters.", "access-constraints" => {"sensitive" => {"jmx" => {"type" => "jmx"}}}, "attributes" => { "domain-name" => { "type" => STRING, "description" => "The domain name to use for the 'resolved' model controller JMX facade in the MBeanServer.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.as", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "proper-property-format" => { "type" => BOOLEAN, "description" => "If false, PROPERTY type attributes are represented as a DMR string, this is the legacy behaviour. If true, PROPERTY type attributes are represented by a composite type where the key is a string, and the value has the same type as the property in the underlying model.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "expression" => { "description" => "The configuration for exposing the 'expression' model controller in the MBeanServer. This facade will expose all simple attributes and operation parameters as String. Reads return the unresolved expression. You may use expressions when writing attributes and setting operation parameters.", "access-constraints" => {"sensitive" => {"jmx" => {"type" => "jmx"}}}, "attributes" => {"domain-name" => { "type" => STRING, "description" => "The domain name to use for the 'expression' model controller JMX facade in the MBeanServer.", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.as.expr", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} } } } } }, "singleton" => { "description" => "The configuration of the singleton subsystem", "capabilities" => [{ "name" => "org.wildfly.clustering.singleton.default-policy", "dynamic" => false }], "attributes" => {"default" => { "type" => STRING, "description" => "The default singleton policy", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.clustering.singleton.policy", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"singleton-policy" => { "description" => "A singleton policy", "model-description" => {"*" => { "description" => "A singleton policy", "capabilities" => [ { "name" => "org.wildfly.clustering.singleton.policy.builder", "dynamic" => true }, { "name" => "org.wildfly.clustering.singleton.policy.default-builder", "dynamic" => true }, { "name" => "org.wildfly.clustering.singleton.policy", "dynamic" => true } ], "attributes" => { "cache" => { "type" => STRING, "description" => "The cache backing the singleton policy's singleton service", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.clustering.cache.singleton-service-builder-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-container" => { "type" => STRING, "description" => "The cache container backing the singleton policy's singleton service", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.clustering.cache.default-singleton-service-builder-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "quorum" => { "type" => INT, "description" => "The minimum number of nodes required before this singleton service will start", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"election-policy" => { "description" => "The election policy of this singleton policy", "model-description" => { "random" => { "description" => "A random election policy", "capabilities" => [{ "name" => "org.wildfly.clustering.singleton.singleton-policy.election-policy.socket-binding-preference", "dynamic" => true }], "attributes" => { "name-preferences" => { "type" => LIST, "description" => "The list of preferred node names", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["socket-binding-preferences"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding-preferences" => { "type" => LIST, "description" => "The list of preferred node socket bindings", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["name-preferences"], "capability-reference" => "org.wildfly.network.outbound-socket-binding", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "simple" => { "description" => "A simple election policy", "capabilities" => [{ "name" => "org.wildfly.clustering.singleton.singleton-policy.election-policy.socket-binding-preference", "dynamic" => true }], "attributes" => { "name-preferences" => { "type" => LIST, "description" => "The list of preferred node names", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["socket-binding-preferences"], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "position" => { "type" => INT, "description" => "The position in the membership list from which the singleton master will be chosen", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding-preferences" => { "type" => LIST, "description" => "The list of preferred node socket bindings", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["name-preferences"], "capability-reference" => "org.wildfly.network.outbound-socket-binding", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} }} }} }, "security" => { "description" => "The configuration of the security subsystem.", "capabilities" => [{ "name" => "org.wildfly.security", "dynamic" => false }], "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "attributes" => {"deep-copy-subject-mode" => { "type" => BOOLEAN, "description" => "Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-constraints" => {"sensitive" => {"misc-security" => {"type" => "security"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => { "elytron-key-store" => { "description" => "The configuration of an Elytron-compatible key store that is exported from a legacy JSSE domain.", "model-description" => {"*" => { "description" => "The configuration of an Elytron-compatible key store that is exported from a legacy JSSE domain.", "capabilities" => [{ "name" => "org.wildfly.security.key-store", "dynamic" => true }], "attributes" => {"legacy-jsse-config" => { "type" => STRING, "description" => "The name of the legacy security domain that contains a JSSE configuration that can be used to export the key store.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "elytron-realm" => { "description" => "The configuration of an Elytron-compatible realm that delegates authentication decisions to a legacy security domain.", "model-description" => {"*" => { "description" => "The configuration of an Elytron-compatible realm that delegates authentication decisions to a legacy security domain.", "capabilities" => [{ "name" => "org.wildfly.security.security-realm", "dynamic" => true }], "attributes" => {"legacy-jaas-config" => { "type" => STRING, "description" => "The name of the legacy security domain to which authentication will be delegated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "security-domain" => { "description" => "Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.", "model-description" => {"*" => { "description" => "Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"cache-type" => { "type" => STRING, "description" => "Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "allowed" => [ "default", "infinispan" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => { "audit" => { "description" => "Auditing configuration. Configures a list of provider modules to be used.", "model-description" => {"classic" => { "description" => "Auditing configuration. Configures a list of provider modules to be used.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"provider-modules" => { "type" => LIST, "description" => "List of provider modules", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "This attribute is replaced with sub resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"provider-module" => { "description" => "Provider module", "model-description" => {"*" => { "description" => "List of modules that map principal, role, and credential information", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "authorization" => { "description" => "Authorization configuration. Configures a list of authorization policy modules to be used.", "model-description" => {"classic" => { "description" => "Authorization configuration. Configures a list of authorization policy modules to be used.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"policy-modules" => { "type" => LIST, "description" => "List of authorization modules", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "Use of this attribute is deprecated, use resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "flag" => { "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" => STRING, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ] }, "module" => { "type" => STRING, "nillable" => true, "description" => "Name of JBoss Module where the policy module code is located." }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"policy-module" => { "description" => "Policy module", "model-description" => {"*" => { "description" => "List of authentication modules", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flag" => { "type" => STRING, "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the login module is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "authentication" => { "description" => "\"Authentication configuration for this domain. Can either be classic or jaspi.", "model-description" => { "jaspi" => { "description" => "JASPI authentication configuration.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"auth-modules" => { "type" => LIST, "description" => "List of authentication modules to be used.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "Use of this attribute is deprecated, use resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "flag" => { "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" => STRING, "nillable" => true, "allowed" => [ "required", "requisite", "sufficient", "optional" ] }, "module" => { "type" => STRING, "nillable" => true, "description" => "Name of JBoss Module where the auth module code is located." }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true }, "login-module-stack-ref" => { "description" => "Reference to a login module stack name previously configured in the same security domain.", "type" => STRING, "nillable" => true, "min-length" => 1 } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => { "login-module-stack" => { "description" => "List of \"named\" login modules that are used by jaspi authentication modules.", "model-description" => {"*" => { "description" => "List of \"named\" login modules that are used by jaspi authentication modules.", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"login-modules" => { "type" => LIST, "description" => "List of authentication modules", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "This attribute is replaced with sub resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "flag" => { "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" => STRING, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ] }, "module" => { "type" => STRING, "nillable" => true, "description" => "Name of JBoss Module where the login module is located." }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"login-module" => { "description" => "Login module", "model-description" => {"*" => { "description" => "List of authentication modules", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flag" => { "type" => STRING, "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the login module is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "auth-module" => { "description" => "Auth module", "model-description" => {"*" => { "description" => "List of modules that map principal, role, and credential information", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flag" => { "type" => STRING, "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" => true, "nillable" => true, "allowed" => [ "required", "requisite", "sufficient", "optional" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "login-module-stack-ref" => { "type" => STRING, "description" => "Reference to a login module stack name previously configured in the same security domain.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the mapping module code is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "classic" => { "description" => "Traditional authentication configuration. Configures a list of login modules to be used.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"login-modules" => { "type" => LIST, "description" => "List of authentication modules", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "This attribute was replaced with sub resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "flag" => { "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" => STRING, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ] }, "module" => { "type" => STRING, "nillable" => true, "description" => "Name of JBoss Module where the login module code is located." }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"login-module" => { "description" => "Login module", "model-description" => {"*" => { "description" => "List of authentication modules", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flag" => { "type" => STRING, "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the login module is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} } } }, "jsse" => { "description" => "JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.", "model-description" => {"classic" => { "description" => "JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "additional-properties" => { "type" => OBJECT, "description" => "Additional properties that may be necessary to configure JSSE.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cipher-suites" => { "type" => STRING, "description" => "Comma separated list of cipher suites to enable on SSLSockets.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-alias" => { "type" => STRING, "description" => "Preferred alias to use when the KeyManager chooses the client alias.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-auth" => { "type" => BOOLEAN, "description" => "Boolean attribute to indicate if client's certificates should also be authenticated on the server side.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "key-manager" => { "type" => OBJECT, "description" => "JSEE Key Manager factory", "expressions-allowed" => false, "nillable" => true, "value-type" => { "algorithm" => { "type" => STRING, "description" => "Algorithm to use when creating the KeyManagerFactory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "provider" => { "type" => STRING, "description" => "Provider class name to use when creating the KeyManagerFactory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "keystore" => { "type" => OBJECT, "description" => "Configures a JSSE key store", "expressions-allowed" => false, "nillable" => true, "value-type" => { "password" => { "type" => STRING, "description" => "Sets the password of the keystore. Either this or 'truststore-password' must be present otherwise the security domain will be useless.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "Type of the keystore. If not set, type defaults to 'JKS'.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "url" => { "type" => STRING, "description" => "URL of the keystore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "provider" => { "type" => STRING, "description" => "Provider class name to use when creating the KeyStore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "provider-argument" => { "type" => STRING, "description" => "String argument to pass to the keystore Provider constructor when instantiating it.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "protocols" => { "type" => STRING, "description" => "Comma separated list of protocols to enable on SSLSockets.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-alias" => { "type" => STRING, "description" => "Preferred alias to use when the KeyManager chooses the server alias.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "service-auth-token" => { "type" => STRING, "description" => "Token to retrieve PrivateKeys from the KeyStore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "trust-manager" => { "type" => OBJECT, "description" => "JSEE Trust Manager factory", "expressions-allowed" => false, "nillable" => true, "value-type" => { "algorithm" => { "type" => STRING, "description" => "Algorithm to use when creating the TrustManagerFactory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "provider" => { "type" => STRING, "description" => "Provider class name to use when creating the TrustManagerFactory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "truststore" => { "type" => OBJECT, "description" => "Configures a JSSE trust store", "expressions-allowed" => false, "nillable" => true, "value-type" => { "password" => { "type" => STRING, "description" => "Sets the password of the truststore. Either this or 'keystore-password' must be present otherwise the security domain will be useless.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "type" => { "type" => STRING, "description" => "Type of the truststore. If not set, type defaults to 'JKS'.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "url" => { "type" => STRING, "description" => "URL of the truststore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "provider" => { "type" => STRING, "description" => "Provider class name to use when creating the truststore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "provider-argument" => { "type" => STRING, "description" => "String argument to pass to the truststore Provider constructor when instantiating it.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "mapping" => { "description" => "Mapping configuration. Configures a list of mapping modules to be used for principal, role, attribute and credential mapping.", "model-description" => {"classic" => { "description" => "Mapping configuration. Configures a list of mapping modules to be used for principal, role, attribute and credential mapping.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"mapping-modules" => { "type" => LIST, "description" => "List of modules that map principal, role, and credential information", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "Use of this attribute is deprecated, use resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "type" => { "description" => "Type of mapping this module performs. Allowed values are principal, role, attribute or credential..", "type" => STRING, "nillable" => false }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"mapping-module" => { "description" => "List of modules that map principal, role, and credential information", "model-description" => {"*" => { "description" => "List of modules that map principal, role, and credential information", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the mapping module code is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "type" => { "type" => STRING, "description" => "Type of mapping this module performs. Allowed values are principal, role, attribute or credential..", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "identity-trust" => { "description" => "Identity trust configuration. Configures a list of trust modules to be used.", "model-description" => {"classic" => { "description" => "Identity trust configuration. Configures a list of trust modules to be used.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"trust-modules" => { "type" => LIST, "description" => "List of trust modules", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "This attribute was replaced with sub resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "flag" => { "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" => STRING, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ] }, "module" => { "type" => STRING, "nillable" => true, "description" => "Name of JBoss Module where the identity trust module code is located." }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"trust-module" => { "description" => "Trust module", "model-description" => {"*" => { "description" => "List of authentication modules", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flag" => { "type" => STRING, "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the login module is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "acl" => { "description" => "Access control list configuration. Configures a list of ACL modules to be used.", "model-description" => {"classic" => { "description" => "Access control list configuration. Configures a list of ACL modules to be used.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => {"acl-modules" => { "type" => LIST, "description" => "List of acl modules", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "1.2.0", "reason" => "This attribute is replaced with sub resource" }, "value-type" => { "code" => { "description" => "Class name of the module to be instantiated.", "type" => STRING, "nillable" => false, "min-length" => 1 }, "flag" => { "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" => STRING, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ] }, "module" => { "type" => STRING, "nillable" => true, "description" => "Name of JBoss Module where the acl provider module code is located." }, "module-options" => { "description" => "List of module options containing a name/value pair.", "type" => OBJECT, "value-type" => STRING, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"acl-module" => { "description" => "ACL module", "model-description" => {"*" => { "description" => "List of authentication modules", "access-constraints" => { "sensitive" => {"security-domain" => {"type" => "core"}}, "application" => {"security-domain" => {"type" => "security"}} }, "attributes" => { "code" => { "type" => STRING, "description" => "Class name of the module to be instantiated.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "flag" => { "type" => STRING, "description" => "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "required", "requisite", "sufficient", "optional" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module" => { "type" => STRING, "description" => "Name of JBoss Module where the login module is located.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "module-options" => { "type" => OBJECT, "description" => "List of module options containing a name/value pair.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } }} }, "elytron-trust-manager" => { "description" => "The configuration of an Elytron-compatible trust manager that is exported from a legacy JSSE domain.", "model-description" => {"*" => { "description" => "The configuration of an Elytron-compatible trust manager that is exported from a legacy JSSE domain.", "capabilities" => [{ "name" => "org.wildfly.security.trust-managers", "dynamic" => true }], "attributes" => {"legacy-jsse-config" => { "type" => STRING, "description" => "The name of the legacy security domain that contains a JSSE configuration that can be used to export the trust manager.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "elytron-key-manager" => { "description" => "The configuration of an Elytron-compatible key manager that is exported from a legacy JSSE domain.", "model-description" => {"*" => { "description" => "The configuration of an Elytron-compatible key manager that is exported from a legacy JSSE domain.", "capabilities" => [{ "name" => "org.wildfly.security.key-managers", "dynamic" => true }], "attributes" => {"legacy-jsse-config" => { "type" => STRING, "description" => "The name of the legacy security domain that contains a JSSE configuration that can be used to export the key manager.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "vault" => { "description" => "Security Vault for attributes.", "model-description" => {"classic" => { "description" => "Security Vault for attributes.", "deprecated" => { "since" => "1.3.0", "reason" => "The Security subsystem is deprecated and may be removed, significantly revised, or limited to managed domain legacy server use in future versions." }, "attributes" => { "code" => { "type" => STRING, "description" => "Fully Qualified Name of the Security Vault Implementation.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "vault-options" => { "type" => OBJECT, "description" => "Security Vault options.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "elytron-trust-store" => { "description" => "The configuration of an Elytron-compatible trust store that is exported from a legacy JSSE domain.", "model-description" => {"*" => { "description" => "The configuration of an Elytron-compatible trust store that is exported from a legacy JSSE domain.", "capabilities" => [{ "name" => "org.wildfly.security.key-store", "dynamic" => true }], "attributes" => {"legacy-jsse-config" => { "type" => STRING, "description" => "The name of the legacy security domain that contains a JSSE configuration that can be used to export the trust store.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "weld" => { "description" => "The configuration of the weld subsystem.", "attributes" => { "development-mode" => { "type" => BOOLEAN, "description" => "Weld comes with a special mode for application development. When the development mode is enabled, certain built-in tools, which facilitate the development of CDI applications, are available. Setting this attribute to true activates the development mode.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "non-portable-mode" => { "type" => BOOLEAN, "description" => "If true then the non-portable mode is enabled. The non-portable mode is suggested by the specification to overcome problems with legacy applications that do not use CDI SPI properly and may be rejected by more strict validation in CDI 1.1.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "require-bean-descriptor" => { "type" => BOOLEAN, "description" => "If true then implicit bean archives without bean descriptor file (beans.xml) are ignored by Weld", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "jgroups" => { "description" => "The configuration of the JGroups subsystem.", "capabilities" => [ { "name" => "org.wildfly.clustering.default-group", "dynamic" => false }, { "name" => "org.wildfly.clustering.jgroups.default-channel", "dynamic" => false }, { "name" => "org.wildfly.clustering.jgroups.default-channel-module", "dynamic" => false }, { "name" => "org.wildfly.clustering.jgroups.default-channel-cluster", "dynamic" => false }, { "name" => "org.wildfly.clustering.jgroups.default-channel-factory", "dynamic" => false }, { "name" => "org.wildfly.clustering.default-command-dispatcher-factory", "dynamic" => false }, { "name" => "org.wildfly.clustering.jgroups.default-channel-source", "dynamic" => false }, { "name" => "org.wildfly.clustering.default-node-factory", "dynamic" => false } ], "attributes" => { "default-channel" => { "type" => STRING, "description" => "The default JGroups channel.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.clustering.jgroups.channel-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "default-stack" => { "type" => STRING, "description" => "The default JGroups protocol stack.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. This attribute will be removed in a future release." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "channel" => { "description" => "A JGroups channel.", "model-description" => {"*" => { "description" => "A JGroups channel.", "capabilities" => [ { "name" => "org.wildfly.clustering.jgroups.channel-module", "dynamic" => true }, { "name" => "org.wildfly.clustering.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel", "dynamic" => true }, { "name" => "org.wildfly.clustering.command-dispatcher-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel-source", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel-cluster", "dynamic" => true } ], "attributes" => { "address" => { "type" => STRING, "description" => "The IP address of the channel.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "address-as-uuid" => { "type" => STRING, "description" => "The address of the channel as a UUID.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "cluster" => { "type" => STRING, "description" => "The cluster name of the JGroups channel. If undefined, the name of the channel will be used.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "discard-own-messages" => { "type" => BOOLEAN, "description" => "If true, do not receive messages sent by this node (ourself).", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module from which to load channel services", "expressions-allowed" => true, "nillable" => true, "default" => "org.wildfly.clustering.server", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "num-tasks-in-timer" => { "type" => INT, "description" => "The current number of timer tasks.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "num-timer-threads" => { "type" => INT, "description" => "The number of timer threads.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "received-bytes" => { "type" => LONG, "description" => "The number of bytes received by this channel.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "received-messages" => { "type" => LONG, "description" => "The number of messages received by this channel.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "sent-bytes" => { "type" => LONG, "description" => "The number of bytes sent by this channel.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "sent-messages" => { "type" => LONG, "description" => "The number of messages sent by this channel.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "stack" => { "type" => STRING, "description" => "The protocol stack of the JGroups channel", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.clustering.jgroups.channel-factory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "state" => { "type" => STRING, "description" => "The state of the channel (OPEN, CONNECTING, CONNECTED, CLOSED).", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "If enabled, collect channel statistics.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stats-enabled" => { "type" => BOOLEAN, "description" => "If enabled, collect channel statistics.", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "4.1.0", "reason" => "Deprecated. Use statistics-enabled instead." }, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "version" => { "type" => STRING, "description" => "The JGroups software version.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "view" => { "type" => STRING, "description" => "The channel's view of group membership.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"fork" => { "description" => "A JGroups channel fork", "model-description" => {"*" => { "description" => "A JGroups channel fork", "capabilities" => [ { "name" => "org.wildfly.clustering.jgroups.channel-module", "dynamic" => true }, { "name" => "org.wildfly.clustering.node-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.group", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel", "dynamic" => true }, { "name" => "org.wildfly.clustering.command-dispatcher-factory", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel-source", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel-cluster", "dynamic" => true }, { "name" => "org.wildfly.clustering.jgroups.channel-factory", "dynamic" => true } ], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"protocol" => { "description" => "A JGroups channel fork protocol", "model-description" => {"*" => { "description" => "The configuration of a protocol within a protocol stack.", "capabilities" => [ { "name" => "org.wildfly.clustering.protocol.socket-binding", "dynamic" => true }, { "name" => "org.wildfly.clustering.protocol.data-source", "dynamic" => true } ], "attributes" => { "data-source" => { "type" => STRING, "description" => "Data source reference for JDBC_PING protocol to be used instead of connection and JNDI lookup properties.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module with which to resolve the protocol type.", "expressions-allowed" => true, "nillable" => true, "default" => "org.jgroups", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "The properties of this protocol.", "expressions-allowed" => true, "nillable" => true, "default" => {}, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "type" => { "type" => STRING, "description" => "The implementation class for a protocol, which determines protocol functionality.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Will be removed in a future version." }, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "A JGroups protocol property.", "model-description" => {"*" => { "description" => "A protocol property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Protocol properties are defined via the \"properties\" attribute of the parent resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of a protocol property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }} }} }, "stack" => { "description" => "The configuration of a JGroups protocol stack.", "model-description" => {"*" => { "description" => "The configuration of a JGroups protocol stack.", "capabilities" => [{ "name" => "org.wildfly.clustering.jgroups.channel-factory", "dynamic" => true }], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "relay" => { "description" => "A RELAY protocol", "model-description" => {"relay.RELAY2" => { "description" => "The configuration of a RELAY protocol", "attributes" => { "properties" => { "type" => OBJECT, "description" => "The properties of this protocol.", "expressions-allowed" => true, "nillable" => true, "default" => {}, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "site" => { "type" => STRING, "description" => "The name of the local site.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "remote-site" => { "description" => "A remote site to which to bridge.", "model-description" => {"*" => { "description" => "A remote site to which to bridge.", "capabilities" => [{ "name" => "org.wildfly.clustering.jgroups.stack.relay.site-channel-source", "dynamic" => true }], "attributes" => { "channel" => { "type" => STRING, "description" => "The name of the bridge channel used to communicate with this remote site.", "expressions-allowed" => true, "nillable" => false, "capability-reference" => "org.wildfly.clustering.jgroups.channel-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cluster" => { "type" => STRING, "description" => "The cluster name of the bridge channel to this remote site.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use an explicitly defined channel instead." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "stack" => { "type" => STRING, "description" => "The stack from which to create a bridge to this remote site.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Use an explicitly defined channel instead." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "property" => { "description" => "A JGroups protocol property.", "model-description" => {"*" => { "description" => "A protocol property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Protocol properties are defined via the \"properties\" attribute of the parent resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of a protocol property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "transport" => { "description" => "Optional OBJECT parameter specifying the transport for the stack.", "model-description" => {"*" => { "description" => "The configuration of a transport for a protocol stack.", "capabilities" => [ { "name" => "org.wildfly.clustering.transport.diagnostics-socket-binding", "dynamic" => true }, { "name" => "org.wildfly.clustering.protocol.socket-binding", "dynamic" => true }, { "name" => "org.wildfly.clustering.protocol.data-source", "dynamic" => true } ], "attributes" => { "data-source" => { "type" => STRING, "description" => "Data source reference for JDBC_PING protocol to be used instead of connection and JNDI lookup properties.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "default-executor" => { "type" => STRING, "description" => "The thread pool executor to handle incoming messages.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Supports EAP 6.x slaves." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "diagnostics-socket-binding" => { "type" => STRING, "description" => "The diagnostics socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "machine" => { "type" => STRING, "description" => "The machine (i.e. host) identifier for this node. Used by Infinispan topology-aware consistent hash.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module with which to resolve the protocol type.", "expressions-allowed" => true, "nillable" => true, "default" => "org.jgroups", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "oob-executor" => { "type" => STRING, "description" => "The thread pool executor to handle incoming out-of-band messages.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Supports EAP 6.x slaves." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "properties" => { "type" => OBJECT, "description" => "The properties of this protocol.", "expressions-allowed" => true, "nillable" => true, "default" => {}, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "rack" => { "type" => STRING, "description" => "The rack (i.e. server rack) identifier for this node. Used by Infinispan topology-aware consistent hash.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "shared" => { "type" => BOOLEAN, "description" => "If true, the underlying transport is shared by all channels using this stack.", "expressions-allowed" => true, "nillable" => true, "default" => false, "deprecated" => { "since" => "4.0.0", "reason" => "Deprecated. Transport sharing is now achieved by using fork channels." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "site" => { "type" => STRING, "description" => "The site (i.e. data centre) identifier for this node. Used by Infinispan topology-aware consistent hash.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "thread-factory" => { "type" => STRING, "description" => "The thread factory to use for handling asynchronous transport-specific tasks.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Supports EAP 6.x slaves." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "timer-executor" => { "type" => STRING, "description" => "The thread pool executor to handle protocol-related timing tasks.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Supports EAP 6.x slaves." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "thread-pool" => { "description" => "A thread pool executor", "model-description" => { "timer" => { "description" => "A thread pool executor", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 4, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 2, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 500, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "default" => { "description" => "A thread pool executor", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 300, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 20, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "internal" => { "description" => "A thread pool executor", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 4, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 2, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 100, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "oob" => { "description" => "A thread pool executor", "attributes" => { "keepalive-time" => { "type" => LONG, "description" => "Used to specify the amount of milliseconds that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "min" => 0L, "max" => 9223372036854775807L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 300, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "min-threads" => { "type" => INT, "description" => "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" => true, "nillable" => true, "default" => 20, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "queue-length" => { "type" => INT, "description" => "The queue length.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "property" => { "description" => "A JGroups protocol property.", "model-description" => {"*" => { "description" => "A protocol property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Protocol properties are defined via the \"properties\" attribute of the parent resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of a protocol property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "protocol" => { "description" => "A JGroups stack protocol layer.", "model-description" => {"*" => { "description" => "The configuration of a protocol within a protocol stack.", "capabilities" => [ { "name" => "org.wildfly.clustering.protocol.socket-binding", "dynamic" => true }, { "name" => "org.wildfly.clustering.protocol.data-source", "dynamic" => true } ], "attributes" => { "data-source" => { "type" => STRING, "description" => "Data source reference for JDBC_PING protocol to be used instead of connection and JNDI lookup properties.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "module" => { "type" => STRING, "description" => "The module with which to resolve the protocol type.", "expressions-allowed" => true, "nillable" => true, "default" => "org.jgroups", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "properties" => { "type" => OBJECT, "description" => "The properties of this protocol.", "expressions-allowed" => true, "nillable" => true, "default" => {}, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-binding" => { "type" => STRING, "description" => "The socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "type" => { "type" => STRING, "description" => "The implementation class for a protocol, which determines protocol functionality.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Will be removed in a future version." }, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "A JGroups protocol property.", "model-description" => {"*" => { "description" => "A protocol property with name and value.", "deprecated" => { "since" => "3.0.0", "reason" => "Deprecated. Protocol properties are defined via the \"properties\" attribute of the parent resource." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of a protocol property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } }} } } }, "bean-validation" => { "description" => "Bean Validation subsystem", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "jsf" => { "description" => "The JSF subsystem", "attributes" => {"default-jsf-impl-slot" => { "type" => STRING, "description" => "Default JSF implementation slot", "expressions-allowed" => true, "nillable" => true, "default" => "main", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "batch-jberet" => { "description" => "Batch Subsystem (JSR-352)", "capabilities" => [{ "name" => "org.wildfly.batch.configuration", "dynamic" => false }], "attributes" => { "restart-jobs-on-resume" => { "type" => BOOLEAN, "description" => "If set to true when a resume operation has be invoked after a suspend operation any jobs stopped during the suspend will be restarted. A value of false will leave the jobs in a stopped state.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-job-repository" => { "type" => STRING, "description" => "The name of the default job repository.", "attribute-group" => "environment", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.batch.job.repository", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-thread-pool" => { "type" => STRING, "description" => "The name of the default thread-pool.", "attribute-group" => "environment", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.batch.thread.pool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "in-memory-job-repository" => { "description" => "A job repository that stores job information in memory.", "model-description" => {"*" => { "description" => "A job repository that stores job information in memory.", "capabilities" => [{ "name" => "org.wildfly.batch.job.repository", "dynamic" => true }], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "thread-pool" => { "description" => "The thread pool used for batch jobs. Note that the max-thread attribute should always be greater than 3. Two threads are reserved to ensure partition jobs can execute.", "model-description" => {"*" => { "description" => "The thread pool used for batch jobs. Note that the max-thread attribute should always be greater than 3. Two threads are reserved to ensure partition jobs can execute.", "capabilities" => [{ "name" => "org.wildfly.batch.thread.pool", "dynamic" => true }], "attributes" => { "active-count" => { "type" => INT, "description" => "The approximate number of threads that are actively executing tasks.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "completed-task-count" => { "type" => INT, "description" => "The approximate total number of tasks that have completed execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "current-thread-count" => { "type" => INT, "description" => "The current number of threads in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "keepalive-time" => { "type" => OBJECT, "description" => "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "time" => { "type" => LONG, "description" => "The time", "expressions-allowed" => true, "nillable" => false }, "unit" => { "type" => STRING, "description" => "The time unit", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "largest-thread-count" => { "type" => INT, "description" => "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size. Note this should always be greater than 3. Two threads are reserved to ensure partition jobs can execute as expected.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the thread pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "queue-size" => { "type" => INT, "description" => "The queue size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-count" => { "type" => INT, "description" => "The number of tasks that have been rejected.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "task-count" => { "type" => INT, "description" => "The approximate total number of tasks that have ever been scheduled for execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-factory" => { "type" => STRING, "description" => "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "thread-factory" => { "description" => "The thread factory used for the thread-pool.", "model-description" => {"*" => { "description" => "A thread factory (implementing java.util.concurrent.ThreadFactory).", "attributes" => { "group-name" => { "type" => STRING, "description" => "Specifies the name of a thread group to create for this thread factory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the created thread factory.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "priority" => { "type" => INT, "description" => "May be used to specify the thread priority of created threads.", "expressions-allowed" => true, "nillable" => true, "min" => 1L, "max" => 10L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "thread-name-pattern" => { "type" => STRING, "description" => "The template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "jdbc-job-repository" => { "description" => "A job repository that stores job information in a database.", "model-description" => {"*" => { "description" => "A job repository that stores job information in a database.", "attributes" => {"data-source" => { "type" => STRING, "description" => "The data source name used to connect to the database.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.data-source", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "ejb3" => { "description" => "The configuration of the ejb3 subsystem.", "attributes" => { "allow-ejb-name-regex" => { "type" => BOOLEAN, "description" => "If this is true then regular expressions can be used in interceptor bindings to allow interceptors to be mapped to all beans that match the regular expression", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-clustered-sfsb-cache" => { "type" => STRING, "description" => "Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Not supported on current version servers; only allowed in managed domain profiles for use on servers running earlier versions." }, "access-type" => "read-only", "storage" => "configuration" }, "default-distinct-name" => { "type" => STRING, "description" => "The default distinct name that is applied to every EJB deployed on this server", "expressions-allowed" => true, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-entity-bean-instance-pool" => { "type" => STRING, "description" => "Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-entity-bean-optimistic-locking" => { "type" => BOOLEAN, "description" => "If set to true entity beans will use optimistic locking by default", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-mdb-instance-pool" => { "type" => STRING, "description" => "Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-missing-method-permissions-deny-access" => { "type" => BOOLEAN, "description" => "If this is set to true then methods on an EJB with a security domain specified or with other methods with security metadata will have an implicit @DenyAll unless other security metadata is present", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-resource-adapter-name" => { "type" => STRING, "description" => "Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level", "expressions-allowed" => true, "nillable" => true, "default" => "activemq-ra", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-security-domain" => { "type" => STRING, "description" => "The default security domain that will be used for EJBs if the bean doesn't explicitly specify one", "expressions-allowed" => true, "nillable" => true, "nil-significant" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"security-domain-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-sfsb-cache" => { "type" => STRING, "description" => "Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-sfsb-passivation-disabled-cache" => { "type" => STRING, "description" => "Name of the default stateful bean cache, which will be applicable to all stateful EJBs which have passivation disabled. Each deployment or EJB can optionally override this cache name.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-singleton-bean-access-timeout" => { "type" => LONG, "description" => "The default access timeout for singleton beans", "expressions-allowed" => true, "nillable" => true, "default" => 5000, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-slsb-instance-pool" => { "type" => STRING, "description" => "Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-stateful-bean-access-timeout" => { "type" => LONG, "description" => "The default access timeout for stateful beans", "expressions-allowed" => true, "nillable" => true, "default" => 5000, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disable-default-ejb-permissions" => { "type" => BOOLEAN, "description" => "This deprecated attribute has no effect and will be removed in a future release; it may never be set to a \"false\" value", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Adding default permissions to EJB deployments is no longer supported and this configuration attribute will be removed in a future release" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enable-statistics" => { "type" => BOOLEAN, "description" => "If set to true, enable the collection of invocation statistics.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "in-vm-remote-interface-invocation-pass-by-value" => { "type" => BOOLEAN, "description" => "If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "log-system-exceptions" => { "type" => BOOLEAN, "description" => "If this is true then all EJB system (not application) exceptions will be logged. The EJB spec mandates this behaviour, however it is not recommended as it will often result in exceptions being logged twice (once by the EJB and once by the calling code)", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "remoting-profile" => { "description" => "A remoting profile", "model-description" => {"*" => { "description" => "A remoting profile", "attributes" => { "exclude-local-receiver" => { "type" => BOOLEAN, "description" => "If set no local receiver is used in this profile", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "local-receiver-pass-by-value" => { "type" => BOOLEAN, "description" => "If set local receiver will pass ejb beans by value", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"remoting-ejb-receiver" => { "description" => "A remoting ejb receiver reference included in the profile", "model-description" => {"*" => { "description" => "A remoting ejb receiver reference included in the profile", "attributes" => { "connect-timeout" => { "type" => LONG, "description" => "Remoting ejb receiver connect timeout", "expressions-allowed" => true, "nillable" => true, "default" => 5000L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "outbound-connection-ref" => { "type" => STRING, "description" => "Name of outbound connection that will be used by the ejb receiver", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"channel-creation-options" => { "description" => "The options that will be used during the EJB remote channel creation", "model-description" => {"*" => { "description" => "The options that will be used during the EJB remote channel creation", "attributes" => { "type" => { "type" => STRING, "description" => "The type of the channel creation option", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "remoting", "xnio" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "value" => { "type" => STRING, "description" => "The value for the EJB remote channel creation option", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "mdb-delivery-group" => { "description" => "Delivery group to manage delivery for mdbs", "model-description" => {"*" => { "description" => "Delivery group to manage delivery for mdbs", "attributes" => {"active" => { "type" => BOOLEAN, "description" => "Indicates if delivery for all MDBs belonging to this group is active", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "application-security-domain" => { "description" => "A mapping from a security domain referenced in a deployed application", "model-description" => {"*" => { "description" => "A mapping from a security domain referenced in a deployed application", "capabilities" => [{ "name" => "org.wildfly.ejb3.application-security-domain", "dynamic" => true }], "attributes" => { "referencing-deployments" => { "type" => LIST, "description" => "The deployments currently referencing this mapping", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The Elytron security domain to be used by deployments that reference the mapped security domain", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.security.security-domain", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "thread-pool" => { "description" => "An EJB thread pool", "model-description" => {"*" => { "description" => "A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.", "attributes" => { "active-count" => { "type" => INT, "description" => "The approximate number of threads that are actively executing tasks.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "completed-task-count" => { "type" => INT, "description" => "The approximate total number of tasks that have completed execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "current-thread-count" => { "type" => INT, "description" => "The current number of threads in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "keepalive-time" => { "type" => OBJECT, "description" => "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "time" => { "type" => LONG, "description" => "The time", "expressions-allowed" => true, "nillable" => false }, "unit" => { "type" => STRING, "description" => "The time unit", "expressions-allowed" => true, "nillable" => false, "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "largest-thread-count" => { "type" => INT, "description" => "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-threads" => { "type" => INT, "description" => "The maximum thread pool size.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "name" => { "type" => STRING, "description" => "The name of the thread pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "queue-size" => { "type" => INT, "description" => "The queue size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-count" => { "type" => INT, "description" => "The number of tasks that have been rejected.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "task-count" => { "type" => INT, "description" => "The approximate total number of tasks that have ever been scheduled for execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-factory" => { "type" => STRING, "description" => "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => { "remote" => { "description" => "The EJB3 Remote Service", "attributes" => { "cluster" => { "type" => STRING, "description" => "The name of the clustered cache container which will be used to store/access the client-mappings of the EJB remoting connector's socket-binding on each node, in the cluster", "expressions-allowed" => true, "nillable" => true, "default" => "ejb", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connector-ref" => { "type" => STRING, "description" => "The name of the connector on which the EJB3 remoting channel is registered", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "execute-in-worker" => { "type" => BOOLEAN, "description" => "If this is true the EJB request will be executed in the IO subsystems worker, otherwise it will dispatch to the EJB thread pool", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "thread-pool-name" => { "type" => STRING, "description" => "The name of the thread pool that handles remote invocations", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"channel-creation-options" => { "description" => "The options that will be used during the EJB remote channel creation", "model-description" => {"*" => { "description" => "The options that will be used during the EJB remote channel creation", "attributes" => { "type" => { "type" => STRING, "description" => "The type of the channel creation option", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "remoting", "xnio" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "value" => { "type" => STRING, "description" => "The value for the EJB remote channel creation option", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "iiop" => { "description" => "The IIOP service", "attributes" => { "enable-by-default" => { "type" => BOOLEAN, "description" => "If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "use-qualified-name" => { "type" => BOOLEAN, "description" => "If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb)", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "timer-service" => { "description" => "The EJB timer service", "attributes" => { "default-data-store" => { "type" => STRING, "description" => "The default data store used for persistent timers", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "thread-pool-name" => { "type" => STRING, "description" => "The name of the thread pool used to run timer service invocations", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "database-data-store" => { "description" => "An database based store for persistent EJB timers.", "model-description" => {"*" => { "description" => "An database based store for persistent EJB timers.", "attributes" => { "allow-execution" => { "type" => BOOLEAN, "description" => "If this node is allowed to execute timers. If this is false then the timers will be added to the database, and another node may execute them. Note that depending on your refresh interval if you add timers with a very short delay they will not be executed until another node refreshes.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "database" => { "type" => STRING, "description" => "The type of database that is in use. SQL can be customised per database type.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "datasource-jndi-name" => { "type" => STRING, "description" => "The datasource that is used to persist the timers", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "partition" => { "type" => STRING, "description" => "The partition name. This should be set to a different value for every node that is sharing a database to prevent the same timer being loaded by multiple noded.", "expressions-allowed" => true, "nillable" => true, "default" => "default", "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "refresh-interval" => { "type" => INT, "description" => "Interval between refreshing the current timer set against the underlying database. A low value means timers get picked up more quickly, but increase load on the database.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "file-data-store" => { "description" => "A JVM local file store that stores persistent EJB timers", "model-description" => {"*" => { "description" => "A JVM local file store that stores persistent EJB timers", "attributes" => { "path" => { "type" => STRING, "description" => "The directory to store persistent timer information in", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The relative path that is used to resolve the timer data store location", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "identity" => { "description" => "Identity definition for security identity propagation", "capabilities" => [{ "name" => "org.wildfly.ejb3.identity", "dynamic" => false }], "attributes" => {"outflow-security-domains" => { "type" => LIST, "description" => "References to security domains to attempt to outflow any established identity to", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.security.security-domain", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "async" => { "description" => "The EJB3 Asynchronous Invocation Service", "attributes" => {"thread-pool-name" => { "type" => STRING, "description" => "The name of the thread pool which handles asynchronous invocations", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "cluster-passivation-store" => { "description" => "A clustered passivation store", "model-description" => {"*" => { "description" => "A clustered passivation store", "deprecated" => { "since" => "2.0.0", "reason" => "cluster-passivation-store has been superseded by passivation-store and will be removed in a future release" }, "attributes" => { "bean-cache" => { "type" => STRING, "description" => "The name of the cache used to store bean instances.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cache-container" => { "type" => STRING, "description" => "The name of the cache container used for the bean and client-mappings caches", "expressions-allowed" => true, "nillable" => true, "default" => "ejb", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "client-mappings-cache" => { "type" => STRING, "description" => "The name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings", "expressions-allowed" => true, "nillable" => true, "default" => "remote-connector-client-mappings", "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "This is no longer configurable and will be ignored" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout" => { "type" => LONG, "description" => "The timeout in units specified by idle-timeout-unit, after which a bean will passivate", "expressions-allowed" => true, "nillable" => true, "default" => 300, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout-unit" => { "type" => STRING, "description" => "The unit of idle-timeout", "expressions-allowed" => true, "nillable" => true, "default" => "SECONDS", "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated" => { "since" => "2.0.0", "reason" => "SFSBs are no longer passivated eagerly, but only lazily as required by max-size" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-size" => { "type" => INT, "description" => "The maximum number of beans this cache should store before forcing old beans to passivate", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "passivate-events-on-replicate" => { "type" => BOOLEAN, "description" => "Indicates whether replication should trigger passivation events on the bean", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "2.0.0", "reason" => "This is no longer configurable and will be ignored" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "file-passivation-store" => { "description" => "A file system based passivation store", "model-description" => {"*" => { "description" => "A file system based passivation store", "deprecated" => { "since" => "2.0.0", "reason" => "file-passivation-store has been superseded by passivation-store and will be removed in a future release" }, "attributes" => { "groups-path" => { "type" => STRING, "description" => "The subdirectory within the path specified by relative-to in which to store passivated bean groups", "expressions-allowed" => true, "nillable" => true, "default" => "ejb3/groups", "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Beans and bean groups are no longer stored in distinct directories" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout" => { "type" => LONG, "description" => "The timeout in units specified by idle-timeout-unit, after which a bean will passivate", "expressions-allowed" => true, "nillable" => true, "default" => 300, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "idle-timeout-unit" => { "type" => STRING, "description" => "The unit of idle-timeout", "expressions-allowed" => true, "nillable" => true, "default" => "SECONDS", "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated" => { "since" => "2.0.0", "reason" => "SFSBs are no longer passivated eagerly, but only lazily as required by max-size" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-size" => { "type" => INT, "description" => "The maximum number of beans this cache should store before forcing old beans to passivate", "expressions-allowed" => true, "nillable" => true, "default" => 100000, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "relative-to" => { "type" => STRING, "description" => "The root path used to store passivated beans", "expressions-allowed" => true, "nillable" => true, "default" => "jboss.server.data.dir", "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Use the relative-to attribute of the file-store of the relevant infinispan cache instead" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "sessions-path" => { "type" => STRING, "description" => "The subdirectory within the path specified by relative-to in which to store passivated beans", "expressions-allowed" => true, "nillable" => true, "default" => "ejb3/sessions", "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "Beans and bean groups are no longer stored in distinct directories" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "subdirectory-count" => { "type" => LONG, "description" => "Specifies the number of subdirectories into which stored state should be divided, used to minimize the number of files created per directory", "expressions-allowed" => true, "nillable" => true, "default" => 100, "min" => 1L, "max" => 2147483647L, "deprecated" => { "since" => "2.0.0", "reason" => "This is no longer configurable and will be ignored" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "strict-max-bean-instance-pool" => { "description" => "A bean instance pool with a strict upper limit", "model-description" => {"*" => { "description" => "A bean instance pool with a strict upper limit", "attributes" => { "derive-size" => { "type" => STRING, "description" => "Specifies if and what the max pool size should be derived from. A value of 'none', the default, indicates that the explicit value of max-pool-size should be used. A value of 'from-worker-pools' indicates that the max pool size should be derived from the size of the total threads for all worker pools configured on the system. A value of 'from-cpu-count' indicates that the max pool size should be derived from the total number of processors available on the system. Note that the computation isn't a 1:1 mapping, the values may or may not be augmented by other factors.", "expressions-allowed" => true, "nillable" => true, "default" => "none", "alternatives" => ["max-pool-size"], "allowed" => [ "none", "from-worker-pools", "from-cpu-count" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-pool-size" => { "type" => INT, "description" => "The maximum number of bean instances that the pool can hold at a given point in time", "expressions-allowed" => true, "nillable" => true, "default" => 20, "alternatives" => ["derive-size"], "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "timeout" => { "type" => LONG, "description" => "The maximum amount of time to wait for a bean instance to be available from the pool", "expressions-allowed" => true, "nillable" => true, "default" => 5L, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "timeout-unit" => { "type" => STRING, "description" => "The instance acquisition timeout unit", "expressions-allowed" => true, "nillable" => true, "default" => "MINUTES", "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "passivation-store" => { "description" => "A passivation store", "model-description" => {"*" => { "description" => "A passivation store", "attributes" => { "bean-cache" => { "type" => STRING, "description" => "The name of the cache used to store bean instances.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "cache-container" => { "type" => STRING, "description" => "The name of the cache container used for the bean and client-mappings caches", "expressions-allowed" => true, "nillable" => true, "default" => "ejb", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "max-size" => { "type" => INT, "description" => "The maximum number of beans this cache should store before forcing old beans to passivate", "expressions-allowed" => true, "nillable" => true, "default" => 10000, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "cache" => { "description" => "A SFSB cache", "model-description" => {"*" => { "description" => "A SFSB cache", "attributes" => { "aliases" => { "type" => LIST, "description" => "The aliases by which this cache may also be referenced", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "passivation-store" => { "type" => STRING, "description" => "The passivation store used by this cache", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "io" => { "description" => "IO subsystem", "capabilities" => [{ "name" => "org.wildfly.io.max-threads", "dynamic" => false }], "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "worker" => { "description" => "Defines workers", "model-description" => {"*" => { "description" => "Defines workers", "capabilities" => [{ "name" => "org.wildfly.io.worker", "dynamic" => true }], "attributes" => { "io-threads" => { "type" => INT, "description" => "Specify the number of I/O threads to create for the worker. If not specified, a default will be chosen, which is calculated by cpuCount * 2", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "stack-size" => { "type" => LONG, "description" => "The stack size (in bytes) to attempt to use for worker threads.", "expressions-allowed" => false, "nillable" => true, "default" => 0L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "task-keepalive" => { "type" => INT, "description" => "Specify the number of milliseconds to keep non-core task threads alive.", "expressions-allowed" => false, "nillable" => true, "default" => 60, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "task-max-threads" => { "type" => INT, "description" => "Specify the maximum number of threads for the worker task thread pool.If not set, default value used which is calculated by formula cpuCount * 16", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "buffer-pool" => { "description" => "Defines buffer pool", "model-description" => {"*" => { "description" => "Defines buffer pool", "capabilities" => [{ "name" => "org.wildfly.io.buffer-pool", "dynamic" => true }], "attributes" => { "buffer-size" => { "type" => INT, "description" => "The size of each buffer slice in bytes, if not set optimal value is calculated based on available RAM resources in your system.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffers-per-slice" => { "type" => INT, "description" => "How many buffers per slice, if not set optimal value is calculated based on available RAM resources in your system.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "direct-buffers" => { "type" => BOOLEAN, "description" => "Does the buffer pool use direct buffers, some platforms don't support direct buffers", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } } } }, "path" => { "description" => "A list of named filesystem paths.", "model-description" => {"*" => { "description" => "A named filesystem path.", "attributes" => { "name" => { "type" => STRING, "description" => "The name of the path. Cannot be one of the standard fixed paths provided by the system:
  • jboss.home - the root directory of the JBoss AS distribution
  • user.home - user's home directory
  • user.dir - user's current working directory
  • java.home - java installation directory
  • jboss.server.base.dir - root directory for an individual server instance
Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "path" => { "type" => STRING, "description" => "The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "filesystem-path" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "read-only" => { "type" => BOOLEAN, "description" => "True if added by the system, false if configured by user. If true, the path cannot be removed or modified.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:
  • jboss.home - the root directory of the JBoss AS distribution
  • user.home - user's home directory
  • user.dir - user's current working directory
  • java.home - java installation directory
  • jboss.server.base.dir - root directory for an individual server instance
  • jboss.server.data.dir - directory the server will use for persistent data file storage
  • jboss.server.log.dir - directory the server will use for log file storage
  • jboss.server.tmp.dir - directory the server will use for temporary file storage
  • jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances
", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "deployment-overlay" => { "description" => "A list of deployment overlays available for use by the server", "model-description" => {"*" => { "description" => "A deployment overlay", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "deployment" => { "description" => "The deployment that this deployment overlay is linked to", "model-description" => {"*" => { "description" => "The deployment that this deployment overlay is linked to", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "content" => { "description" => "The content of the deployment overlay", "model-description" => {"*" => { "description" => "The content of the deployment overlay", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "content" => { "type" => BYTES, "description" => "The deployment overlay content item", "expressions-allowed" => false, "nillable" => true, "min-length" => 20L, "max-length" => 20L, "access-type" => "read-only", "storage" => "configuration" }, "stream" => { "type" => STRING, "description" => "Provides the overlay content file a response attachment. The response result value is the unique id of the attachment.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "core-service" => { "description" => "Core services provided by the server.", "model-description" => { "platform-mbean" => { "description" => "Provides the management interface for monitoring and management of the Java virtual machine as well as the operating system on which the Java virtual machine is running. Exposes the JDK-provided JMX MBeans in the java.lang, java.nio and java.util.logging JMX domains.", "storage" => "runtime-only", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"type" => { "description" => "The platform MBeans, organized by the value of the 'type' property in the MBean's ObjectName.", "model-description" => { "memory" => { "description" => "The management interface for the memory system of the Java virtual machine.", "storage" => "runtime-only", "attributes" => { "heap-memory-usage" => { "type" => OBJECT, "description" => "The current memory usage of the heap that is used for object allocation.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "init" => { "type" => LONG, "description" => "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "used" => { "type" => LONG, "description" => "The amount of used memory in bytes.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "committed" => { "type" => LONG, "description" => "The amount of memory in bytes that is committed for the Java virtual machine to use.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "max" => { "type" => LONG, "description" => "The maximum amount of memory in bytes that can be used for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" } }, "access-type" => "metric", "storage" => "runtime" }, "non-heap-memory-usage" => { "type" => OBJECT, "description" => "The current memory usage of non-heap memory that is used by the Java virtual machine.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "init" => { "type" => LONG, "description" => "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "used" => { "type" => LONG, "description" => "The amount of used memory in bytes.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "committed" => { "type" => LONG, "description" => "The amount of memory in bytes that is committed for the Java virtual machine to use.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "max" => { "type" => LONG, "description" => "The maximum amount of memory in bytes that can be used for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" } }, "access-type" => "metric", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-pending-finalization-count" => { "type" => INT, "description" => "The approximate number of objects for which finalization is pending.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "verbose" => { "type" => BOOLEAN, "description" => "Whether verbose output for the memory system is enabled.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "operating-system" => { "description" => "The management interface for the operating system on which the Java virtual machine is running.", "storage" => "runtime-only", "attributes" => { "arch" => { "type" => STRING, "description" => "The operating system architecture. If a security manager is installed and it does not allow access to system property \"os.arch\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "available-processors" => { "type" => INT, "description" => "The number of processors available to the Java virtual machine.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The operating system name. If a security manager is installed and it does not allow access to system property \"os.name\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "system-load-average" => { "type" => DOUBLE, "description" => "The system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.", "expressions-allowed" => false, "nillable" => false, "unit" => "PERCENTAGE", "access-type" => "metric", "storage" => "runtime" }, "version" => { "type" => STRING, "description" => "The operating system version. If a security manager is installed and it does not allow access to system property \"os.version\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "compilation" => { "description" => "The management interface for the compilation system of the Java virtual machine", "storage" => "runtime-only", "attributes" => { "compilation-time-monitoring-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine supports the monitoring of compilation time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The name of the Just-in-time (JIT) compiler.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "total-compilation-time" => { "type" => LONG, "description" => "The approximate accumulated elapsed time (in milliseconds) spent in compilation. A Java virtual machine implementation may not support compilation time monitoring. If \"compilation-time-monitoring-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "buffer-pool" => { "description" => "The management interface for a buffer pool, for example a pool of direct or mapped buffers.", "storage" => "runtime-only", "attributes" => {"name" => { "type" => STRING, "description" => "The name representing this buffer pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {"name" => { "description" => "The name representing this buffer pool.", "model-description" => {"*" => { "description" => "The management interface for a buffer pool, for example a pool of direct or mapped buffers.", "storage" => "runtime-only", "attributes" => { "count" => { "type" => LONG, "description" => "An estimate of the number of buffers in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "memory-used" => { "type" => LONG, "description" => "An estimate of the memory that the Java virtual machine is using for this buffer pool in bytes, or -1 if an estimate of the memory usage is not available.", "expressions-allowed" => false, "nillable" => false, "unit" => "BYTES", "access-type" => "metric", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The name representing this buffer pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "total-capacity" => { "type" => LONG, "description" => "An estimate of the total capacity of the buffers in this pool. A buffer's capacity is the number of elements it contains and the value of this attribute is an estimate of the total capacity of buffers in the pool in bytes.", "expressions-allowed" => false, "nillable" => false, "unit" => "BYTES", "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "class-loading" => { "description" => "The management interface for the class loading system of the Java virtual machine.", "storage" => "runtime-only", "attributes" => { "loaded-class-count" => { "type" => INT, "description" => "The number of classes that are currently loaded in the Java virtual machine.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "total-loaded-class-count" => { "type" => LONG, "description" => "The total number of classes that have been loaded since the Java virtual machine has started execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "unloaded-class-count" => { "type" => LONG, "description" => "The total number of classes unloaded since the Java virtual machine has started execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "verbose" => { "type" => BOOLEAN, "description" => "Whether the verbose output for the class loading system is enabled.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "runtime" => { "description" => "The management interface for the runtime system of the Java virtual machine.", "storage" => "runtime-only", "attributes" => { "boot-class-path" => { "type" => STRING, "description" => "The boot class path that is used by the bootstrap class loader to search for class files. If attribute \"boot-class-path-supported\" is \"false\" or if a security manager is installed and the caller does not have ManagementPermission(\"monitor\"), then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"jvm" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "boot-class-path-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine supports the boot class path mechanism used by the bootstrap class loader to search for class files.", "expressions-allowed" => false, "nillable" => false, "access-constraints" => {"sensitive" => {"jvm" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "class-path" => { "type" => STRING, "description" => "The Java class path that is used by the system class loader to search for class files. If a security manager is installed and it does not allow access to system property \"java.class.path\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"jvm" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "input-arguments" => { "type" => LIST, "description" => "The input arguments passed to the Java virtual machine which does not include the arguments to the main method. If a security manager is installed and the caller does not have ManagementPermission(\"monitor\"), then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "access-constraints" => {"sensitive" => {"jvm" => {"type" => "core"}}}, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "library-path" => { "type" => STRING, "description" => "The Java library path. If a security manager is installed and it does not allow access to system property \"java.library.path\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"jvm" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "management-spec-version" => { "type" => STRING, "description" => "The version of the specification for the management interface implemented by the running Java virtual machine.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The name representing the running Java virtual machine.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "spec-name" => { "type" => STRING, "description" => "The Java virtual machine specification name. If a security manager is installed and it does not allow access to system property \"java.vm.specification.name\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "spec-vendor" => { "type" => STRING, "description" => "The Java virtual machine specification vendor. If a security manager is installed and it does not allow access to system property \"java.vm.specification.vendor\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "spec-version" => { "type" => STRING, "description" => "The Java virtual machine specification version. If a security manager is installed and it does not allow access to system property \"java.vm.specification.version\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "start-time" => { "type" => LONG, "description" => "The start time of the Java virtual machine in milliseconds.", "expressions-allowed" => false, "nillable" => false, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "system-properties" => { "type" => OBJECT, "description" => "A map of names and values of all system properties. If a security manager is installed and its \"checkPropertiesAccess\" method does not allow access to system properties, then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "access-constraints" => {"sensitive" => {"system-property" => {"type" => "core"}}}, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "uptime" => { "type" => LONG, "description" => "The uptime of the Java virtual machine in milliseconds.", "expressions-allowed" => false, "nillable" => false, "unit" => "MILLISECONDS", "access-type" => "metric", "storage" => "runtime" }, "vm-name" => { "type" => STRING, "description" => "The Java virtual machine implementation name. If a security manager is installed and it does not allow access to system property \"java.vm.name\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "vm-vendor" => { "type" => STRING, "description" => "The Java virtual machine implementation vendor. If a security manager is installed and it does not allow access to system property \"java.vm.vendor\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "vm-version" => { "type" => STRING, "description" => "The Java virtual machine implementation version. If a security manager is installed and it does not allow access to system property \"java.vm.version\", then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "threading" => { "description" => "The management interface for the thread system of the Java virtual machine.", "storage" => "runtime-only", "attributes" => { "all-thread-ids" => { "type" => LIST, "description" => "All live thread IDs. If a security manager is installed and the caller does not have ManagementPermission(\"monitor\"), then a \"read-attribute\" operation reading this attribute will fail, and the value for this attribute in the result for the \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => false, "value-type" => LONG, "access-type" => "read-only", "storage" => "runtime" }, "current-thread-cpu-time" => { "type" => LONG, "description" => "The total CPU time for the current thread in nanoseconds, or -1 if \"thread-cpu-time-enabled\" is \"false\". A Java virtual machine implementation may not support CPU time measurement. If \"thread-cpu-time-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => false, "unit" => "NANOSECONDS", "access-type" => "metric", "storage" => "runtime" }, "current-thread-cpu-time-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine supports CPU time measurement for the current thread.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "current-thread-user-time" => { "type" => LONG, "description" => "The CPU time that the current thread has executed in user mode in nanoseconds, or -1 if \"thread-cpu-time-enabled\" is \"false\". A Java virtual machine implementation may not support CPU time measurement. If \"thread-cpu-time-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => false, "unit" => "NANOSECONDS", "access-type" => "metric", "storage" => "runtime" }, "daemon-thread-count" => { "type" => INT, "description" => "The current number of live daemon threads.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "object-monitor-usage-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine supports monitoring of object monitor usage.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "peak-thread-count" => { "type" => INT, "description" => "The peak live thread count since the Java virtual machine started or peak was reset.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "synchronizer-usage-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine supports monitoring of ownable synchronizer usage.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "thread-contention-monitoring-enabled" => { "type" => BOOLEAN, "description" => "Whether thread contention monitoring is enabled.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "thread-contention-monitoring-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine supports thread contention monitoring.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "thread-count" => { "type" => INT, "description" => "The current number of live threads including both daemon and non-daemon threads.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "thread-cpu-time-enabled" => { "type" => BOOLEAN, "description" => "Whether thread CPU time measurement is enabled.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "thread-cpu-time-supported" => { "type" => BOOLEAN, "description" => "Whether the Java virtual machine implementation supports CPU time measurement for any thread.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "total-started-thread-count" => { "type" => LONG, "description" => "The total number of threads created and also started since the Java virtual machine started.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "memory-manager" => { "description" => "The management interface for a memory manager. A memory manager manages one or more memory pools of the Java virtual machine.", "storage" => "runtime-only", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"name" => { "description" => "The name representing this memory manager.", "model-description" => {"*" => { "description" => "The management interface for a memory manager. A memory manager manages one or more memory pools of the Java virtual machine.", "storage" => "runtime-only", "attributes" => { "memory-pool-names" => { "type" => LIST, "description" => "The names of the memory pools that this memory manager manages.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "metric", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The name representing this memory manager.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "metric", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "valid" => { "type" => BOOLEAN, "description" => "Whether this memory manager is valid in the Java virtual machine.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "memory-pool" => { "description" => "The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.", "storage" => "runtime-only", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"name" => { "description" => "The name representing this memory pool.", "model-description" => {"*" => { "description" => "The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.", "storage" => "runtime-only", "attributes" => { "collection-usage" => { "type" => OBJECT, "description" => "The memory usage after the Java virtual machine most recently expended effort in recycling unused objects in this memory pool, or \"undefined\" if this attribute is not supported.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "init" => { "type" => LONG, "description" => "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "used" => { "type" => LONG, "description" => "The amount of used memory in bytes.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "committed" => { "type" => LONG, "description" => "The amount of memory in bytes that is committed for the Java virtual machine to use.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "max" => { "type" => LONG, "description" => "The maximum amount of memory in bytes that can be used for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" } }, "access-type" => "metric", "storage" => "runtime" }, "collection-usage-threshold" => { "type" => LONG, "description" => "The collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If \"collection-usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES", "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "collection-usage-threshold-count" => { "type" => LONG, "description" => "The number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If \"collection-usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "collection-usage-threshold-exceeded" => { "type" => BOOLEAN, "description" => "Whether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If \"collection-usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "collection-usage-threshold-supported" => { "type" => BOOLEAN, "description" => "Whether this memory pool supports a collection usage threshold.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "memory-manager-names" => { "type" => LIST, "description" => "The names of the memory managers that manage this memory pool.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The name representing this memory pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "peak-usage" => { "type" => OBJECT, "description" => "The peak memory usage of this memory pool since the Java virtual machine was started or since the peak was reset. May be \"undefined\" if attribute \"valid\" is \"false\".", "expressions-allowed" => false, "nillable" => false, "value-type" => { "init" => { "type" => LONG, "description" => "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "used" => { "type" => LONG, "description" => "The amount of used memory in bytes.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "committed" => { "type" => LONG, "description" => "The amount of memory in bytes that is committed for the Java virtual machine to use.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "max" => { "type" => LONG, "description" => "The maximum amount of memory in bytes that can be used for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" } }, "access-type" => "metric", "storage" => "runtime" }, "type" => { "type" => STRING, "description" => "The type of this memory pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "usage" => { "type" => OBJECT, "description" => "An estimate of the memory usage of this memory pool. May be \"undefined\" if attribute \"valid\" is \"false\".", "expressions-allowed" => false, "nillable" => false, "value-type" => { "init" => { "type" => LONG, "description" => "The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "used" => { "type" => LONG, "description" => "The amount of used memory in bytes.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "committed" => { "type" => LONG, "description" => "The amount of memory in bytes that is committed for the Java virtual machine to use.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" }, "max" => { "type" => LONG, "description" => "The maximum amount of memory in bytes that can be used for memory management.", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES" } }, "access-type" => "metric", "storage" => "runtime" }, "usage-threshold" => { "type" => LONG, "description" => "The usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If \"usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "unit" => "BYTES", "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "usage-threshold-count" => { "type" => LONG, "description" => "The number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If \"usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "usage-threshold-exceeded" => { "type" => BOOLEAN, "description" => "Whether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If \"usage-threshold-supported\", is \"false\" trying to read this attribute via the \"read-attribute\" operation will result in failure, and the value of this attribute in the result of a \"read-resource\" operation will be \"undefined\".", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "usage-threshold-supported" => { "type" => BOOLEAN, "description" => "Whether this memory pool supports usage threshold.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "valid" => { "type" => BOOLEAN, "description" => "Whether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "garbage-collector" => { "description" => "Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.", "storage" => "runtime-only", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"name" => { "description" => "The GarbageCollectorMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.", "model-description" => {"*" => { "description" => "The management interface for one of the garbage collectors in the Java virtual machine.", "storage" => "runtime-only", "attributes" => { "collection-count" => { "type" => LONG, "description" => "The total number of collections that have occurred.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "collection-time" => { "type" => LONG, "description" => "The approximate accumulated collection elapsed time in milliseconds.", "expressions-allowed" => false, "nillable" => false, "unit" => "MILLISECONDS", "access-type" => "metric", "storage" => "runtime" }, "memory-pool-names" => { "type" => LIST, "description" => "The name of memory pools that this garbage collector manages.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "The name representing this garbage collector.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "object-name" => { "type" => STRING, "description" => "String representation the object name of this platform managed object.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "valid" => { "type" => BOOLEAN, "description" => "Whether this this memory manager is valid in the Java virtual machine.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} } } }} }, "capability-registry" => { "description" => "Capability registry", "storage" => "runtime-only", "attributes" => { "capabilities" => { "type" => LIST, "description" => "List of available runtime capabilities", "expressions-allowed" => false, "nillable" => false, "value-type" => { "name" => { "type" => STRING, "description" => "Name of capability", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "dynamic" => { "type" => BOOLEAN, "description" => "Is capability dynamically registered", "expressions-allowed" => false, "nillable" => false }, "scope" => { "type" => STRING, "description" => "Scope of the capability", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "registration-points" => { "type" => LIST, "description" => "List of registration points", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING } }, "access-type" => "read-only", "storage" => "configuration" }, "possible-capabilities" => { "type" => LIST, "description" => "List of possible capabilites and where in model are they registered", "expressions-allowed" => false, "nillable" => false, "value-type" => { "name" => { "type" => STRING, "description" => "Name of capability", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "dynamic" => { "type" => BOOLEAN, "description" => "Is capability dynamically registered", "expressions-allowed" => false, "nillable" => false }, "registration-points" => { "type" => LIST, "description" => "List of registration points", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING } }, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "patching" => { "description" => "patch", "access-constraints" => {"sensitive" => {"patching" => {"type" => "core"}}}, "attributes" => { "cumulative-patch-id" => { "type" => STRING, "description" => "Cumulative patch id.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "patches" => { "type" => LIST, "description" => "A list of actively installed patches.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "version" => { "type" => STRING, "description" => "Current patch version.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "layer" => { "description" => "layer", "model-description" => {"*" => { "description" => "layer", "access-constraints" => {"sensitive" => {"patching" => {"type" => "core"}}}, "attributes" => { "cumulative-patch-id" => { "type" => STRING, "description" => "Cumulative patch id.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "patches" => { "type" => LIST, "description" => "A list of actively installed patches.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "addon" => { "description" => "add-on", "model-description" => {"*" => { "description" => "add-on", "access-constraints" => {"sensitive" => {"patching" => {"type" => "core"}}}, "attributes" => { "cumulative-patch-id" => { "type" => STRING, "description" => "Cumulative patch id.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "patches" => { "type" => LIST, "description" => "A list of actively installed patches.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "patch-stream" => { "description" => "patch-stream", "model-description" => {"*" => { "description" => "patch-stream", "access-constraints" => {"sensitive" => {"patching" => {"type" => "core"}}}, "attributes" => { "cumulative-patch-id" => { "type" => STRING, "description" => "Cumulative patch id.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "patches" => { "type" => LIST, "description" => "A list of actively installed patches.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "version" => { "type" => STRING, "description" => "Current patch version.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "layer" => { "description" => "layer", "model-description" => {"*" => { "description" => "layer", "access-constraints" => {"sensitive" => {"patching" => {"type" => "core"}}}, "attributes" => { "cumulative-patch-id" => { "type" => STRING, "description" => "Cumulative patch id.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "patches" => { "type" => LIST, "description" => "A list of actively installed patches.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "addon" => { "description" => "add-on", "model-description" => {"*" => { "description" => "add-on", "access-constraints" => {"sensitive" => {"patching" => {"type" => "core"}}}, "attributes" => { "cumulative-patch-id" => { "type" => STRING, "description" => "Cumulative patch id.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "patches" => { "type" => LIST, "description" => "A list of actively installed patches.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} } } }, "vault" => { "description" => "Security Vault for attributes.", "deprecated" => { "since" => "1.7.0", "reason" => "The vault configuration resource is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-vault" => {"type" => "core"}}}, "attributes" => { "code" => { "type" => STRING, "description" => "Fully Qualified Name of the Security Vault Implementation.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "module" => { "type" => STRING, "description" => "The name of the module to load up the vault implementation from.", "expressions-allowed" => true, "nillable" => true, "requires" => ["code"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "vault-options" => { "type" => OBJECT, "description" => "Security Vault options.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "management" => { "description" => "The management services used to control a server or a host's host controller.", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "service" => { "description" => "Management services.", "model-description" => { "configuration-changes" => { "description" => "Service to store and list configuration changes.", "attributes" => {"max-history" => { "type" => INT, "description" => "The maximum number of configuration changes stored in history.", "expressions-allowed" => false, "nillable" => true, "default" => 10, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "management-operations" => { "description" => "Execution of management operations.", "storage" => "runtime-only", "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"active-operation" => { "description" => "A currently executing operation.", "model-description" => {"*" => { "description" => "A currently executing operation.", "storage" => "runtime-only", "attributes" => { "access-mechanism" => { "type" => STRING, "description" => "The mechanism used to submit a request to the server.", "expressions-allowed" => false, "nillable" => true, "allowed" => [ "NATIVE", "HTTP", "JMX" ], "access-type" => "read-only", "storage" => "configuration" }, "address" => { "type" => LIST, "description" => "The address of the resource targeted by the operation. The value in the final element of the address will be '' if the caller is not authorized to address the operation's target resource.", "expressions-allowed" => false, "nillable" => false, "value-type" => PROPERTY, "access-type" => "read-only", "storage" => "configuration" }, "caller-thread" => { "type" => STRING, "description" => "The name of the thread that is executing the operation.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "cancelled" => { "type" => BOOLEAN, "description" => "Whether the operation has been cancelled.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "configuration" }, "domain-rollout" => { "type" => BOOLEAN, "description" => "True if the operation is a subsidiary request on a domain process other than the one directly handling the original operation, executing locally as part of the rollout of the original operation across the domain.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "configuration" }, "domain-uuid" => { "type" => STRING, "description" => "Identifier of an overall multi-process domain operation of which this operation is a part, or undefined is this operation is not associated with such a domain operation.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "exclusive-running-time" => { "type" => LONG, "description" => "Amount of time the operation has been executing with the exclusive operation execution lock held, or -1 if the operation does not hold the exclusive execution lock.", "expressions-allowed" => false, "nillable" => false, "unit" => "NANOSECONDS", "access-type" => "read-only", "storage" => "configuration" }, "execution-status" => { "type" => STRING, "description" => "The current activity of the operation.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "executing", "awaiting-other-operation", "awaiting-stability", "completing", "rolling-back" ], "access-type" => "read-only", "storage" => "configuration" }, "operation" => { "type" => STRING, "description" => "The name of the operation, or '' if the caller is not authorized to address the operation's target resource.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "running-time" => { "type" => LONG, "description" => "Amount of time the operation has been executing.", "expressions-allowed" => false, "nillable" => false, "unit" => "NANOSECONDS", "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} } } }, "security-realm" => { "description" => "A security realm that can be associated with a management interface and used to control access to the management services.", "model-description" => {"*" => { "description" => "A security realm that can be associated with a management interface and used to control access to the management services.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"map-groups-to-roles" => { "type" => BOOLEAN, "description" => "After a users group membership has been loaded should a 1:1 relationship be assumed regarding group to role mapping.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => { "authentication" => { "description" => "Configuration of the server side authentication mechanisms. Optionally one truststore can be defined and one username/password based store can be defined. Authentication will first attempt to use the truststore and if this is not available will fall back to the username/password authentication. If none of these are specified the only available mechanism will be the local mechanism for the Native interface and the HTTP interface will not be accessible.", "model-description" => { "kerberos" => { "description" => "Configuration to use Kerberos to authenticate the users.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"remove-realm" => { "type" => BOOLEAN, "description" => "After authentication should the realm name be stripped from the users name.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "ldap" => { "description" => "Configuration to use LDAP as the user repository.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "advanced-filter" => { "type" => STRING, "description" => "The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.", "expressions-allowed" => true, "nillable" => false, "alternatives" => ["username-attribute"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "allow-empty-passwords" => { "type" => BOOLEAN, "description" => "Should empty passwords be accepted from the user being authenticated.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "base-dn" => { "type" => STRING, "description" => "The base distinguished name to commence the search for the user.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "connection" => { "type" => STRING, "description" => "The name of the connection to use to connect to LDAP.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether the search should be recursive.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "user-dn" => { "type" => STRING, "description" => "The name of the attribute which is the user's distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "dn", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "username-attribute" => { "type" => STRING, "description" => "The name of the attribute to search for the user. This filter will then perform a simple search where the username entered by the user matches the attribute specified here.", "expressions-allowed" => true, "nillable" => false, "alternatives" => ["advanced-filter"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "username-load" => { "type" => STRING, "description" => "The name of the attribute that should be loaded from the authenticated users LDAP entry to replace the username that they supplied, e.g. convert an e-mail address to an ID or correct the case entered.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"cache" => { "description" => "The cache that holds the results from previous authentication attempts.", "model-description" => { "by-access-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "by-search-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} }, "local" => { "description" => "Configuration of the local authentication mechanism.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "allowed-users" => { "type" => STRING, "description" => "The comma separated list of users that will be accepted using the JBOSS-LOCAL-USER mechanism or '*' to accept all. If specified the default-user is always assumed allowed.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "default-user" => { "type" => STRING, "description" => "The name of the default user to assume if no user specified by the remote client.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "skip-group-loading" => { "type" => BOOLEAN, "description" => "Disable the loading of the users group membership information after local authentication has been used.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "users" => { "description" => "Configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"user" => { "description" => "An authorized user.", "model-description" => {"*" => { "description" => "An authorized user.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"password" => { "type" => STRING, "description" => "The user's password.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "jaas" => { "description" => "Configuration to use a JAAS LoginContext to authenticate the users.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "assign-groups" => { "type" => BOOLEAN, "description" => "Map the roles loaded by JAAS to groups.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "name" => { "type" => STRING, "description" => "The name of the JAAS configuration to use.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "plug-in" => { "description" => "Configuration of a user store plug-in for use by the realm.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "mechanism" => { "type" => STRING, "description" => "Allow the mechanism this plug-in is compatible with to be overridden from DIGEST.", "expressions-allowed" => true, "nillable" => true, "default" => "DIGEST", "allowed" => [ "DIGEST", "PLAIN" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "name" => { "type" => STRING, "description" => "The short name of the plug-in (as registered) to use.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "A configuration property to be made available to the plug-in.", "model-description" => {"*" => { "description" => "A property within a security realm resource.", "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "The optional value of the property.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "truststore" => { "description" => "Configuration of a keystore to use to create a trust manager to verify clients.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "keystore-password" => { "type" => STRING, "description" => "The password to open the keystore.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-path" => { "type" => STRING, "description" => "The path of the keystore, will be ignored if the keystore-provider is anything other than JKS.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-provider" => { "type" => STRING, "description" => "The provider for loading the keystore, defaults to JKS.", "expressions-allowed" => true, "nillable" => true, "default" => "JKS", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "properties" => { "description" => "Configuration to use a list users stored within a properties file as the user repository. The entries within the properties file are username={credentials} with each user being specified on it's own line.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "path" => { "type" => STRING, "description" => "The path of the properties file containing the users.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "plain-text" => { "type" => BOOLEAN, "description" => "Are the credentials within the properties file stored in plain text. If not the credential is expected to be the hex encoded Digest hash of 'username : realm : password'.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "authorization" => { "description" => "Configuration server side for loading additional user information such as roles to be used for subsequent authorization checks.", "model-description" => { "properties" => { "description" => "Configuration to use properties file to load a users roles. The entries within the properties file are username={roles} where roles is a comma separated list of users roles.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "path" => { "type" => STRING, "description" => "The path of the properties file containing the users roles.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "ldap" => { "description" => "Configuration to use LDAP as the user repository.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"connection" => { "type" => STRING, "description" => "The name of the connection to use to connect to LDAP.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => { "username-to-dn" => { "description" => "User search configuration where the username is already a distinguished name.", "model-description" => { "advanced-filter" => { "description" => "An advanced filter configuration to identify the users distinguished name from the username.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "base-dn" => { "type" => STRING, "description" => "The starting point of the search for the user.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "filter" => { "type" => STRING, "description" => "The filter to use for the LDAP search.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "force" => { "type" => BOOLEAN, "description" => "Authentication may have already converted the username to a distinguished name, force this to occur again before loading groups.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "recursive" => { "type" => BOOLEAN, "description" => "Should levels below the starting point be recursively searched?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "user-dn-attribute" => { "type" => STRING, "description" => "The attribute on the user entry that contains their distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "dn", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"cache" => { "description" => "A cache of previous advanced-filter results.", "model-description" => { "by-access-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "by-search-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} }, "username-filter" => { "description" => "A simple filter configuration to identify the users distinguished name from their username.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "attribute" => { "type" => STRING, "description" => "The attribute on the user entry that is their username.", "expressions-allowed" => true, "nillable" => false, "default" => "uid", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "base-dn" => { "type" => STRING, "description" => "The starting point of the search for the user.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "force" => { "type" => BOOLEAN, "description" => "Authentication may have already converted the username to a distinguished name, force this to occur again before loading groups.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "recursive" => { "type" => BOOLEAN, "description" => "Should levels below the starting point be recursively searched?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "user-dn-attribute" => { "type" => STRING, "description" => "The attribute on the user entry that contains their distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "dn", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"cache" => { "description" => "A cache of previous username-filter results.", "model-description" => { "by-access-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "by-search-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} }, "username-is-dn" => { "description" => "User search configuration where the username is already a distinguished name.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"force" => { "type" => BOOLEAN, "description" => "Authentication may have already converted the username to a distinguished name, force this to occur again before loading groups.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"cache" => { "description" => "A cache of previous username-to-dn searches.", "model-description" => { "by-access-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "by-search-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} } } }, "group-search" => { "description" => "The configuration to search for a users groups.", "model-description" => { "principal-to-group" => { "description" => "A group search where the principal entries contain an attribute referencing the groups that they are a member of.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "group-attribute" => { "type" => STRING, "description" => "The attribute on the principal which references the group the principal is a member of.", "expressions-allowed" => true, "nillable" => true, "default" => "memberOf", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "group-dn-attribute" => { "type" => STRING, "description" => "Which attribute on a group entry is it's distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "dn", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "group-name" => { "type" => STRING, "description" => "An enumeration to identify if groups should be referenced using a simple name or their distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "SIMPLE", "allowed" => [ "DISTINGUISHED_NAME", "SIMPLE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "group-name-attribute" => { "type" => STRING, "description" => "Which attribute on a group entry is it's simple name.", "expressions-allowed" => true, "nillable" => true, "default" => "uid", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "iterative" => { "type" => BOOLEAN, "description" => "Should further searches be performed to identify groups that the groups identified are a member of?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "prefer-original-connection" => { "type" => BOOLEAN, "description" => "After following a referral should subsequent searches prefer the original connection or use the connection of the last referral.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "skip-missing-groups" => { "type" => BOOLEAN, "description" => "If a non-existent group is referenced should it be quietly ignored.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"cache" => { "description" => "A cache for previous principal-to-group search results.", "model-description" => { "by-access-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "by-search-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} }, "group-to-principal" => { "description" => "A group search where the group entry contains an attribute referencing it's members.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "base-dn" => { "type" => STRING, "description" => "The starting point of the search for the group.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "group-dn-attribute" => { "type" => STRING, "description" => "Which attribute on a group entry is it's distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "dn", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "group-name" => { "type" => STRING, "description" => "An enumeration to identify if groups should be referenced using a simple name or their distinguished name.", "expressions-allowed" => true, "nillable" => true, "default" => "SIMPLE", "allowed" => [ "DISTINGUISHED_NAME", "SIMPLE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "group-name-attribute" => { "type" => STRING, "description" => "Which attribute on a group entry is it's simple name.", "expressions-allowed" => true, "nillable" => true, "default" => "uid", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "iterative" => { "type" => BOOLEAN, "description" => "Should further searches be performed to identify groups that the groups identified are a member of?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "prefer-original-connection" => { "type" => BOOLEAN, "description" => "After following a referral should subsequent searches prefer the original connection or use the connection of the last referral.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "principal-attribute" => { "type" => STRING, "description" => "The attribute on the group entry that references the principal.", "expressions-allowed" => true, "nillable" => true, "default" => "member", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "recursive" => { "type" => BOOLEAN, "description" => "Should levels below the starting point be recursively searched?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "search-by" => { "type" => STRING, "description" => "Should searches be performed using simple names or distinguished names?", "expressions-allowed" => true, "nillable" => true, "default" => "DISTINGUISHED_NAME", "allowed" => [ "DISTINGUISHED_NAME", "SIMPLE" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"cache" => { "description" => "A cache for previous group to previous group-to-principal search results.", "model-description" => { "by-access-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "by-search-time" => { "description" => "A cache to hold the results of previous LDAP interactions.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "cache-failures" => { "type" => BOOLEAN, "description" => "Should failures be cached?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "cache-size" => { "type" => INT, "description" => "The current size of the cache.", "expressions-allowed" => false, "nillable" => false, "unit" => "SECONDS", "access-type" => "read-only", "storage" => "runtime" }, "eviction-time" => { "type" => INT, "description" => "The time in seconds until an entry should be evicted from the cache.", "expressions-allowed" => true, "nillable" => true, "default" => 900, "unit" => "SECONDS", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "max-cache-size" => { "type" => INT, "description" => "The maximum size of the cache before the oldest items are removed to make room for new entries.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} } } } } }, "plug-in" => { "description" => "Configuration of a user store plug-in for use by the realm.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"name" => { "type" => STRING, "description" => "The short name of the plug-in (as registered) to use.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "A configuration property to be made available to the plug-in.", "model-description" => {"*" => { "description" => "A property within a security realm resource.", "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "The optional value of the property.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} } } }, "server-identity" => { "description" => "Configuration of the identities that represent the server.", "model-description" => { "ssl" => { "description" => "Configuration of the SSL identity of a server or host controller.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "alias" => { "type" => STRING, "description" => "The alias of the entry to use from the keystore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled-cipher-suites" => { "type" => LIST, "description" => "The cipher suites that can be enabled on the underlying SSLEngine.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "enabled-protocols" => { "type" => LIST, "description" => "The protocols that can be enabled on the underlying SSLEngine.", "expressions-allowed" => true, "nillable" => true, "default" => [ "TLSv1", "TLSv1.1", "TLSv1.2" ], "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "generate-self-signed-certificate-host" => { "type" => STRING, "description" => "If the keystore does not exist and this attribute is set then a self signed certificate will be generated for the specified host name. This is not intended for production use.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "key-password" => { "type" => STRING, "description" => "The password to obtain the key from the keystore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-password" => { "type" => STRING, "description" => "The password to open the keystore.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-path" => { "type" => STRING, "description" => "The path of the keystore, will be ignored if the keystore-provider is anything other than JKS.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-provider" => { "type" => STRING, "description" => "The provider for loading the keystore, defaults to JKS.", "expressions-allowed" => true, "nillable" => true, "default" => "JKS", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "protocol" => { "type" => STRING, "description" => "The protocol to use when creating the SSLContext.", "expressions-allowed" => true, "nillable" => true, "default" => "TLS", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "kerberos" => { "description" => "Configuration for the Kerberos identity of a server or host controller.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"keytab" => { "description" => "Configuration of a keytab to use to represent a server or host controllers identity.", "model-description" => {"*" => { "description" => "Configuration of a keytab to use to represent a server or host controllers identity.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => { "debug" => { "type" => BOOLEAN, "description" => "Should additional debug logging be enabled during TGT acquisition?", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "for-hosts" => { "type" => LIST, "description" => "A server can be accessed using different host names, this attribute specifies which host names this keytab can be used with.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "The path to the keytab.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "secret" => { "description" => "Configuration of the secret/password-based identity of a server or host controller.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "The secret / password - Base64 Encoded.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "plug-in" => { "description" => "An extension to the security realm allowing additional authentication / authorization modules to be loaded.", "model-description" => {"*" => { "description" => "An extension to the security realm allowing additional authentication / authorization modules to be loaded.", "deprecated" => { "since" => "1.7.0", "reason" => "The security-realm configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"security-realm" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "ldap-connection" => { "description" => "A connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.", "model-description" => {"*" => { "description" => "A connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.", "deprecated" => { "since" => "1.7.0", "reason" => "The ldap-connection configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "handles-referrals-for" => { "type" => LIST, "description" => "List of URLs that this connection handles referrals for.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "initial-context-factory" => { "type" => STRING, "description" => "The initial context factory to establish the LdapContext.", "expressions-allowed" => true, "nillable" => true, "default" => "com.sun.jndi.ldap.LdapCtxFactory", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "referrals" => { "type" => STRING, "description" => "The referral handling mode for this connection.", "expressions-allowed" => true, "nillable" => true, "default" => "IGNORE", "allowed" => [ "FOLLOW", "IGNORE", "THROW" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "search-credential" => { "type" => STRING, "description" => "The credential to use when connecting to perform a search.", "expressions-allowed" => true, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "search-dn" => { "type" => STRING, "description" => "The distinguished name to use when connecting to the LDAP server to perform searches.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm to reference to obtain a configured SSLContext to use when establishing the connection.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url" => { "type" => STRING, "description" => "The URL to use to connect to the LDAP server.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"property" => { "description" => "A custom property to use when establishing the LDAP connection.", "model-description" => {"*" => { "description" => "A custom property to use when establishing the LDAP connection.", "deprecated" => { "since" => "1.7.0", "reason" => "The ldap-connection configuration is deprecated and may be removed or moved in future versions." }, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the custom property.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "access" => { "description" => "Model representation for configuration affecting access control and auditing of access.", "model-description" => { "audit" => { "description" => "The management audit logging top-level resource.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "periodic-rotating-file-handler" => { "description" => "Periodic-rotating file handlers for use with the management audit logging service.", "model-description" => {"*" => { "description" => "A management audit log handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.", "attributes" => { "disabled-due-to-failure" => { "type" => BOOLEAN, "description" => "Whether this handler has been disabled due to logging failures.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "failure-count" => { "type" => INT, "description" => "The number of logging failures since the handler was initialized.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "formatter" => { "type" => STRING, "description" => "The formatter used to format the log messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-failure-count" => { "type" => INT, "description" => "The maximum number of logging failures before disabling this handler.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "The path of the audit log file.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "suffix" => { "type" => STRING, "description" => "The suffix string in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "json-formatter" => { "description" => "Formatters for formatting the audit log messages using json.", "model-description" => {"*" => { "description" => "A json formatter for audit log messages.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "compact" => { "type" => BOOLEAN, "description" => "If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "date-format" => { "type" => STRING, "description" => "The date format to use as understood by {@link java.text.SimpleDateFormat}. Will be ignored if include-date=\"false\".", "expressions-allowed" => true, "nillable" => true, "default" => "yyyy-MM-dd HH:mm:ss", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "date-separator" => { "type" => STRING, "description" => "The separator between the date and the rest of the formatted log message. Will be ignored if include-date=\"false\".", "expressions-allowed" => true, "nillable" => true, "default" => " - ", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "escape-control-characters" => { "type" => BOOLEAN, "description" => "If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.' becomes '#012'. If this is true, it will override escape-new-line=\"false\".", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "escape-new-line" => { "type" => BOOLEAN, "description" => "If true will escape all new lines with the ascii code in octal, e.g. \"#012\".", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "include-date" => { "type" => BOOLEAN, "description" => "Whether or not to include the date in the formatted log record.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "logger" => { "description" => "The management audit logging service.", "model-description" => {"audit-log" => { "description" => "The management audit logging top-level resource.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "enabled" => { "type" => BOOLEAN, "description" => "Whether audit logging is enabled.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "log-boot" => { "type" => BOOLEAN, "description" => "Whether operations should be logged on server boot.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "log-read-only" => { "type" => BOOLEAN, "description" => "Whether operations that do not modify the configuration or any runtime services should be logged.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"handler" => { "description" => "References to file or syslog audit log appenders.", "model-description" => {"*" => { "description" => "A reference to a file or syslog audit log handler. The name of the handler is denoted by the value of the address.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "syslog-handler" => { "description" => "Syslog handlers for use with the management audit logging service.", "model-description" => {"*" => { "description" => "A syslog handler for use with the management audit logging service.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "app-name" => { "type" => STRING, "description" => "The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disabled-due-to-failure" => { "type" => BOOLEAN, "description" => "Whether this handler has been disabled due to logging failures.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "facility" => { "type" => STRING, "description" => "The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.", "expressions-allowed" => true, "nillable" => true, "default" => "USER_LEVEL", "allowed" => [ "KERNEL", "USER_LEVEL", "MAIL_SYSTEM", "SYSTEM_DAEMONS", "SECURITY", "SYSLOGD", "LINE_PRINTER", "NETWORK_NEWS", "UUCP", "CLOCK_DAEMON", "SECURITY2", "FTP_DAEMON", "NTP", "LOG_AUDIT", "LOG_ALERT", "CLOCK_DAEMON2", "LOCAL_USE_0", "LOCAL_USE_1", "LOCAL_USE_2", "LOCAL_USE_3", "LOCAL_USE_4", "LOCAL_USE_5", "LOCAL_USE_6", "LOCAL_USE_7" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "failure-count" => { "type" => INT, "description" => "The number of logging failures since the handler was initialized.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "formatter" => { "type" => STRING, "description" => "The formatter used to format the log messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-failure-count" => { "type" => INT, "description" => "The maximum number of logging failures before disabling this handler.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-length" => { "type" => INT, "description" => "The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "syslog-format" => { "type" => STRING, "description" => "Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.", "expressions-allowed" => true, "nillable" => true, "default" => "RFC5424", "allowed" => [ "RFC5424", "RFC3164" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "truncate" => { "type" => BOOLEAN, "description" => "Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"protocol" => { "description" => "The protocol to use for the syslog handler. Must be one and only one of 'udp', 'tcp' or 'tls'.", "model-description" => { "tcp" => { "description" => "Configuration to append to syslog over tcp/ip.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "host" => { "type" => STRING, "description" => "The host of the syslog server for the tcp requests.", "expressions-allowed" => true, "nillable" => true, "default" => "localhost", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "message-transfer" => { "type" => STRING, "description" => "The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider's documentation for what is supported.", "expressions-allowed" => true, "nillable" => true, "default" => "NON_TRANSPARENT_FRAMING", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "port" => { "type" => INT, "description" => "The port of the syslog server for the tcp requests.", "expressions-allowed" => true, "nillable" => true, "default" => 514, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reconnect-timeout" => { "type" => INT, "description" => "If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don't reconnect automatically.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "udp" => { "description" => "Configuration to append to syslog over udp/ip.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "host" => { "type" => STRING, "description" => "The host of the syslog server for the udp requests.", "expressions-allowed" => true, "nillable" => true, "default" => "localhost", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "port" => { "type" => INT, "description" => "The port of the syslog server for the udp requests.", "expressions-allowed" => true, "nillable" => true, "default" => 514, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "tls" => { "description" => "Configuration to append to syslog over tls over tcp/ip.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "host" => { "type" => STRING, "description" => "The host of the syslog server for the tls over tcp requests.", "expressions-allowed" => true, "nillable" => true, "default" => "localhost", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "message-transfer" => { "type" => STRING, "description" => "The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider's documentation for what is supported.", "expressions-allowed" => true, "nillable" => true, "default" => "NON_TRANSPARENT_FRAMING", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "port" => { "type" => INT, "description" => "The port of the syslog server for the tls over tcp requests.", "expressions-allowed" => true, "nillable" => true, "default" => 514, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "reconnect-timeout" => { "type" => INT, "description" => "If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don't reconnect automatically.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {"authentication" => { "description" => "Configuration for the truststore for the server certificate if not signed by an authority, and the keystore containing the client certificate if the syslog server is set up to require client authentication.", "model-description" => { "truststore" => { "description" => "Configuration for the truststore for the server certificate, if not signed by an authority.", "attributes" => { "keystore-password" => { "type" => STRING, "description" => "The password for the truststore.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-path" => { "type" => STRING, "description" => "=The path of the truststore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "client-certificate-store" => { "description" => "Configuration for the keystore containing the client certificate if the syslog server requires authentication.", "attributes" => { "key-password" => { "type" => STRING, "description" => "The password for the keystore key.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-password" => { "type" => STRING, "description" => "The password for the keystore.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-path" => { "type" => STRING, "description" => "=The path of the keystore.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "keystore-relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } }} } } }} }} }, "file-handler" => { "description" => "File handlers for use with the management audit logging service.", "model-description" => {"*" => { "description" => "A file handler for use with the management audit logging service.", "deprecated" => { "since" => "1.7.0", "reason" => "The management audit log configuration is deprecated and may be removed or moved in future versions." }, "attributes" => { "disabled-due-to-failure" => { "type" => BOOLEAN, "description" => "Whether this handler has been disabled due to logging failures.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "failure-count" => { "type" => INT, "description" => "The number of logging failures since the handler was initialized.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "formatter" => { "type" => STRING, "description" => "The formatter used to format the log messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-failure-count" => { "type" => INT, "description" => "The maximum number of logging failures before disabling this handler.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "The path of the audit log file.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-at-startup" => { "type" => BOOLEAN, "description" => "Whether the old log file should be rotated at server startup.", "expressions-allowed" => false, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "in-memory-handler" => { "description" => "In memory handlers for use with the management audit logging service.", "model-description" => {"*" => { "description" => "A in-memory handler for use with the management audit logging service.", "attributes" => {"max-history" => { "type" => INT, "description" => "The maximum number of operation stored in history for this handler.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "size-rotating-file-handler" => { "description" => "Size-rotating file handlers for use with the management audit logging service.", "model-description" => {"*" => { "description" => "A management audit log handler which writes to a file, rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.", "attributes" => { "disabled-due-to-failure" => { "type" => BOOLEAN, "description" => "Whether this handler has been disabled due to logging failures.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "failure-count" => { "type" => INT, "description" => "The number of logging failures since the handler was initialized.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "formatter" => { "type" => STRING, "description" => "The formatter used to format the log messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-backup-index" => { "type" => INT, "description" => "The maximum number of backups to keep.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-failure-count" => { "type" => INT, "description" => "The maximum number of logging failures before disabling this handler.", "expressions-allowed" => true, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "The path of the audit log file.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "relative-to" => { "type" => STRING, "description" => "The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "rotate-size" => { "type" => STRING, "description" => "The size at which to rotate the log file.", "expressions-allowed" => true, "nillable" => true, "default" => "10m", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "authorization" => { "description" => "The access control definitions defining the access management restrictions.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "all-role-names" => { "type" => LIST, "description" => "The official names of all roles supported by the current management access control provider. This includes any standard roles as well as any user-defined roles.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "permission-combination-policy" => { "type" => STRING, "description" => "The policy for combining access control permissions when the authorization policy grants the user more than one type of permission for a given action. In the standard role based authorization policy, this would occur when a user maps to multiple roles. The 'permissive' policy means if any of the permissions allow the action, the action is allowed. The 'rejecting' policy means the existence of multiple permissions should result in an error.", "expressions-allowed" => false, "nillable" => true, "default" => "permissive", "allowed" => [ "permissive", "rejecting" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "provider" => { "type" => STRING, "description" => "The provider to use for management access control decisions.", "expressions-allowed" => false, "nillable" => true, "default" => "simple", "allowed" => [ "simple", "rbac" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "standard-role-names" => { "type" => LIST, "description" => "The official names of the standard roles supported by the current management access control provider.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "role-mapping" => { "description" => "A mapping of users and groups to a specific role.", "model-description" => {"*" => { "description" => "A mapping of users and groups to a specific role.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => {"include-all" => { "type" => BOOLEAN, "description" => "Configure if all authenticated users should be automatically assigned this role.", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => { "include" => { "description" => "Principals to be inlcuded in a role.", "model-description" => {"*" => { "description" => "An individual principal used within a role mapping.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "name" => { "type" => STRING, "description" => "The name of the user or group being mapped.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "realm" => { "type" => STRING, "description" => "An optional attribute to map based on the realm used for authentication.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "type" => { "type" => STRING, "description" => "The type of the Principal being mapped, either 'group' or 'user'.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "GROUP", "USER" ], "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "exclude" => { "description" => "Principals to be excluded from a role.", "model-description" => {"*" => { "description" => "An individual principal used within a role mapping.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "name" => { "type" => STRING, "description" => "The name of the user or group being mapped.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "realm" => { "type" => STRING, "description" => "An optional attribute to map based on the realm used for authentication.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "type" => { "type" => STRING, "description" => "The type of the Principal being mapped, either 'group' or 'user'.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "GROUP", "USER" ], "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "constraint" => { "description" => "Access constraints for the vault expressions sensitivity, sensitivity classifications and the application resources.", "model-description" => { "application-classification" => { "description" => "Configuration of the application classification constraints.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"type" => { "description" => "The named application classifications grouped by the constraint's subsystem, or 'core' if it comes from the core model.", "model-description" => {"*" => { "description" => "The application classification constraints by type. Type is either 'core' or the name of a subsystem.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"classification" => { "description" => "The application classification constraints by type.", "model-description" => {"*" => { "description" => "Configuration of an application classification constraint.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "configured-application" => { "type" => BOOLEAN, "description" => "Set to override the default as to whether the constraint is considered an application resource.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-application" => { "type" => BOOLEAN, "description" => "Whether targets having this application type constraint are considered application resources.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"applies-to" => { "description" => "Information about the resources, attributes and operations to which this application classification constraint applies.", "model-description" => {"*" => { "description" => "Information about the resources, attributes and operations to which an access control constraint applies.", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "address" => { "type" => STRING, "description" => "Address pattern describing a resource or resources to which the constraint applies.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "attributes" => { "type" => LIST, "description" => "List of the names of attributes to which the constraint specifically applies.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "entire-resource" => { "type" => BOOLEAN, "description" => "True if the constraint applies to the resource as a whole; false if it only applies to one or more attributes or operations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "configuration" }, "operations" => { "type" => LIST, "description" => "List of the names of operations to which the constraint specifically applies.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }} }, "sensitivity-classification" => { "description" => "The sensitivity classification constraints.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"type" => { "description" => "The named application classifications grouped by the constraint's subsystem, or 'core' if it comes from the core model.", "model-description" => {"*" => { "description" => "The sensitivity classifications by type. Type is either 'core' or the name of a subsystem.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"classification" => { "description" => "The sensitivity classifications by type", "model-description" => {"*" => { "description" => "Configuration of a sensitivity constraint.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "configured-requires-addressable" => { "type" => BOOLEAN, "description" => "Set to override the default as to whether the visibility of resources annotated with this sensitivity constraint should be considered sensitive.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "configured-requires-read" => { "type" => BOOLEAN, "description" => "Set to override the default as to whether reading attributes annotated with this sensitivity constraint should be considered sensitive.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "configured-requires-write" => { "type" => BOOLEAN, "description" => "Set to override the default as to whether writing attributes annotated with this sensitivity constraint should be considered sensitive.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-requires-addressable" => { "type" => BOOLEAN, "description" => "Whether the visibility of resources annotated with this sensitivity constraint should be considered sensitive.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "default-requires-read" => { "type" => BOOLEAN, "description" => "Whether reading attributes annotated with this sensitivity constraint should be considered sensitive.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "default-requires-write" => { "type" => BOOLEAN, "description" => "Whether writing attributes annotated with this sensitivity constraint should be considered sensitive.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"applies-to" => { "description" => "Information about the resources, attributes and operations to which this sensitivity classification constraint applies.", "model-description" => {"*" => { "description" => "Information about the resources, attributes and operations to which an access control constraint applies.", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "address" => { "type" => STRING, "description" => "Address pattern describing a resource or resources to which the constraint applies.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "attributes" => { "type" => LIST, "description" => "List of the names of attributes to which the constraint specifically applies.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "entire-resource" => { "type" => BOOLEAN, "description" => "True if the constraint applies to the resource as a whole; false if it only applies to one or more attributes or operations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "configuration" }, "operations" => { "type" => LIST, "description" => "List of the names of operations to which the constraint specifically applies.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }} }, "vault-expression" => { "description" => "Configuration of whether vault expressions should be considered sensitive.", "access-constraints" => {"sensitive" => {"access-control" => {"type" => "core"}}}, "attributes" => { "configured-requires-read" => { "type" => BOOLEAN, "description" => "Set to override the default as to whether reading attributes containing vault expressions should be considered sensitive.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "configured-requires-write" => { "type" => BOOLEAN, "description" => "Set to override the default as to whether writing attributes containing vault expressions should be considered sensitive.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "default-requires-read" => { "type" => BOOLEAN, "description" => "Whether reading attributes containing vault expressions should be considered sensitive.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "default-requires-write" => { "type" => BOOLEAN, "description" => "Whether writing attributes containing vault expressions should be considered sensitive.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } } } } } }, "management-interface" => { "description" => "Interfaces exposed by the management services to allow external callers to perform management tasks.", "model-description" => { "http-interface" => { "description" => "Configuration of the server's HTTP management interface", "capabilities" => [ { "name" => "org.wildfly.management.http.extensible", "dynamic" => false }, { "name" => "org.wildfly.management.http-interface", "dynamic" => false } ], "deprecated" => { "since" => "1.7.0", "reason" => "The http-interface configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"management-interfaces" => {"type" => "core"}}}, "attributes" => { "allowed-origins" => { "type" => LIST, "description" => "Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "console-enabled" => { "type" => BOOLEAN, "description" => "Flag that indicates admin console is enabled", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "http-upgrade" => { "type" => OBJECT, "description" => "HTTP Upgrade specific configuration", "expressions-allowed" => false, "nillable" => true, "value-type" => {"enabled" => { "type" => BOOLEAN, "description" => "Flag that indicates HTTP Upgrade is enabled, which allows HTTP requests to be upgraded to native remoting connections", "expressions-allowed" => false, "nillable" => true, "default" => false }}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "http-upgrade-enabled" => { "type" => BOOLEAN, "description" => "Flag that indicates HTTP Upgrade is enabled, which allows HTTP requests to be upgraded to native remoting connections", "expressions-allowed" => false, "nillable" => true, "deprecated" => { "since" => "5.0.0", "reason" => "Instead use http-upgrade.enabled" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "sasl-protocol" => { "type" => STRING, "description" => "The name of the protocol to be passed to the SASL mechanisms used for authentication.", "expressions-allowed" => true, "nillable" => true, "default" => "remote", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "secure-socket-binding" => { "type" => STRING, "description" => "The name of the socket binding configuration to use for the HTTPS management interface's socket.", "expressions-allowed" => false, "nillable" => true, "requires" => ["security-realm"], "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm to use for the HTTP management interface.", "expressions-allowed" => false, "nillable" => true, "nil-significant" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "server-name" => { "type" => STRING, "description" => "The name of the server used in the initial Remoting exchange and within the SASL mechanisms.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-binding" => { "type" => STRING, "description" => "The name of the socket binding configuration to use for the HTTP management interface's socket.", "expressions-allowed" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "native-remoting-interface" => { "description" => "Configuration of the server's native management interface using a connector from the remoting subsystem.", "deprecated" => { "since" => "1.7.0", "reason" => "The native-remoting-interface configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"management-interfaces" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "native-interface" => { "description" => "Configuration of the server's native management interface", "capabilities" => [{ "name" => "org.wildfly.management.native-interface", "dynamic" => false }], "deprecated" => { "since" => "1.7.0", "reason" => "The native-interface configuration is deprecated and may be removed or moved in future versions." }, "access-constraints" => {"sensitive" => {"management-interfaces" => {"type" => "core"}}}, "attributes" => { "sasl-protocol" => { "type" => STRING, "description" => "The name of the protocol to be passed to the SASL mechanisms used for authentication.", "expressions-allowed" => true, "nillable" => true, "default" => "remote", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm to use for the native management interface.", "expressions-allowed" => false, "nillable" => true, "nil-significant" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "server-name" => { "type" => STRING, "description" => "The name of the server used in the initial Remoting exchange and within the SASL mechanisms.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "socket-binding" => { "type" => STRING, "description" => "The name of the socket binding configuration to use for the native management interface's socket.", "expressions-allowed" => false, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} } } } } }, "service-container" => { "description" => "The central container that manages all services in a running standalone server or in a host controller in a management domain.", "access-constraints" => {"sensitive" => {"service-container" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "server-environment" => { "description" => "The server environment.", "attributes" => { "base-dir" => { "type" => STRING, "description" => "The base directory for the server.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "config-dir" => { "type" => STRING, "description" => "The directory where the configurations are stored.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "config-file" => { "type" => STRING, "description" => "The configuration file used to launch the server.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "content-dir" => { "type" => STRING, "description" => "The directory where user content (e.g. deployments) that is managed by the server is stored.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "data-dir" => { "type" => STRING, "description" => "The data directory.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "deploy-dir" => { "type" => STRING, "description" => "Deprecated variant of 'content-dir'.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "ext-dirs" => { "type" => STRING, "description" => "A list of ext directories.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "home-dir" => { "type" => STRING, "description" => "The home directory for the server.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "host-name" => { "type" => STRING, "description" => "The host name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "initial-running-mode" => { "type" => STRING, "description" => "The initial running mode of the server, when the server process was launched. Either NORMAL or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests.", "expressions-allowed" => false, "nillable" => false, "allowed" => [ "NORMAL", "ADMIN_ONLY" ], "access-type" => "read-only", "storage" => "runtime" }, "launch-type" => { "type" => STRING, "description" => "The type of the running server.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "log-dir" => { "type" => STRING, "description" => "The directory where log files are sent.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "modules-dir" => { "type" => STRING, "description" => "The directory where modules are found.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "2.1.0", "reason" => "Has no real meaning and should not be regarded as providing any sort of useful information. The \"modules\" directory is the default location from which JBoss Modules looks to find modules. However, this behavior is in no way controlled by the value returned by this method, nor is it guaranteed that modules will be loaded from only one directory, nor is it guaranteed that the \"modules\" directory will be one of the directories used." }, "access-type" => "read-only", "storage" => "runtime" }, "node-name" => { "type" => STRING, "description" => "The name of the server node.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "qualified-host-name" => { "type" => STRING, "description" => "The qualified host name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "server-name" => { "type" => STRING, "description" => "The name of the server.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "temp-dir" => { "type" => STRING, "description" => "The temporary directory.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "module-loading" => { "description" => "The modular classloading system.", "access-constraints" => {"sensitive" => {"module-loading" => {"type" => "core"}}}, "attributes" => {"module-roots" => { "type" => LIST, "description" => "A list of filesystem locations under which the module loading system looks for modules, arranged in order of precedence.", "expressions-allowed" => false, "nillable" => false, "deprecated" => { "since" => "1.4.0", "reason" => "Experimental and unsupported." }, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {} } } }, "extension" => { "description" => "A list of extension modules.", "model-description" => {"*" => { "description" => "A module that extends the standard capabilities of a domain or a standalone server.", "access-constraints" => {"sensitive" => {"extensions" => {"type" => "core"}}}, "attributes" => {"module" => { "type" => STRING, "description" => "The name of the module.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }}, "operations" => undefined, "notifications" => undefined, "children" => {"subsystem" => { "description" => "A subsystem provided by the extension. What is provided here is information about the xml schema and management interface provided by the subsystem, not the configuration of the subsystem itself.", "model-description" => {"*" => { "description" => "A subsystem provided by the extension. What is provided here is information about the xml schema and management interface provided by the subsystem, not the configuration of the subsystem itself.", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"extensions" => {"type" => "core"}}}, "attributes" => { "management-major-version" => { "type" => INT, "description" => "Major version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "management-micro-version" => { "type" => INT, "description" => "Micro version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.", "expressions-allowed" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "management-minor-version" => { "type" => INT, "description" => "Minor version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.", "expressions-allowed" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "xml-namespaces" => { "type" => LIST, "description" => "A list of URIs for the XML namespaces supported by the subsystem's XML parser. May be empty if the extension did not clearly associate an XML namespace with a particular subsystem.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "deployment" => { "description" => "A list of deployments available for use on the server.", "model-description" => {"*" => { "description" => "A deployment represents anything that can be deployed (e.g. an application such as EJB-JAR, WAR, EAR, any kind of standard archive such as RAR or JBoss-specific deployment) into a server.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "content" => { "type" => LIST, "description" => "List of pieces of content that comprise the deployment.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "hash" => { "type" => BYTES, "description" => "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" => false, "nillable" => true, "alternatives" => [ "input-stream-index", "bytes", "url", "path", "relative-to", "empty" ], "min-length" => 20L, "max-length" => 20L }, "path" => { "type" => STRING, "description" => "Path (relative or absolute) to unmanaged content that is part of the deployment.", "expressions-allowed" => false, "nillable" => true, "alternatives" => [ "input-stream-index", "hash", "bytes", "url", "empty" ], "requires" => ["archive"], "min-length" => 1L, "max-length" => 2147483647L }, "relative-to" => { "type" => STRING, "description" => "Name of a system path to which the value of the 'path' is relative. If not set, the 'path' is considered to be absolute.", "expressions-allowed" => false, "nillable" => true, "alternatives" => [ "input-stream-index", "hash", "bytes", "url", "empty" ], "requires" => ["path"], "min-length" => 1L, "max-length" => 2147483647L }, "archive" => { "type" => BOOLEAN, "description" => "Flag indicating whether unmanaged content is a zip archive (true) or exploded (false).", "expressions-allowed" => false, "nillable" => true, "alternatives" => [ "input-stream-index", "bytes", "url" ], "requires" => [ "path", "hash", "empty" ] } }, "access-type" => "read-only", "storage" => "configuration" }, "disabled-time" => { "type" => LONG, "description" => "Last time the application was disabled", "expressions-allowed" => false, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "disabled-timestamp" => { "type" => STRING, "description" => "Last timestamp the application was disabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)", "expressions-allowed" => false, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "enabled-time" => { "type" => LONG, "description" => "Last time the application was enabled", "expressions-allowed" => false, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "enabled-timestamp" => { "type" => STRING, "description" => "Last timestamp the application was enabled. Format is yyyy-MM-dd HH:mm:ss,SSS zzz.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "managed" => { "type" => BOOLEAN, "description" => "Indicates if the deployment is managed (aka uses the ContentRepository).", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "Unique identifier of the deployment. Must be unique across all deployments.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "owner" => { "type" => LIST, "description" => "Address of a resource that has indicated it controls the lifecycle of this deployment (e.g. a deployment scanner resource.) Will be undefined if no resource claimed ownership when the deployment was added.", "expressions-allowed" => false, "nillable" => true, "value-type" => PROPERTY, "access-type" => "read-only", "storage" => "configuration" }, "persistent" => { "type" => BOOLEAN, "description" => "Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "configuration" }, "runtime-name" => { "type" => STRING, "description" => "Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of \"foo.war\") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "status" => { "type" => STRING, "description" => "The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was not enabled or was manually stopped.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "subsystem" => { "description" => "Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.", "model-description" => { "jaxrs" => { "description" => "The configuration of the JAX-RS subsystem.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "webservices" => { "description" => "Runtime resources exposed by web service components in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"endpoint" => { "description" => "WS endpoint", "model-description" => {"*" => { "description" => "WS endpoint", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "average-processing-time" => { "type" => INT, "description" => "Average endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "class" => { "type" => STRING, "description" => "Webservice endpoint class.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "context" => { "type" => STRING, "description" => "Webservice endpoint context.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "fault-count" => { "type" => INT, "description" => "Count of faults the endpoint generated.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-processing-time" => { "type" => INT, "description" => "Maximal endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "min-processing-time" => { "type" => INT, "description" => "Minimal endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "Webservice endpoint name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "request-count" => { "type" => INT, "description" => "Count of requests the endpoint processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "response-count" => { "type" => INT, "description" => "Count of responses the endpoint generated.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "total-processing-time" => { "type" => INT, "description" => "Total endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "type" => { "type" => STRING, "description" => "Webservice endpoint type.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "wsdl-url" => { "type" => STRING, "description" => "Webservice endpoint WSDL URL. If wsdl-host is set to jbossws.undefined.host, JBossWS uses the requester host when rewriting the ", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "jpa" => { "description" => "The configuration of the JPA subsystem.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "default-datasource" => { "type" => STRING, "description" => "The name of the default global datasource.", "expressions-allowed" => true, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-extended-persistence-inheritance" => { "type" => STRING, "description" => "Controls how JPA extended persistence context (XPC) inheritance is performed. 'DEEP' shares the extended persistence context at top bean level. 'SHALLOW' the extended persistece context is only shared with the parent bean (never with sibling beans).", "expressions-allowed" => true, "nillable" => true, "default" => "DEEP", "allowed" => [ "DEEP", "SHALLOW" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "messaging-activemq" => { "description" => "Runtime resources exposed by messaging resources included in this deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"server" => { "description" => "An ActiveMQ server instance.", "model-description" => {"*" => { "description" => "An ActiveMQ server instance.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "jms-topic" => { "description" => "Defines a JMS topic.", "model-description" => {"*" => { "description" => "Defines a JMS topic.", "access-constraints" => {"application" => { "jms-topic" => {"type" => "messaging-activemq"}, "deployment" => {"type" => "core"} }}, "attributes" => { "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable-message-count" => { "type" => INT, "description" => "The number of messages for all durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable-subscription-count" => { "type" => INT, "description" => "The number of durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "entries" => { "type" => LIST, "description" => "The jndi names the topic will be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "legacy-entries" => { "type" => LIST, "description" => "The legacy jndi names the topic will be bound to.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "non-durable-message-count" => { "type" => INT, "description" => "The number of messages for all non-durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "non-durable-subscription-count" => { "type" => INT, "description" => "The number of non-durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "subscription-count" => { "type" => INT, "description" => "The number of (durable and non-durable) subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the topic is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "topic-address" => { "type" => STRING, "description" => "The address the topic points to.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "jms-queue" => { "description" => "Defines a JMS queue.", "model-description" => {"*" => { "description" => "Defines a JMS queue.", "access-constraints" => {"application" => { "jms-queue" => {"type" => "messaging-activemq"}, "deployment" => {"type" => "core"} }}, "attributes" => { "consumer-count" => { "type" => INT, "description" => "The number of consumers consuming messages from this queue.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "dead-letter-address" => { "type" => STRING, "description" => "The address to send dead messages to.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable" => { "type" => BOOLEAN, "description" => "Whether the queue is durable or not.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "entries" => { "type" => LIST, "description" => "The jndi names the queue will be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "expiry-address" => { "type" => STRING, "description" => "The address to send expired messages to.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "legacy-entries" => { "type" => LIST, "description" => "The jndi names the queue will be bound to.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "paused" => { "type" => BOOLEAN, "description" => "Whether the queue is paused.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "queue-address" => { "type" => STRING, "description" => "The queue address defines what address is used for routing messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "scheduled-count" => { "type" => LONG, "description" => "The number of scheduled messages in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "selector" => { "type" => STRING, "description" => "The queue selector.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the queue is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "pooled-connection-factory" => { "description" => "Defines a managed connection factory.", "model-description" => {"*" => { "description" => "Defines a managed connection factory.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "auto-group" => { "type" => BOOLEAN, "description" => "The autogroup.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "block-on-acknowledge" => { "type" => BOOLEAN, "description" => "True to set block on acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "block-on-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on durable send.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "block-on-non-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on non durable send.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "cache-large-message-client" => { "type" => BOOLEAN, "description" => "True to cache large messages.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "call-failover-timeout" => { "type" => LONG, "description" => "The timeout to use when fail over is in process (in ms).", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "call-timeout" => { "type" => LONG, "description" => "The call time out.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "client-failure-check-period" => { "type" => LONG, "description" => "The client failure check period.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "client-id" => { "type" => STRING, "description" => "The client id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "compress-large-messages" => { "type" => BOOLEAN, "description" => "Whether large messages should be compressed.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation window size.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "connection-load-balancing-policy-class-name" => { "type" => STRING, "description" => "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.", "expressions-allowed" => false, "nillable" => true, "default" => "org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "connection-ttl" => { "type" => LONG, "description" => "The connection ttl.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "connectors" => { "type" => LIST, "description" => "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "consumer-max-rate" => { "type" => INT, "description" => "The consumer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-only", "storage" => "configuration" }, "consumer-window-size" => { "type" => INT, "description" => "The consumer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "discovery-group" => { "type" => STRING, "description" => "The discovery group name.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "dups-ok-batch-size" => { "type" => INT, "description" => "The dups ok batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-only", "storage" => "configuration" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "entries" => { "type" => LIST, "description" => "The jndi names the connection factory should be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "failover-on-initial-connection" => { "type" => BOOLEAN, "description" => "True to fail over on initial connection.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "group-id" => { "type" => STRING, "description" => "The group id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "ha" => { "type" => BOOLEAN, "description" => "Whether the connection factory supports High Availability.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "initial-connect-attempts" => { "type" => INT, "description" => "The number of attempts to connect initially with this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-only", "storage" => "configuration" }, "initial-message-packet-size" => { "type" => INT, "description" => "The initial size of messages created through this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1500, "access-type" => "read-only", "storage" => "configuration" }, "managed-connection-pool" => { "type" => STRING, "description" => "The class name of the managed connection pool used by this pooled-connection-factory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "max-pool-size" => { "type" => INT, "description" => "The maximum size for the pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-only", "storage" => "configuration" }, "max-retry-interval" => { "type" => LONG, "description" => "The max retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "min-large-message-size" => { "type" => INT, "description" => "The min large message size.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "min-pool-size" => { "type" => INT, "description" => "The minimum size for the pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-only", "storage" => "configuration" }, "password" => { "type" => STRING, "description" => "The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-only", "storage" => "configuration" }, "pre-acknowledge" => { "type" => BOOLEAN, "description" => "True to pre-acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "producer-max-rate" => { "type" => INT, "description" => "The producer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-only", "storage" => "configuration" }, "producer-window-size" => { "type" => INT, "description" => "The producer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 65536, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "protocol-manager-factory" => { "type" => STRING, "description" => "The protocol manager factory used by this pooled connection factory.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "reconnect-attempts" => { "type" => INT, "description" => "The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-only", "storage" => "configuration" }, "retry-interval" => { "type" => LONG, "description" => "The retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "The retry interval multiplier.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-only", "storage" => "configuration" }, "scheduled-thread-pool-max-size" => { "type" => INT, "description" => "The scheduled thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-only", "storage" => "configuration" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "thread-pool-max-size" => { "type" => INT, "description" => "The thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-only", "storage" => "configuration" }, "transaction" => { "type" => STRING, "description" => "The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).", "expressions-allowed" => true, "nillable" => true, "default" => "transaction", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "transaction-batch-size" => { "type" => INT, "description" => "The transaction batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-only", "storage" => "configuration" }, "use-auto-recovery" => { "type" => BOOLEAN, "description" => "True to use auto recovery.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "use-global-pools" => { "type" => BOOLEAN, "description" => "True to use global pools.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "user" => { "type" => STRING, "description" => "The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-only", "storage" => "configuration" }, "jndi-params" => { "type" => STRING, "description" => "The JNDI params to use for locating the destination for incoming connections.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "rebalance-connections" => { "type" => BOOLEAN, "description" => "Rebalance inbound connections when cluster topology changes.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "setup-attempts" => { "type" => INT, "description" => "The number of times to set up an MDB endpoint", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "setup-interval" => { "type" => LONG, "description" => "The interval between attempts at setting up an MDB endpoint.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "use-jndi" => { "type" => BOOLEAN, "description" => "Use JNDI to locate the destination for incoming connections", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "use-local-tx" => { "type" => BOOLEAN, "description" => "Use a local transaction for incoming sessions", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }, "ejb3" => { "description" => "Runtime resources exposed by EJBs components included in this deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "stateful-session-bean" => { "description" => "Stateful session bean component included in the deployment.", "model-description" => {"*" => { "description" => "Stateful session bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "cache-size" => { "type" => LONG, "description" => "Cache size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "passivated-count" => { "type" => LONG, "description" => "Passivated count.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "total-size" => { "type" => LONG, "description" => "Total size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "stateless-session-bean" => { "description" => "Stateless session bean component included in the deployment.", "model-description" => {"*" => { "description" => "Stateless session bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "pool-available-count" => { "type" => INT, "description" => "The number of available (i.e. not in use) instances in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-create-count" => { "type" => INT, "description" => "The number of bean instances that have been created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-current-size" => { "type" => INT, "description" => "The current size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-max-size" => { "type" => INT, "description" => "The maximum size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "pool-name" => { "type" => STRING, "description" => "The name of the pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "pool-remove-count" => { "type" => INT, "description" => "The number of bean instances that have been removed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "timers" => { "type" => LIST, "description" => "EJB timers associated with the component.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "time-remaining" => { "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "MILLISECONDS" }, "next-timeout" => { "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "calendar-timer" => { "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "persistent" => { "description" => "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "schedule" => { "description" => "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "type" => OBJECT, "nillable" => true, "value-type" => { "year" => { "description" => "A particular calendar year.", "type" => STRING, "nillable" => true }, "month" => { "description" => "One or more months within a year.", "type" => STRING, "nillable" => true }, "day-of-month" => { "description" => "One or more days within a month.", "type" => STRING, "nillable" => true }, "day-of-week" => { "description" => "One or more days within a week.", "type" => STRING, "nillable" => true }, "hour" => { "description" => "One or more hours within a day.", "type" => STRING, "nillable" => true }, "minute" => { "description" => "One or more minutes within an hour.", "type" => STRING, "nillable" => true }, "second" => { "description" => "One or more seconds within a minute.", "type" => STRING, "nillable" => true }, "timezone" => { "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "type" => STRING, "nillable" => true }, "start" => { "description" => "The start date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "end" => { "description" => "The end date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" } } } }, "access-type" => "read-only", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "singleton-bean" => { "description" => "Singleton bean component included in the deployment.", "model-description" => {"*" => { "description" => "Singleton bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "timers" => { "type" => LIST, "description" => "EJB timers associated with the component.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "time-remaining" => { "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "MILLISECONDS" }, "next-timeout" => { "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "calendar-timer" => { "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "persistent" => { "description" => "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "schedule" => { "description" => "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "type" => OBJECT, "nillable" => true, "value-type" => { "year" => { "description" => "A particular calendar year.", "type" => STRING, "nillable" => true }, "month" => { "description" => "One or more months within a year.", "type" => STRING, "nillable" => true }, "day-of-month" => { "description" => "One or more days within a month.", "type" => STRING, "nillable" => true }, "day-of-week" => { "description" => "One or more days within a week.", "type" => STRING, "nillable" => true }, "hour" => { "description" => "One or more hours within a day.", "type" => STRING, "nillable" => true }, "minute" => { "description" => "One or more minutes within an hour.", "type" => STRING, "nillable" => true }, "second" => { "description" => "One or more seconds within a minute.", "type" => STRING, "nillable" => true }, "timezone" => { "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "type" => STRING, "nillable" => true }, "start" => { "description" => "The start date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "end" => { "description" => "The end date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" } } } }, "access-type" => "read-only", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "message-driven-bean" => { "description" => "Message driven bean component included in the deployment.", "model-description" => {"*" => { "description" => "Message driven bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "delivery-active" => { "type" => BOOLEAN, "description" => "Indicates whether messages are delivered to this message-driven bean.", "expressions-allowed" => false, "nillable" => false, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "pool-available-count" => { "type" => INT, "description" => "The number of available (i.e. not in use) instances in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-create-count" => { "type" => INT, "description" => "The number of bean instances that have been created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-current-size" => { "type" => INT, "description" => "The current size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-max-size" => { "type" => INT, "description" => "The maximum size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "pool-name" => { "type" => STRING, "description" => "The name of the pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "pool-remove-count" => { "type" => INT, "description" => "The number of bean instances that have been removed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "timers" => { "type" => LIST, "description" => "EJB timers associated with the component.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "time-remaining" => { "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "MILLISECONDS" }, "next-timeout" => { "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "calendar-timer" => { "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "persistent" => { "description" => "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "schedule" => { "description" => "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "type" => OBJECT, "nillable" => true, "value-type" => { "year" => { "description" => "A particular calendar year.", "type" => STRING, "nillable" => true }, "month" => { "description" => "One or more months within a year.", "type" => STRING, "nillable" => true }, "day-of-month" => { "description" => "One or more days within a month.", "type" => STRING, "nillable" => true }, "day-of-week" => { "description" => "One or more days within a week.", "type" => STRING, "nillable" => true }, "hour" => { "description" => "One or more hours within a day.", "type" => STRING, "nillable" => true }, "minute" => { "description" => "One or more minutes within an hour.", "type" => STRING, "nillable" => true }, "second" => { "description" => "One or more seconds within a minute.", "type" => STRING, "nillable" => true }, "timezone" => { "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "type" => STRING, "nillable" => true }, "start" => { "description" => "The start date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "end" => { "description" => "The end date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" } } } }, "access-type" => "read-only", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} } } }, "undertow" => { "description" => "A deployment", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active-sessions" => { "type" => INT, "description" => "Number of active sessions", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "context-root" => { "type" => STRING, "description" => "The context root of the web application", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "expired-sessions" => { "type" => INT, "description" => "Number of sessions that have expired", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-active-sessions" => { "type" => INT, "description" => "Max number of concurrent active sessions", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-sessions" => { "type" => INT, "description" => "Number of rejected sessions", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "server" => { "type" => STRING, "description" => "The name of server this application belongs to", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "session-avg-alive-time" => { "type" => INT, "description" => "Average time (in seconds) that expired sessions had been alive", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "session-max-alive-time" => { "type" => INT, "description" => "The longest time (in seconds) that an expired session had been alive", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "sessions-created" => { "type" => INT, "description" => "Total sessions created", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "virtual-host" => { "type" => STRING, "description" => "The name of the virtual host on which the web application is served", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "servlet" => { "description" => "Servlet", "model-description" => {"*" => { "description" => "Servlet", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "mappings" => { "type" => LIST, "description" => "Servlet mappings", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "metric", "storage" => "runtime" }, "max-request-time" => { "type" => LONG, "description" => "Maximal time for processing request", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "min-request-time" => { "type" => LONG, "description" => "Minimal time for processing request", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "request-count" => { "type" => LONG, "description" => "Number of all requests", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "servlet-class" => { "type" => STRING, "description" => "Class of the servlet", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "servlet-name" => { "type" => STRING, "description" => "Name of the servlet", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "total-request-time" => { "type" => LONG, "description" => "Total time spend in processing all requests", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "websocket" => { "description" => "Websocket", "model-description" => {"*" => { "description" => "Websocket", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "endpoint-class" => { "type" => STRING, "description" => "The endpoint class", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "path" => { "type" => STRING, "description" => "The path the endpoint is deployed to", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "datasources" => { "description" => "The data-sources subsystem, used to declare JDBC data-sources", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "data-source" => { "description" => "A JDBC data-source configuration", "model-description" => {"*" => { "description" => "A JDBC data-source configuration", "access-constraints" => {"application" => { "data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allow-multiple-users" => { "type" => BOOLEAN, "description" => "Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to be injected in class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to be injected in class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "check-valid-connection-sql" => { "type" => STRING, "description" => "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-class" => { "type" => STRING, "description" => "Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-property" => { "type" => OBJECT, "description" => "Properties to be injected in class specidied in connection-listener-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "connection-url" => { "type" => STRING, "description" => "The JDBC driver connection URL", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "datasource-class" => { "type" => STRING, "description" => "The fully qualified name of the JDBC datasource class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "driver-class" => { "type" => STRING, "description" => "The fully qualified name of the JDBC driver class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" => "read-only", "storage" => "runtime" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-properties" => { "type" => OBJECT, "description" => "The exception sorter properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["exception-sorter-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-only", "storage" => "runtime" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-only", "storage" => "runtime" }, "initial-pool-size" => { "type" => INT, "description" => "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the datasource", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "jta" => { "type" => BOOLEAN, "description" => "Enable JTA integration", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "max-pool-size" => { "type" => INT, "description" => "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-only", "storage" => "runtime" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "min-pool-size" => { "type" => INT, "description" => "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-only", "storage" => "runtime" }, "new-connection-sql" => { "type" => STRING, "description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "password" => { "type" => STRING, "description" => "Specifies the password used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "requires" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool should use be fair", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "prepared-statements-cache-size" => { "type" => LONG, "description" => "The number of prepared statements per connection in an LRU cache", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "query-timeout" => { "type" => LONG, "description" => "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the reauthentication plugin", "expressions-allowed" => true, "nillable" => true, "requires" => ["reauth-plugin-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "set-tx-query-timeout" => { "type" => BOOLEAN, "description" => "Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "share-prepared-statements" => { "type" => BOOLEAN, "description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "spy" => { "type" => BOOLEAN, "description" => "Enable spying of SQL statements", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-properties" => { "type" => OBJECT, "description" => "The stale connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["stale-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "track-statements" => { "type" => STRING, "description" => "Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: \"false\" - do not track statements, \"true\" - track statements and result sets and warn when they are not closed, \"nowarn\" - track statements but do not warn about them being unclosed", "expressions-allowed" => true, "nillable" => true, "default" => "NOWARN", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "transaction-isolation" => { "type" => STRING, "description" => "Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-delimiter" => { "type" => STRING, "description" => "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-selector-strategy-class-name" => { "type" => STRING, "description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-try-lock" => { "type" => LONG, "description" => "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "user-name" => { "type" => STRING, "description" => "Specify the user name used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-properties" => { "type" => OBJECT, "description" => "The valid connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["valid-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"connection-properties" => { "description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method", "model-description" => {"*" => { "description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method", "access-constraints" => {"application" => { "data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => {"value" => { "type" => STRING, "description" => "Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "xa-data-source" => { "description" => "A JDBC XA data-source configuration", "model-description" => {"*" => { "description" => "A JDBC XA data-source configuration", "access-constraints" => {"application" => { "xa-data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allow-multiple-users" => { "type" => BOOLEAN, "description" => "Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "check-valid-connection-sql" => { "type" => STRING, "description" => "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR for this datasource. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-class" => { "type" => STRING, "description" => "Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-property" => { "type" => OBJECT, "description" => "Properties to be injected in class specified in connection-listener-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" => "read-only", "storage" => "runtime" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-properties" => { "type" => OBJECT, "description" => "The exception sorter properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["exception-sorter-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-only", "storage" => "runtime" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-only", "storage" => "runtime" }, "initial-pool-size" => { "type" => INT, "description" => "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "interleaving" => { "type" => BOOLEAN, "description" => "An element to enable interleaving for XA connections", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the datasource", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "max-pool-size" => { "type" => INT, "description" => "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-only", "storage" => "runtime" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "min-pool-size" => { "type" => INT, "description" => "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-only", "storage" => "runtime" }, "new-connection-sql" => { "type" => STRING, "description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "no-recovery" => { "type" => BOOLEAN, "description" => "Specifies if the connection pool should be excluded from recovery", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "no-tx-separate-pool" => { "type" => BOOLEAN, "description" => "Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "pad-xid" => { "type" => BOOLEAN, "description" => "Should the Xid be padded", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "password" => { "type" => STRING, "description" => "Specifies the password used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "requires" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool should use be fair", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "prepared-statements-cache-size" => { "type" => LONG, "description" => "The number of prepared statements per connection in an LRU cache", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "query-timeout" => { "type" => LONG, "description" => "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the reauthentication plugin", "expressions-allowed" => true, "nillable" => true, "requires" => ["reauth-plugin-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "recovery-password" => { "type" => STRING, "description" => "The password used for recovery", "expressions-allowed" => true, "nillable" => true, "requires" => ["recovery-username"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "recovery-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the recovery plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "recovery-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the recovery plugin", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "recovery-security-domain" => { "type" => STRING, "description" => "The security domain used for recovery", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["recovery-username"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "recovery-username" => { "type" => STRING, "description" => "The user name used for recovery", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["recovery-security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "same-rm-override" => { "type" => BOOLEAN, "description" => "The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "set-tx-query-timeout" => { "type" => BOOLEAN, "description" => "Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "share-prepared-statements" => { "type" => BOOLEAN, "description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "spy" => { "type" => BOOLEAN, "description" => "Enable spying of SQL statements", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-properties" => { "type" => OBJECT, "description" => "The stale connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["stale-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "track-statements" => { "type" => STRING, "description" => "Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: \"false\" - do not track statements, \"true\" - track statements and result sets and warn when they are not closed, \"nowarn\" - track statements but do not warn about them being unclosed", "expressions-allowed" => true, "nillable" => true, "default" => "NOWARN", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "transaction-isolation" => { "type" => STRING, "description" => "Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-delimiter" => { "type" => STRING, "description" => "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-property" => { "type" => STRING, "description" => "Specifies the property for the URL property in the xa-datasource-property values", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-selector-strategy-class-name" => { "type" => STRING, "description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-try-lock" => { "type" => LONG, "description" => "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "user-name" => { "type" => STRING, "description" => "Specify the user name used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-properties" => { "type" => OBJECT, "description" => "The valid connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["valid-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "wrap-xa-resource" => { "type" => BOOLEAN, "description" => "Should the XAResource instances be wrapped in an org.jboss.tm.XAResourceWrapper instance", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "xa-datasource-class" => { "type" => STRING, "description" => "The fully qualified name of the javax.sql.XADataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "xa-resource-timeout" => { "type" => INT, "description" => "The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"xa-datasource-properties" => { "description" => "List of xa-datasource-property", "model-description" => {"*" => { "description" => "List of xa-datasource-property", "access-constraints" => {"application" => { "xa-data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => {"value" => { "type" => STRING, "description" => "Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } }, "logging" => { "description" => "Information about the logging configuration for this deployment. Note that this may not be accurate if the deployment is using some other means of configuring a log manager such as logback. The resolved configuration is what loggers not covered by the deployments specific log manager would use.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"configuration" => { "description" => "The configuration being used for the deployment. For configurations within the deployment this is the path to the configuration file used. For logging profiles it's \"profile-\" followed by the name of the profile. Otherwise the value will be \"default\" to indicate it's using the logging configuration as defined by the logging subsystem.", "model-description" => {"*" => { "description" => "Information about the logging configuration for this deployment. Note that this may not be accurate if the deployment is using some other means of configuring a log manager such as logback. The resolved configuration is what loggers not covered by the deployments specific log manager would use.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "pojo" => { "description" => "Describes the configured POJO's being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured POJO's being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the POJO.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the POJO was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the POJO.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "error-manager" => { "description" => "Describes the configured error managers being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured error managers being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the error manager.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the error manager was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the error manager.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "formatter" => { "description" => "Describes the configured formatters being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured formatters being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the formatter.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the formatter was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the formatter.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "filter" => { "description" => "Describes the configured filters being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured filters being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the filter.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the filter was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the filter.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "logger" => { "description" => "Describes the configured loggers being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured loggers being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "filter" => { "type" => STRING, "description" => "The name of the filter set on the logger.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "handlers" => { "type" => LIST, "description" => "Any handlers defined on the logger.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-parent-handlers" => { "type" => BOOLEAN, "description" => "Specifies whether or not this logger sends its output to parent loggers.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "handler" => { "description" => "Describes the configured handlers being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured handlers being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the handler.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "encoding" => { "type" => STRING, "description" => "The encoding the handler has been set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "error-manager" => { "type" => STRING, "description" => "The error manager that was set on the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "filter" => { "type" => STRING, "description" => "The name of the filter set on the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "formatter" => { "type" => STRING, "description" => "The name of the defined formatter that this handler is using.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "handlers" => { "type" => LIST, "description" => "Any sub-handlers defined on the handler.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the handler was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the handler.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }, "batch-jberet" => { "description" => "Information about the batch subsystem for the deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {"job-xml-names" => { "type" => LIST, "description" => "A list of job XML job descriptors found for the deployment.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {"job" => { "description" => "Information about a specific batch job.", "model-description" => {"*" => { "description" => "Information about a specific batch job.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "instance-count" => { "type" => INT, "description" => "The number of instances for the job.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "job-xml-names" => { "type" => LIST, "description" => "A list of job XML job descriptors found that describe this job.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "running-executions" => { "type" => INT, "description" => "The number of currently running executions for the job.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"execution" => { "description" => "The execution information for the job with the value of the path being the execution id.", "model-description" => {"*" => { "description" => "The execution information for the job with the value of the path being the execution id.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "batch-status" => { "type" => STRING, "description" => "The status of the execution.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "create-time" => { "type" => STRING, "description" => "The time the execution was created in ISO 8601 format.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "end-time" => { "type" => STRING, "description" => "The time, in ISO 8601 format, the execution entered a status of: COMPLETED, STOPPED or FAILED", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "exit-status" => { "type" => STRING, "description" => "The exit status of the execution.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "instance-id" => { "type" => LONG, "description" => "The instance id for the execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "last-updated-time" => { "type" => STRING, "description" => "The time the execution was last updated in ISO 8601 format.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "start-time" => { "type" => STRING, "description" => "The time the execution entered the STARTED status in ISO 8601 format.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} } } }, "subdeployment" => { "description" => "Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.", "model-description" => {"*" => { "description" => "A deployment represents anything that can be deployed (e.g. an application such as EJB-JAR, WAR, EAR, any kind of standard archive such as RAR or JBoss-specific deployment) into a server.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"subsystem" => { "description" => "Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.", "model-description" => { "jaxrs" => { "description" => "The configuration of the JAX-RS subsystem.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {} }, "webservices" => { "description" => "Runtime resources exposed by web service components in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"endpoint" => { "description" => "WS endpoint", "model-description" => {"*" => { "description" => "WS endpoint", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "average-processing-time" => { "type" => INT, "description" => "Average endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "class" => { "type" => STRING, "description" => "Webservice endpoint class.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "context" => { "type" => STRING, "description" => "Webservice endpoint context.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "fault-count" => { "type" => INT, "description" => "Count of faults the endpoint generated.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-processing-time" => { "type" => INT, "description" => "Maximal endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "min-processing-time" => { "type" => INT, "description" => "Minimal endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "name" => { "type" => STRING, "description" => "Webservice endpoint name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "request-count" => { "type" => INT, "description" => "Count of requests the endpoint processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "response-count" => { "type" => INT, "description" => "Count of responses the endpoint generated.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "total-processing-time" => { "type" => INT, "description" => "Total endpoint processing time.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "type" => { "type" => STRING, "description" => "Webservice endpoint type.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "wsdl-url" => { "type" => STRING, "description" => "Webservice endpoint WSDL URL. If wsdl-host is set to jbossws.undefined.host, JBossWS uses the requester host when rewriting the ", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }, "jpa" => { "description" => "The configuration of the JPA subsystem.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "default-datasource" => { "type" => STRING, "description" => "The name of the default global datasource.", "expressions-allowed" => true, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-extended-persistence-inheritance" => { "type" => STRING, "description" => "Controls how JPA extended persistence context (XPC) inheritance is performed. 'DEEP' shares the extended persistence context at top bean level. 'SHALLOW' the extended persistece context is only shared with the parent bean (never with sibling beans).", "expressions-allowed" => true, "nillable" => true, "default" => "DEEP", "allowed" => [ "DEEP", "SHALLOW" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }, "messaging-activemq" => { "description" => "Runtime resources exposed by messaging resources included in this deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"server" => { "description" => "An ActiveMQ server instance.", "model-description" => {"*" => { "description" => "An ActiveMQ server instance.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "jms-topic" => { "description" => "Defines a JMS topic.", "model-description" => {"*" => { "description" => "Defines a JMS topic.", "access-constraints" => {"application" => { "jms-topic" => {"type" => "messaging-activemq"}, "deployment" => {"type" => "core"} }}, "attributes" => { "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable-message-count" => { "type" => INT, "description" => "The number of messages for all durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable-subscription-count" => { "type" => INT, "description" => "The number of durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "entries" => { "type" => LIST, "description" => "The jndi names the topic will be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "legacy-entries" => { "type" => LIST, "description" => "The legacy jndi names the topic will be bound to.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "non-durable-message-count" => { "type" => INT, "description" => "The number of messages for all non-durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "non-durable-subscription-count" => { "type" => INT, "description" => "The number of non-durable subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "subscription-count" => { "type" => INT, "description" => "The number of (durable and non-durable) subscribers for this topic.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the topic is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "topic-address" => { "type" => STRING, "description" => "The address the topic points to.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "jms-queue" => { "description" => "Defines a JMS queue.", "model-description" => {"*" => { "description" => "Defines a JMS queue.", "access-constraints" => {"application" => { "jms-queue" => {"type" => "messaging-activemq"}, "deployment" => {"type" => "core"} }}, "attributes" => { "consumer-count" => { "type" => INT, "description" => "The number of consumers consuming messages from this queue.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "dead-letter-address" => { "type" => STRING, "description" => "The address to send dead messages to.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "delivering-count" => { "type" => INT, "description" => "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "durable" => { "type" => BOOLEAN, "description" => "Whether the queue is durable or not.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "entries" => { "type" => LIST, "description" => "The jndi names the queue will be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "expiry-address" => { "type" => STRING, "description" => "The address to send expired messages to.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "legacy-entries" => { "type" => LIST, "description" => "The jndi names the queue will be bound to.", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "message-count" => { "type" => LONG, "description" => "The number of messages currently in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "messages-added" => { "type" => LONG, "description" => "The number of messages added to this queue since it was created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "paused" => { "type" => BOOLEAN, "description" => "Whether the queue is paused.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "queue-address" => { "type" => STRING, "description" => "The queue address defines what address is used for routing messages.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "scheduled-count" => { "type" => LONG, "description" => "The number of scheduled messages in this queue.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "selector" => { "type" => STRING, "description" => "The queue selector.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "temporary" => { "type" => BOOLEAN, "description" => "Whether the queue is temporary.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "pooled-connection-factory" => { "description" => "Defines a managed connection factory.", "model-description" => {"*" => { "description" => "Defines a managed connection factory.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "auto-group" => { "type" => BOOLEAN, "description" => "The autogroup.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "block-on-acknowledge" => { "type" => BOOLEAN, "description" => "True to set block on acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "block-on-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on durable send.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "block-on-non-durable-send" => { "type" => BOOLEAN, "description" => "True to set block on non durable send.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "cache-large-message-client" => { "type" => BOOLEAN, "description" => "True to cache large messages.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "call-failover-timeout" => { "type" => LONG, "description" => "The timeout to use when fail over is in process (in ms).", "expressions-allowed" => true, "nillable" => true, "default" => -1L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "call-timeout" => { "type" => LONG, "description" => "The call time out.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "client-failure-check-period" => { "type" => LONG, "description" => "The client failure check period.", "expressions-allowed" => true, "nillable" => true, "default" => 30000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "client-id" => { "type" => STRING, "description" => "The client id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "compress-large-messages" => { "type" => BOOLEAN, "description" => "Whether large messages should be compressed.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "confirmation-window-size" => { "type" => INT, "description" => "The confirmation window size.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "connection-load-balancing-policy-class-name" => { "type" => STRING, "description" => "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.", "expressions-allowed" => false, "nillable" => true, "default" => "org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "connection-ttl" => { "type" => LONG, "description" => "The connection ttl.", "expressions-allowed" => true, "nillable" => true, "default" => 60000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "connectors" => { "type" => LIST, "description" => "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["discovery-group"], "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "consumer-max-rate" => { "type" => INT, "description" => "The consumer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-only", "storage" => "configuration" }, "consumer-window-size" => { "type" => INT, "description" => "The consumer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "discovery-group" => { "type" => STRING, "description" => "The discovery group name.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["connectors"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "dups-ok-batch-size" => { "type" => INT, "description" => "The dups ok batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-only", "storage" => "configuration" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "entries" => { "type" => LIST, "description" => "The jndi names the connection factory should be bound to.", "expressions-allowed" => true, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "configuration" }, "failover-on-initial-connection" => { "type" => BOOLEAN, "description" => "True to fail over on initial connection.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "group-id" => { "type" => STRING, "description" => "The group id.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "ha" => { "type" => BOOLEAN, "description" => "Whether the connection factory supports High Availability.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "initial-connect-attempts" => { "type" => INT, "description" => "The number of attempts to connect initially with this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1, "access-type" => "read-only", "storage" => "configuration" }, "initial-message-packet-size" => { "type" => INT, "description" => "The initial size of messages created through this factory.", "expressions-allowed" => true, "nillable" => true, "default" => 1500, "access-type" => "read-only", "storage" => "configuration" }, "managed-connection-pool" => { "type" => STRING, "description" => "The class name of the managed connection pool used by this pooled-connection-factory.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "max-pool-size" => { "type" => INT, "description" => "The maximum size for the pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-only", "storage" => "configuration" }, "max-retry-interval" => { "type" => LONG, "description" => "The max retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "min-large-message-size" => { "type" => INT, "description" => "The min large message size.", "expressions-allowed" => true, "nillable" => true, "default" => 102400, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "min-pool-size" => { "type" => INT, "description" => "The minimum size for the pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-only", "storage" => "configuration" }, "password" => { "type" => STRING, "description" => "The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-only", "storage" => "configuration" }, "pre-acknowledge" => { "type" => BOOLEAN, "description" => "True to pre-acknowledge.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "producer-max-rate" => { "type" => INT, "description" => "The producer max rate.", "expressions-allowed" => true, "nillable" => true, "default" => -1, "unit" => "PER_SECOND", "access-type" => "read-only", "storage" => "configuration" }, "producer-window-size" => { "type" => INT, "description" => "The producer window size.", "expressions-allowed" => true, "nillable" => true, "default" => 65536, "unit" => "BYTES", "access-type" => "read-only", "storage" => "configuration" }, "protocol-manager-factory" => { "type" => STRING, "description" => "The protocol manager factory used by this pooled connection factory.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "reconnect-attempts" => { "type" => INT, "description" => "The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).", "expressions-allowed" => true, "nillable" => true, "default" => -1, "access-type" => "read-only", "storage" => "configuration" }, "retry-interval" => { "type" => LONG, "description" => "The retry interval.", "expressions-allowed" => true, "nillable" => true, "default" => 2000L, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "retry-interval-multiplier" => { "type" => BIG_DECIMAL, "description" => "The retry interval multiplier.", "expressions-allowed" => true, "nillable" => true, "default" => 1.0, "access-type" => "read-only", "storage" => "configuration" }, "scheduled-thread-pool-max-size" => { "type" => INT, "description" => "The scheduled thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 5, "access-type" => "read-only", "storage" => "configuration" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "thread-pool-max-size" => { "type" => INT, "description" => "The thread pool max size.", "expressions-allowed" => true, "nillable" => true, "default" => 30, "access-type" => "read-only", "storage" => "configuration" }, "transaction" => { "type" => STRING, "description" => "The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).", "expressions-allowed" => true, "nillable" => true, "default" => "transaction", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "transaction-batch-size" => { "type" => INT, "description" => "The transaction batch size.", "expressions-allowed" => true, "nillable" => true, "default" => 1048576, "access-type" => "read-only", "storage" => "configuration" }, "use-auto-recovery" => { "type" => BOOLEAN, "description" => "True to use auto recovery.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "use-global-pools" => { "type" => BOOLEAN, "description" => "True to use global pools.", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "configuration" }, "user" => { "type" => STRING, "description" => "The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "messaging-security" => {"type" => "messaging-activemq"} }}, "access-type" => "read-only", "storage" => "configuration" }, "jndi-params" => { "type" => STRING, "description" => "The JNDI params to use for locating the destination for incoming connections.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "rebalance-connections" => { "type" => BOOLEAN, "description" => "Rebalance inbound connections when cluster topology changes.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "configuration" }, "setup-attempts" => { "type" => INT, "description" => "The number of times to set up an MDB endpoint", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "setup-interval" => { "type" => LONG, "description" => "The interval between attempts at setting up an MDB endpoint.", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "configuration" }, "use-jndi" => { "type" => BOOLEAN, "description" => "Use JNDI to locate the destination for incoming connections", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" }, "use-local-tx" => { "type" => BOOLEAN, "description" => "Use a local transaction for incoming sessions", "attribute-group" => "inbound-config", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "configuration" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }, "ejb3" => { "description" => "Runtime resources exposed by EJBs components included in this deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "stateful-session-bean" => { "description" => "Stateful session bean component included in the deployment.", "model-description" => {"*" => { "description" => "Stateful session bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "cache-size" => { "type" => LONG, "description" => "Cache size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "passivated-count" => { "type" => LONG, "description" => "Passivated count.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "total-size" => { "type" => LONG, "description" => "Total size.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "stateless-session-bean" => { "description" => "Stateless session bean component included in the deployment.", "model-description" => {"*" => { "description" => "Stateless session bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "pool-available-count" => { "type" => INT, "description" => "The number of available (i.e. not in use) instances in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-create-count" => { "type" => INT, "description" => "The number of bean instances that have been created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-current-size" => { "type" => INT, "description" => "The current size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-max-size" => { "type" => INT, "description" => "The maximum size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "pool-name" => { "type" => STRING, "description" => "The name of the pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "pool-remove-count" => { "type" => INT, "description" => "The number of bean instances that have been removed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "timers" => { "type" => LIST, "description" => "EJB timers associated with the component.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "time-remaining" => { "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "MILLISECONDS" }, "next-timeout" => { "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "calendar-timer" => { "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "persistent" => { "description" => "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "schedule" => { "description" => "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "type" => OBJECT, "nillable" => true, "value-type" => { "year" => { "description" => "A particular calendar year.", "type" => STRING, "nillable" => true }, "month" => { "description" => "One or more months within a year.", "type" => STRING, "nillable" => true }, "day-of-month" => { "description" => "One or more days within a month.", "type" => STRING, "nillable" => true }, "day-of-week" => { "description" => "One or more days within a week.", "type" => STRING, "nillable" => true }, "hour" => { "description" => "One or more hours within a day.", "type" => STRING, "nillable" => true }, "minute" => { "description" => "One or more minutes within an hour.", "type" => STRING, "nillable" => true }, "second" => { "description" => "One or more seconds within a minute.", "type" => STRING, "nillable" => true }, "timezone" => { "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "type" => STRING, "nillable" => true }, "start" => { "description" => "The start date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "end" => { "description" => "The end date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" } } } }, "access-type" => "read-only", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "singleton-bean" => { "description" => "Singleton bean component included in the deployment.", "model-description" => {"*" => { "description" => "Singleton bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "timers" => { "type" => LIST, "description" => "EJB timers associated with the component.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "time-remaining" => { "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "MILLISECONDS" }, "next-timeout" => { "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "calendar-timer" => { "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "persistent" => { "description" => "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "schedule" => { "description" => "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "type" => OBJECT, "nillable" => true, "value-type" => { "year" => { "description" => "A particular calendar year.", "type" => STRING, "nillable" => true }, "month" => { "description" => "One or more months within a year.", "type" => STRING, "nillable" => true }, "day-of-month" => { "description" => "One or more days within a month.", "type" => STRING, "nillable" => true }, "day-of-week" => { "description" => "One or more days within a week.", "type" => STRING, "nillable" => true }, "hour" => { "description" => "One or more hours within a day.", "type" => STRING, "nillable" => true }, "minute" => { "description" => "One or more minutes within an hour.", "type" => STRING, "nillable" => true }, "second" => { "description" => "One or more seconds within a minute.", "type" => STRING, "nillable" => true }, "timezone" => { "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "type" => STRING, "nillable" => true }, "start" => { "description" => "The start date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "end" => { "description" => "The end date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" } } } }, "access-type" => "read-only", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} }, "message-driven-bean" => { "description" => "Message driven bean component included in the deployment.", "model-description" => {"*" => { "description" => "Message driven bean component included in the deployment.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "component-class-name" => { "type" => STRING, "description" => "The component's class name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "declared-roles" => { "type" => LIST, "description" => "The roles declared (via @DeclareRoles) on this EJB component.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "delivery-active" => { "type" => BOOLEAN, "description" => "Indicates whether messages are delivered to this message-driven bean.", "expressions-allowed" => false, "nillable" => false, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "execution-time" => { "type" => LONG, "description" => "Time spend within a bean method.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "methods" => { "type" => OBJECT, "description" => "Invocation metrics per method.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "execution-time" => { "type" => LONG, "description" => "Time spend within this bean method.", "expressions-allowed" => false, "nillable" => false }, "invocations" => { "type" => LONG, "description" => "Number of invocations processed.", "expressions-allowed" => false, "nillable" => false }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false } }, "access-type" => "metric", "storage" => "runtime" }, "peak-concurrent-invocations" => { "type" => LONG, "description" => "Peak concurrent invocations.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "pool-available-count" => { "type" => INT, "description" => "The number of available (i.e. not in use) instances in the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-create-count" => { "type" => INT, "description" => "The number of bean instances that have been created.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-current-size" => { "type" => INT, "description" => "The current size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-max-size" => { "type" => INT, "description" => "The maximum size of the pool.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-write", "storage" => "runtime", "restart-required" => "no-services" }, "pool-name" => { "type" => STRING, "description" => "The name of the pool.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "pool-remove-count" => { "type" => INT, "description" => "The number of bean instances that have been removed.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "run-as-role" => { "type" => STRING, "description" => "The run-as role (if any) for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The security domain for this EJB component.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "timers" => { "type" => LIST, "description" => "EJB timers associated with the component.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "time-remaining" => { "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "MILLISECONDS" }, "next-timeout" => { "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "calendar-timer" => { "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "persistent" => { "description" => "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "type" => BOOLEAN, "nillable" => true }, "schedule" => { "description" => "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "type" => OBJECT, "nillable" => true, "value-type" => { "year" => { "description" => "A particular calendar year.", "type" => STRING, "nillable" => true }, "month" => { "description" => "One or more months within a year.", "type" => STRING, "nillable" => true }, "day-of-month" => { "description" => "One or more days within a month.", "type" => STRING, "nillable" => true }, "day-of-week" => { "description" => "One or more days within a week.", "type" => STRING, "nillable" => true }, "hour" => { "description" => "One or more hours within a day.", "type" => STRING, "nillable" => true }, "minute" => { "description" => "One or more minutes within an hour.", "type" => STRING, "nillable" => true }, "second" => { "description" => "One or more seconds within a minute.", "type" => STRING, "nillable" => true }, "timezone" => { "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "type" => STRING, "nillable" => true }, "start" => { "description" => "The start date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" }, "end" => { "description" => "The end date for the timer, in ms since the epoch.", "type" => LONG, "nillable" => true, "unit" => "EPOCH_MILLISECONDS" } } } }, "access-type" => "read-only", "storage" => "runtime" }, "wait-time" => { "type" => LONG, "description" => "Time spend waiting to obtain an instance.", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"service" => { "description" => "Centrally configurable services that are part of the EJB3 subsystem.", "model-description" => {"timer-service" => { "description" => "The EJB timer service", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"timer" => { "description" => "Actual timer running for EJB", "model-description" => {"*" => { "description" => "Actual timer running for EJB", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active" => { "type" => BOOLEAN, "description" => "Indicates whether this timer is active or suspended.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "calendar-timer" => { "type" => BOOLEAN, "description" => "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "info" => { "type" => STRING, "description" => "Serializable information associated with timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "next-timeout" => { "type" => LONG, "description" => "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "persistent" => { "type" => BOOLEAN, "description" => "Whether this timer has persistent semantics or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "primary-key" => { "type" => STRING, "description" => "Primary key of EJB instance which started the timer.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "schedule" => { "type" => LIST, "description" => "The schedule expression corresponding to this timer or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => false, "value-type" => { "year" => { "type" => STRING, "description" => "A particular calendar year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "month" => { "type" => STRING, "description" => "One or more months within a year.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-month" => { "type" => STRING, "description" => "One or more days within a month.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "day-of-week" => { "type" => STRING, "description" => "One or more days within a week.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "hour" => { "type" => STRING, "description" => "One or more hours within a day.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "minute" => { "type" => STRING, "description" => "One or more minutes within an hour.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "second" => { "type" => STRING, "description" => "One or more seconds within a minute.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "timezone" => { "type" => STRING, "description" => "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "start" => { "type" => LONG, "description" => "The start date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true }, "end" => { "type" => LONG, "description" => "The end date for the timer, in ms since the epoch.", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-only", "storage" => "configuration" }, "time-remaining" => { "type" => LONG, "description" => "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} }} } } }, "undertow" => { "description" => "A deployment", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "active-sessions" => { "type" => INT, "description" => "Number of active sessions", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "context-root" => { "type" => STRING, "description" => "The context root of the web application", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "expired-sessions" => { "type" => INT, "description" => "Number of sessions that have expired", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "max-active-sessions" => { "type" => INT, "description" => "Max number of concurrent active sessions", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "rejected-sessions" => { "type" => INT, "description" => "Number of rejected sessions", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "server" => { "type" => STRING, "description" => "The name of server this application belongs to", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "session-avg-alive-time" => { "type" => INT, "description" => "Average time (in seconds) that expired sessions had been alive", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "session-max-alive-time" => { "type" => INT, "description" => "The longest time (in seconds) that an expired session had been alive", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "sessions-created" => { "type" => INT, "description" => "Total sessions created", "expressions-allowed" => false, "nillable" => false, "access-type" => "metric", "storage" => "runtime" }, "virtual-host" => { "type" => STRING, "description" => "The name of the virtual host on which the web application is served", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => { "servlet" => { "description" => "Servlet", "model-description" => {"*" => { "description" => "Servlet", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "mappings" => { "type" => LIST, "description" => "Servlet mappings", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "metric", "storage" => "runtime" }, "max-request-time" => { "type" => LONG, "description" => "Maximal time for processing request", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "min-request-time" => { "type" => LONG, "description" => "Minimal time for processing request", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "request-count" => { "type" => LONG, "description" => "Number of all requests", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "servlet-class" => { "type" => STRING, "description" => "Class of the servlet", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "servlet-name" => { "type" => STRING, "description" => "Name of the servlet", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "total-request-time" => { "type" => LONG, "description" => "Total time spend in processing all requests", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "websocket" => { "description" => "Websocket", "model-description" => {"*" => { "description" => "Websocket", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "endpoint-class" => { "type" => STRING, "description" => "The endpoint class", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "path" => { "type" => STRING, "description" => "The path the endpoint is deployed to", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }, "datasources" => { "description" => "The data-sources subsystem, used to declare JDBC data-sources", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "data-source" => { "description" => "A JDBC data-source configuration", "model-description" => {"*" => { "description" => "A JDBC data-source configuration", "access-constraints" => {"application" => { "data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allow-multiple-users" => { "type" => BOOLEAN, "description" => "Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to be injected in class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to be injected in class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "check-valid-connection-sql" => { "type" => STRING, "description" => "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-class" => { "type" => STRING, "description" => "Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-property" => { "type" => OBJECT, "description" => "Properties to be injected in class specidied in connection-listener-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "connection-url" => { "type" => STRING, "description" => "The JDBC driver connection URL", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "datasource-class" => { "type" => STRING, "description" => "The fully qualified name of the JDBC datasource class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "driver-class" => { "type" => STRING, "description" => "The fully qualified name of the JDBC driver class", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" => "read-only", "storage" => "runtime" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-properties" => { "type" => OBJECT, "description" => "The exception sorter properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["exception-sorter-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-only", "storage" => "runtime" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-only", "storage" => "runtime" }, "initial-pool-size" => { "type" => INT, "description" => "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the datasource", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "jta" => { "type" => BOOLEAN, "description" => "Enable JTA integration", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "max-pool-size" => { "type" => INT, "description" => "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-only", "storage" => "runtime" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "min-pool-size" => { "type" => INT, "description" => "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-only", "storage" => "runtime" }, "new-connection-sql" => { "type" => STRING, "description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "password" => { "type" => STRING, "description" => "Specifies the password used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "requires" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool should use be fair", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "prepared-statements-cache-size" => { "type" => LONG, "description" => "The number of prepared statements per connection in an LRU cache", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "query-timeout" => { "type" => LONG, "description" => "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the reauthentication plugin", "expressions-allowed" => true, "nillable" => true, "requires" => ["reauth-plugin-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "set-tx-query-timeout" => { "type" => BOOLEAN, "description" => "Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "share-prepared-statements" => { "type" => BOOLEAN, "description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "spy" => { "type" => BOOLEAN, "description" => "Enable spying of SQL statements", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-properties" => { "type" => OBJECT, "description" => "The stale connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["stale-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "track-statements" => { "type" => STRING, "description" => "Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: \"false\" - do not track statements, \"true\" - track statements and result sets and warn when they are not closed, \"nowarn\" - track statements but do not warn about them being unclosed", "expressions-allowed" => true, "nillable" => true, "default" => "NOWARN", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "transaction-isolation" => { "type" => STRING, "description" => "Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-delimiter" => { "type" => STRING, "description" => "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-selector-strategy-class-name" => { "type" => STRING, "description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-try-lock" => { "type" => LONG, "description" => "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "user-name" => { "type" => STRING, "description" => "Specify the user name used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-properties" => { "type" => OBJECT, "description" => "The valid connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["valid-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"connection-properties" => { "description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method", "model-description" => {"*" => { "description" => "The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method", "access-constraints" => {"application" => { "data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => {"value" => { "type" => STRING, "description" => "Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }, "xa-data-source" => { "description" => "A JDBC XA data-source configuration", "model-description" => {"*" => { "description" => "A JDBC XA data-source configuration", "access-constraints" => {"application" => { "xa-data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => { "allocation-retry" => { "type" => INT, "description" => "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allocation-retry-wait-millis" => { "type" => LONG, "description" => "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "allow-multiple-users" => { "type" => BOOLEAN, "description" => "Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "background-validation" => { "type" => BOOLEAN, "description" => "An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "background-validation-millis" => { "type" => LONG, "description" => "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "min" => 1L, "max" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "blocking-timeout-wait-millis" => { "type" => LONG, "description" => "The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time", "expressions-allowed" => true, "nillable" => true, "unit" => "MILLISECONDS", "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-class" => { "type" => STRING, "description" => "Class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-decrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for decrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-class" => { "type" => STRING, "description" => "Class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "capacity-incrementer-properties" => { "type" => OBJECT, "description" => "Properties to inject in class defining the policy for incrementing connections in the pool", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "check-valid-connection-sql" => { "type" => STRING, "description" => "Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connectable" => { "type" => BOOLEAN, "description" => "Enable the use of CMR for this datasource. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-class" => { "type" => STRING, "description" => "Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "connection-listener-property" => { "type" => OBJECT, "description" => "Properties to be injected in class specified in connection-listener-class", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "driver-name" => { "type" => STRING, "description" => "Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "enabled" => { "type" => BOOLEAN, "description" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions.", "expressions-allowed" => true, "nillable" => true, "default" => true, "deprecated" => { "since" => "3.0.0", "reason" => "Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions." }, "access-type" => "read-only", "storage" => "runtime" }, "enlistment-trace" => { "type" => BOOLEAN, "description" => "Defines if WildFly/IronJacamar should record enlistment traces", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "exception-sorter-properties" => { "type" => OBJECT, "description" => "The exception sorter properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["exception-sorter-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "flush-strategy" => { "type" => STRING, "description" => "Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool", "expressions-allowed" => true, "nillable" => true, "default" => "FailingConnectionOnly", "allowed" => [ "UNKNOWN", "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "access-type" => "read-only", "storage" => "runtime" }, "idle-timeout-minutes" => { "type" => LONG, "description" => "The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "unit" => "MINUTES", "access-type" => "read-only", "storage" => "runtime" }, "initial-pool-size" => { "type" => INT, "description" => "The initial-pool-size element indicates the initial number of connections a pool should hold.", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "interleaving" => { "type" => BOOLEAN, "description" => "An element to enable interleaving for XA connections", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "jndi-name" => { "type" => STRING, "description" => "Specifies the JNDI name for the datasource", "expressions-allowed" => true, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "max-pool-size" => { "type" => INT, "description" => "The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool", "expressions-allowed" => true, "nillable" => true, "default" => 20, "access-type" => "read-only", "storage" => "runtime" }, "mcp" => { "type" => STRING, "description" => "Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool", "expressions-allowed" => true, "nillable" => true, "default" => "org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreConcurrentLinkedDequeManagedConnectionPool", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "min-pool-size" => { "type" => INT, "description" => "The min-pool-size element specifies the minimum number of connections for a pool", "expressions-allowed" => true, "nillable" => true, "default" => 0, "access-type" => "read-only", "storage" => "runtime" }, "new-connection-sql" => { "type" => STRING, "description" => "Specifies an SQL statement to execute whenever a connection is added to the connection pool", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "no-recovery" => { "type" => BOOLEAN, "description" => "Specifies if the connection pool should be excluded from recovery", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "no-tx-separate-pool" => { "type" => BOOLEAN, "description" => "Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "pad-xid" => { "type" => BOOLEAN, "description" => "Should the Xid be padded", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "password" => { "type" => STRING, "description" => "Specifies the password used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "requires" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "pool-fair" => { "type" => BOOLEAN, "description" => "Defines if pool should use be fair", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "pool-prefill" => { "type" => BOOLEAN, "description" => "Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "pool-use-strict-min" => { "type" => BOOLEAN, "description" => "Specifies if the min-pool-size should be considered strictly", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "prepared-statements-cache-size" => { "type" => LONG, "description" => "The number of prepared statements per connection in an LRU cache", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "query-timeout" => { "type" => LONG, "description" => "Any configured query timeout in seconds. If not provided no timeout will be set", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the reauthentication plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "reauth-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the reauthentication plugin", "expressions-allowed" => true, "nillable" => true, "requires" => ["reauth-plugin-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "recovery-password" => { "type" => STRING, "description" => "The password used for recovery", "expressions-allowed" => true, "nillable" => true, "requires" => ["recovery-username"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "recovery-plugin-class-name" => { "type" => STRING, "description" => "The fully qualified class name of the recovery plugin implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "recovery-plugin-properties" => { "type" => OBJECT, "description" => "The properties for the recovery plugin", "expressions-allowed" => true, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "recovery-security-domain" => { "type" => STRING, "description" => "The security domain used for recovery", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["recovery-username"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "recovery-username" => { "type" => STRING, "description" => "The user name used for recovery", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["recovery-security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "access-type" => "read-only", "storage" => "runtime" }, "same-rm-override" => { "type" => BOOLEAN, "description" => "The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["user-name"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "security-domain-ref" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "set-tx-query-timeout" => { "type" => BOOLEAN, "description" => "Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "share-prepared-statements" => { "type" => BOOLEAN, "description" => "Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "spy" => { "type" => BOOLEAN, "description" => "Enable spying of SQL statements", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "stale-connection-checker-properties" => { "type" => OBJECT, "description" => "The stale connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["stale-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Define whether runtime statistics are enabled or not.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "track-statements" => { "type" => STRING, "description" => "Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: \"false\" - do not track statements, \"true\" - track statements and result sets and warn when they are not closed, \"nowarn\" - track statements but do not warn about them being unclosed", "expressions-allowed" => true, "nillable" => true, "default" => "NOWARN", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "tracking" => { "type" => BOOLEAN, "description" => "Defines if IronJacamar should track connection handles across transaction boundaries", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "transaction-isolation" => { "type" => STRING, "description" => "Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-delimiter" => { "type" => STRING, "description" => "Specifies the delimiter for URLs in connection-url for HA datasources", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-property" => { "type" => STRING, "description" => "Specifies the property for the URL property in the xa-datasource-property values", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "url-selector-strategy-class-name" => { "type" => STRING, "description" => "A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-ccm" => { "type" => BOOLEAN, "description" => "Enable the use of a cached connection manager", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-fast-fail" => { "type" => BOOLEAN, "description" => "Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-only", "storage" => "runtime" }, "use-java-context" => { "type" => BOOLEAN, "description" => "Setting this to false will bind the datasource into global JNDI", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "use-try-lock" => { "type" => LONG, "description" => "Any configured timeout for internal locks on the resource adapter objects in seconds", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "user-name" => { "type" => STRING, "description" => "Specify the user name used when creating a new connection", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["security-domain"], "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => { "credential" => {"type" => "core"}, "data-source-security" => {"type" => "datasources"} }}, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-class-name" => { "type" => STRING, "description" => "An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "valid-connection-checker-properties" => { "type" => OBJECT, "description" => "The valid connection checker properties", "expressions-allowed" => true, "nillable" => true, "requires" => ["valid-connection-checker-class-name"], "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "validate-on-match" => { "type" => BOOLEAN, "description" => "The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" }, "wrap-xa-resource" => { "type" => BOOLEAN, "description" => "Should the XAResource instances be wrapped in an org.jboss.tm.XAResourceWrapper instance", "expressions-allowed" => true, "nillable" => true, "default" => true, "access-type" => "read-only", "storage" => "runtime" }, "xa-datasource-class" => { "type" => STRING, "description" => "The fully qualified name of the javax.sql.XADataSource implementation", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "xa-resource-timeout" => { "type" => INT, "description" => "The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero", "expressions-allowed" => true, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"xa-datasource-properties" => { "description" => "List of xa-datasource-property", "model-description" => {"*" => { "description" => "List of xa-datasource-property", "access-constraints" => {"application" => { "xa-data-source" => {"type" => "datasources"}, "deployment" => {"type" => "core"} }}, "attributes" => {"value" => { "type" => STRING, "description" => "Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} } } }, "logging" => { "description" => "Information about the logging configuration for this deployment. Note that this may not be accurate if the deployment is using some other means of configuring a log manager such as logback. The resolved configuration is what loggers not covered by the deployments specific log manager would use.", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => {"configuration" => { "description" => "The configuration being used for the deployment. For configurations within the deployment this is the path to the configuration file used. For logging profiles it's \"profile-\" followed by the name of the profile. Otherwise the value will be \"default\" to indicate it's using the logging configuration as defined by the logging subsystem.", "model-description" => {"*" => { "description" => "Information about the logging configuration for this deployment. Note that this may not be accurate if the deployment is using some other means of configuring a log manager such as logback. The resolved configuration is what loggers not covered by the deployments specific log manager would use.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {}, "operations" => undefined, "notifications" => undefined, "children" => { "pojo" => { "description" => "Describes the configured POJO's being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured POJO's being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the POJO.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the POJO was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the POJO.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "error-manager" => { "description" => "Describes the configured error managers being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured error managers being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the error manager.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the error manager was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the error manager.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "formatter" => { "description" => "Describes the configured formatters being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured formatters being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the formatter.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the formatter was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the formatter.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "filter" => { "description" => "Describes the configured filters being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured filters being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the filter.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the filter was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the filter.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "logger" => { "description" => "Describes the configured loggers being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured loggers being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "filter" => { "type" => STRING, "description" => "The name of the filter set on the logger.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "handlers" => { "type" => LIST, "description" => "Any handlers defined on the logger.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "use-parent-handlers" => { "type" => BOOLEAN, "description" => "Specifies whether or not this logger sends its output to parent loggers.", "expressions-allowed" => false, "nillable" => true, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "handler" => { "description" => "Describes the configured handlers being used on a deployment.", "model-description" => {"*" => { "description" => "Describes the configured handlers being used on a deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "The class name for the handler.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "encoding" => { "type" => STRING, "description" => "The encoding the handler has been set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "error-manager" => { "type" => STRING, "description" => "The error manager that was set on the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "filter" => { "type" => STRING, "description" => "The name of the filter set on the handler.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "formatter" => { "type" => STRING, "description" => "The name of the defined formatter that this handler is using.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "handlers" => { "type" => LIST, "description" => "Any sub-handlers defined on the handler.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "module" => { "type" => STRING, "description" => "The module name the handler was set to use.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "properties" => { "type" => OBJECT, "description" => "Additional properties that were set on the handler.", "expressions-allowed" => false, "nillable" => true, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }} }, "batch-jberet" => { "description" => "Information about the batch subsystem for the deployment.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => {"job-xml-names" => { "type" => LIST, "description" => "A list of job XML job descriptors found for the deployment.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }}, "operations" => undefined, "notifications" => undefined, "children" => {"job" => { "description" => "Information about a specific batch job.", "model-description" => {"*" => { "description" => "Information about a specific batch job.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "instance-count" => { "type" => INT, "description" => "The number of instances for the job.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "job-xml-names" => { "type" => LIST, "description" => "A list of job XML job descriptors found that describe this job.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "running-executions" => { "type" => INT, "description" => "The number of currently running executions for the job.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {"execution" => { "description" => "The execution information for the job with the value of the path being the execution id.", "model-description" => {"*" => { "description" => "The execution information for the job with the value of the path being the execution id.", "storage" => "runtime-only", "access-constraints" => {"application" => {"deployment" => {"type" => "core"}}}, "attributes" => { "batch-status" => { "type" => STRING, "description" => "The status of the execution.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "create-time" => { "type" => STRING, "description" => "The time the execution was created in ISO 8601 format.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "end-time" => { "type" => STRING, "description" => "The time, in ISO 8601 format, the execution entered a status of: COMPLETED, STOPPED or FAILED", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "exit-status" => { "type" => STRING, "description" => "The exit status of the execution.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "instance-id" => { "type" => LONG, "description" => "The instance id for the execution.", "expressions-allowed" => false, "nillable" => false, "access-type" => "read-only", "storage" => "runtime" }, "last-updated-time" => { "type" => STRING, "description" => "The time the execution was last updated in ISO 8601 format.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "start-time" => { "type" => STRING, "description" => "The time the execution entered the STARTED status in ISO 8601 format.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }} }} }} } } }} }} } } }} }, "interface" => { "description" => "A list of named network interfaces available for use on the server.", "model-description" => {"*" => { "description" => "Interface definition", "capabilities" => [{ "name" => "org.wildfly.network.interface", "dynamic" => true }], "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "attributes" => { "any" => { "type" => OBJECT, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address meets at least one of a nested set of criteria, but not necessarily all of the nested criteria. The value of the attribute is a set of criteria. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "value-type" => { "inet-address" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either an IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "link-local-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true }, "loopback" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true }, "loopback-address" => { "type" => STRING, "description" => "Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "multicast" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true }, "nic" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "nic-match" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "point-to-point" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "public-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "site-local-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "subnet-match" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in \"slash notation\"; e.g. \"192.168.0.0/16\". An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "up" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "virtual" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "any-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic.", "expressions-allowed" => false, "nillable" => true, "alternatives" => [ "inet-address", "link-local-address", "loopback", "loopback-address", "multicast", "nic", "nic-match", "point-to-point", "public-address", "site-local-address", "subnet-match", "up", "virtual", "any", "not" ], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "inet-address" => { "type" => STRING, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either an IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["any-address"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "link-local-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "loopback" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "loopback-address" => { "type" => STRING, "description" => "Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["any-address"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "multicast" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "name" => { "type" => STRING, "description" => "The name of the interface.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "nic" => { "type" => STRING, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["any-address"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "nic-match" => { "type" => STRING, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["any-address"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "not" => { "type" => OBJECT, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address *does not* meet any of a nested set of criteria. The value of the attribute is a set of criteria (e.g. 'loopback') whose normal meaning is reversed. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "value-type" => { "inet-address" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either an IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "link-local-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true }, "loopback" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true }, "loopback-address" => { "type" => STRING, "description" => "Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L }, "multicast" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => true }, "nic" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "nic-match" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "point-to-point" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "public-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "site-local-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "subnet-match" => { "type" => LIST, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in \"slash notation\"; e.g. \"192.168.0.0/16\". An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => false, "nillable" => false, "value-type" => STRING }, "up" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true }, "virtual" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "point-to-point" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "public-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "resolved-address" => { "type" => STRING, "description" => "Attribute showing the resolved ip address for this interface.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "runtime" }, "site-local-address" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "subnet-match" => { "type" => STRING, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in \"slash notation\"; e.g. \"192.168.0.0/16\". An 'undefined' value means this attribute is not relevant to the IP address selection.", "expressions-allowed" => true, "nillable" => true, "alternatives" => ["any-address"], "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "up" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "virtual" => { "type" => BOOLEAN, "description" => "Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection", "expressions-allowed" => false, "nillable" => true, "alternatives" => ["any-address"], "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "socket-binding-group" => { "description" => "The socket binding group in use on the server.", "model-description" => {"*" => { "description" => "Contains a list of socket configurations.", "capabilities" => [{ "name" => "org.wildfly.domain.socket-binding-group", "dynamic" => true }], "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "attributes" => { "default-interface" => { "type" => STRING, "description" => "Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.", "expressions-allowed" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.interface", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "name" => { "type" => STRING, "description" => "The name of the socket binding group.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "port-offset" => { "type" => INT, "description" => "Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => -65535L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => { "local-destination-outbound-socket-binding" => { "description" => "Configuration information for a, local destination, outbound socket binding.", "model-description" => {"*" => { "description" => "Configuration information for a local destination outbound socket binding.", "capabilities" => [{ "name" => "org.wildfly.network.outbound-socket-binding", "dynamic" => true }], "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "attributes" => { "fixed-source-port" => { "type" => BOOLEAN, "description" => "Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding-ref" => { "type" => STRING, "description" => "The name of the local socket-binding which will be used to determine the port to which this outbound socket connects.", "expressions-allowed" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "source-interface" => { "type" => STRING, "description" => "The name of the interface which will be used for the source address of the outbound socket.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.interface", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "source-port" => { "type" => INT, "description" => "The port number which will be used as the source port of the outbound socket.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "remote-destination-outbound-socket-binding" => { "description" => "Configuration information for a, remote destination, outbound socket binding.", "model-description" => {"*" => { "description" => "Configuration information for a remote destination outbound socket binding.", "capabilities" => [{ "name" => "org.wildfly.network.outbound-socket-binding", "dynamic" => true }], "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "attributes" => { "fixed-source-port" => { "type" => BOOLEAN, "description" => "Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "host" => { "type" => STRING, "description" => "The host name or the IP address of the remote destination to which this outbound socket will connect.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "port" => { "type" => INT, "description" => "The port number of the remote destination to which the outbound socket should connect.", "expressions-allowed" => true, "nillable" => false, "min" => 0L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "source-interface" => { "type" => STRING, "description" => "The name of the interface which will be used for the source address of the outbound socket.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.interface", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "source-port" => { "type" => INT, "description" => "The port number which will be used as the source port of the outbound socket.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} }, "socket-binding" => { "description" => "The individual socket configurations.", "model-description" => {"*" => { "description" => "Configuration information for a socket.", "capabilities" => [{ "name" => "org.wildfly.network.socket-binding", "dynamic" => true }], "access-constraints" => {"sensitive" => {"socket-config" => {"type" => "core"}}}, "attributes" => { "bound" => { "type" => BOOLEAN, "description" => "Whether an actual socket using this socket binding configuration has been bound.", "expressions-allowed" => false, "nillable" => true, "access-type" => "metric", "storage" => "runtime" }, "bound-address" => { "type" => STRING, "description" => "The address to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.", "expressions-allowed" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "metric", "storage" => "runtime" }, "bound-port" => { "type" => INT, "description" => "The port to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.", "expressions-allowed" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "access-type" => "metric", "storage" => "runtime" }, "client-mappings" => { "type" => LIST, "description" => "Specifies zero or more client mappings for this socket binding. A client connecting to this socket should use the destination address specified in the mapping that matches its desired outbound interface. This allows for advanced network topologies that use either network address translation, or have bindings on multiple network interfaces to function. Each mapping should be evaluated in declared order, with the first successful match used to determine the destination.", "expressions-allowed" => false, "nillable" => true, "value-type" => { "source-network" => { "type" => STRING, "description" => "Source network the client connection binds on. This value is in the form of ip/netmask. A client should match this value against the desired client host network interface, and if matched the client should connect to the corresponding destination values. If omitted this mapping should match any interface.", "expressions-allowed" => true, "nillable" => true }, "destination-address" => { "type" => STRING, "description" => "The destination address that a client should connect to if the source-network matches. This value can either be a hostname or an IP address.", "expressions-allowed" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "destination-port" => { "type" => INT, "description" => "The destination port that a client should connect to if the source-network matches. If omitted this mapping will reuse the effective socket binding port.", "expressions-allowed" => true, "nillable" => true, "min" => 0L, "max" => 65535L } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "fixed-port" => { "type" => BOOLEAN, "description" => "Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.", "expressions-allowed" => true, "nillable" => true, "default" => false, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "interface" => { "type" => STRING, "description" => "Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen. This should be one of the declared interfaces.", "expressions-allowed" => true, "nillable" => true, "capability-reference" => "org.wildfly.network.interface", "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "multicast-address" => { "type" => STRING, "description" => "Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.", "expressions-allowed" => true, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "multicast-port" => { "type" => INT, "description" => "Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.", "expressions-allowed" => true, "nillable" => true, "min" => 1L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "name" => { "type" => STRING, "description" => "The name of the socket. Services which need to access the socket configuration information will find it using this name.", "expressions-allowed" => false, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "access-type" => "read-only", "storage" => "configuration" }, "port" => { "type" => INT, "description" => "Number of the port to which the socket should be bound.", "expressions-allowed" => true, "nillable" => true, "default" => 0, "min" => 0L, "max" => 65535L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } }} }, "system-property" => { "description" => "A list of system properties to set on the server.", "model-description" => {"*" => { "description" => "A system property to set on the server.", "access-constraints" => {"sensitive" => {"system-property" => {"type" => "core"}}}, "attributes" => {"value" => { "type" => STRING, "description" => "The value of the system property.", "expressions-allowed" => true, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }}, "operations" => undefined, "notifications" => undefined, "children" => {} }} } } } }