Management API Reference for custom-filter

Attributes (3)

• class-name - Class name of HttpHandler

  Type	STRING
  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" : "Class name of HttpHandler", "expressions-allowed" : true, "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 }

• module - Module name where class can be loaded from

  Type	STRING
  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" : "Module name where class can be loaded from", "expressions-allowed" : true, "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 }

• parameters - Filter parameters

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

Operations (2)

• add - Add custom filter

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  class-name	STRING	true	true		Class name of HttpHandler
  module	STRING	true	true		Module name where class can be loaded from
  parameters	OBJECT	false	true		Filter parameters

  Raw DMR model

  { "operation-name" : "add", "description" : "Add custom filter", "request-properties" : { "class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of HttpHandler", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module name where class can be loaded from", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "parameters" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Filter parameters", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

• remove - Remove custom filter

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove custom filter", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

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

• subsystem.undertow.configuration.filter.custom-filter

          
  <feature spec="subsystem.undertow.configuration.filter.custom-filter">
    <param name="custom-filter" value="{resource name}"/>
    <param name="class-name" value="{value}"/>
    <param name="module" value="{value}"/>
    <param name="parameters" value="{value}"/>
  <feature/>
          
        

  📋