Management API Reference for filter

A filter to be used with handlers and loggers. Please note the name of the filter should start with an alpha character and not contain any special characters. The following names are considered reserved names; accept, deny, not, all, any, levelChange, levels, levelRange, match, substitute, substituteAll.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.logging.filter	true	/subsystem=logging/logging-profile=/filter=

Attributes (4)

class - The logging filter class to be used.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The logging filter class to be used.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

constructor-properties - Defines the constructor properties used for the logging filter.

Type	OBJECT
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" : "OBJECT" }, "description" : "Defines the constructor properties used for the logging filter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

module - The module that the logging filter depends on.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The module that the logging filter depends on.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

properties - Defines the properties used for the logging filter. All properties must be accessible via a setter method.

Type	OBJECT
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" : "OBJECT" }, "description" : "Defines the properties used for the logging filter. All properties must be accessible via a setter method.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Adds a new filter.

Request Parameter	Type	Required	Expressions Allowed	Description
class	STRING	true	false	The logging filter class to be used.
constructor-properties	OBJECT	false	true	Defines the constructor properties used for the logging filter.
module	STRING	true	false	The module that the logging filter depends on.
properties	OBJECT	false	true	Defines the properties used for the logging filter. All properties must be accessible via a setter method.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a new filter.",
    "request-properties" : {
        "class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The logging filter class to be used.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "constructor-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Defines the constructor properties used for the logging filter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module that the logging filter depends on.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Defines the properties used for the logging filter. All properties must be accessible via a setter method.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the filter.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the filter.",
    "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.filter

        
<feature spec="subsystem.logging.filter">
  <param name="filter" value="{resource name}"/>
  <param name="class" value="{value}"/>
  <param name="constructor-properties" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="properties" value="{value}"/>
<feature/>