Management API Reference for filter-ref

Attributes (2)

• predicate - 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.

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "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, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• priority - Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.

  Type	INT
  Default Value	1
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Min	1
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - Add new reference

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  predicate	STRING	false	true		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.
  priority	INT	false	true	1	Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add new reference", "request-properties" : { "predicate" : { "type" : { "TYPE_MODEL_VALUE" : "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, "required" : false, "nillable" : true, "stability" : "default" }, "priority" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "min" : 1, "max" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - remove selected reference

  Raw DMR model

  { "operation-name" : "remove", "description" : "remove selected reference", "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.undertow.server.host.filter-ref

          
  <feature spec="subsystem.undertow.server.host.filter-ref">
    <param name="filter-ref" value="{resource name}"/>
    <param name="host" value="{resource name}"/>
    <param name="server" value="{resource name}"/>
    <param name="predicate" value="{value}"/>
    <param name="priority" value="{value}"/>
  <feature/>
          
        

  📋