## Provided Capabilities (1)

Name | Dynamic | Other provider points
--- | --- | ---
org.wildfly.logging.handler | true | /subsystem=logging/logging-profile=*/periodic-rotating-file-handler=* /subsystem=logging/periodic-size-rotating-file-handler=* /subsystem=logging/logging-profile=*/custom-handler=* /subsystem=logging/file-handler=* /subsystem=logging/custom-handler=* /subsystem=logging/logging-profile=*/syslog-handler=* /subsystem=logging/logging-profile=*/socket-handler=* /subsystem=logging/logging-profile=*/console-handler=* /subsystem=logging/logging-profile=*/size-rotating-file-handler=* /subsystem=logging/periodic-rotating-file-handler=* /subsystem=logging/logging-profile=*/file-handler=* /subsystem=logging/syslog-handler=* /subsystem=logging/console-handler=* /subsystem=logging/logging-profile=*/periodic-size-rotating-file-handler=* /subsystem=logging/async-handler=* /subsystem=logging/logging-profile=*/async-handler=* /subsystem=logging/size-rotating-file-handler=*

## Attributes (10)

- autoflush - Automatically flush after each write.

  Type | BOOLEAN
  Default Value | true
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Automatically flush after each write.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- block-on-reconnect - If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.

  Type | BOOLEAN
  Default Value | false
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : false,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- enabled - If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.

  Type | BOOLEAN
  Default Value | true
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "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,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- encoding - The character encoding used by this Handler.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The character encoding used by this Handler.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- filter-spec - A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "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,
          "required" : false,
          "nillable" : true,
          "capability-reference" : "org.wildfly.logging.filter",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services"
      }

- level - The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

  Type | STRING
  Default Value | ALL
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Allowed Values | TRACE ALL SEVERE FINER FINEST INFO DEBUG WARNING WARN OFF CONFIG FINE ERROR FATAL
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "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,
          "required" : false,
          "nillable" : true,
          "default" : "ALL",
          "allowed" : [
              "ALL",
              "FINEST",
              "FINER",
              "TRACE",
              "DEBUG",
              "FINE",
              "CONFIG",
              "INFO",
              "WARN",
              "WARNING",
              "ERROR",
              "SEVERE",
              "FATAL",
              "OFF"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- named-formatter - The name of the defined formatter to be used on the handler.

  Type | STRING
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The name of the defined formatter to be used on the handler.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "capability-reference" : "org.wildfly.logging.formatter",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services"
      }

- outbound-socket-binding-ref - Outbound socket reference for the socket connection.

  Type | STRING
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | resource-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "Outbound socket reference for the socket connection.",
          "expressions-allowed" : true,
          "required" : true,
          "nillable" : false,
          "capability-reference" : "org.wildfly.network.outbound-socket-binding",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}},
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "resource-services"
      }

- protocol - The protocol the socket should communicate over.

  Type | STRING
  Default Value | TCP
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Allowed Values | TCP UDP SSL_TCP
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The protocol the socket should communicate over.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "TCP",
          "allowed" : [
              "TCP",
              "UDP",
              "SSL_TCP"
          ],
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- ssl-context - The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | resource-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "capability-reference" : "org.wildfly.security.ssl-context",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"ssl-ref" : {"type" : "core"}}},
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "resource-services"
      }

## Operations (2)

- add - Add a new socket handler.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  autoflush | BOOLEAN | false | true | true | Automatically flush after each write.
  block-on-reconnect | BOOLEAN | false | true | false | If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.
  enabled | BOOLEAN | false | true | true | If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
  encoding | STRING | false | true |  | The character encoding used by this Handler.
  filter-spec | STRING | false | true |  | A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
  level | STRING | false | true | ALL | The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
  named-formatter | STRING | true | false |  | The name of the defined formatter to be used on the handler.
  outbound-socket-binding-ref | STRING | true | true |  | Outbound socket reference for the socket connection.
  protocol | STRING | false | true | TCP | The protocol the socket should communicate over.
  ssl-context | STRING | false | true |  | The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Add a new socket handler.",
          "request-properties" : {
              "autoflush" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Automatically flush after each write.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "block-on-reconnect" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : false,
                  "stability" : "default"
              },
              "enabled" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "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,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "encoding" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The character encoding used by this Handler.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "filter-spec" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "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,
                  "required" : false,
                  "nillable" : true,
                  "capability-reference" : "org.wildfly.logging.filter",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "level" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "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,
                  "required" : false,
                  "nillable" : true,
                  "default" : "ALL",
                  "allowed" : [
                      "ALL",
                      "FINEST",
                      "FINER",
                      "TRACE",
                      "DEBUG",
                      "FINE",
                      "CONFIG",
                      "INFO",
                      "WARN",
                      "WARNING",
                      "ERROR",
                      "SEVERE",
                      "FATAL",
                      "OFF"
                  ],
                  "stability" : "default"
              },
              "named-formatter" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the defined formatter to be used on the handler.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "capability-reference" : "org.wildfly.logging.formatter",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "outbound-socket-binding-ref" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Outbound socket reference for the socket connection.",
                  "expressions-allowed" : true,
                  "required" : true,
                  "nillable" : false,
                  "capability-reference" : "org.wildfly.network.outbound-socket-binding",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "protocol" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The protocol the socket should communicate over.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "TCP",
                  "allowed" : [
                      "TCP",
                      "UDP",
                      "SSL_TCP"
                  ],
                  "stability" : "default"
              },
              "ssl-context" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "capability-reference" : "org.wildfly.security.ssl-context",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove - Removes the socket handler.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Removes the socket handler.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "restart-required" : "all-services",
          "runtime-only" : false
      }

## Galleon Features

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

- subsystem.logging.socket-handler

      <feature spec="subsystem.logging.socket-handler">
        <param name="socket-handler" value="{resource name}"/>
        <param name="autoflush" value="{value}"/>
        <param name="block-on-reconnect" value="{value}"/>
        <param name="enabled" value="{value}"/>
        <param name="encoding" value="{value}"/>
        <param name="filter-spec" value="{value}"/>
        <param name="level" value="{value}"/>
        <param name="named-formatter" value="{value}"/>
        <param name="outbound-socket-binding-ref" value="{value}"/>
        <param name="protocol" value="{value}"/>
        <param name="ssl-context" value="{value}"/>
      <feature/>