Management API Reference for configurable-http-server-mechanism-factory

Provided Capabilities (1)

Attributes (4)

• available-mechanisms - The HTTP mechanisms available from this factory instance.

  Type	LIST
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The HTTP mechanisms available from this factory instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• filters - Filtering to be applied to enable / disable mechanisms based on the name.

  Type	LIST
  Is the attribute nillable?	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" : "LIST" }, "description" : "Filtering to be applied to enable / disable mechanisms based on the name.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "pattern-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A regular expression pattern based filter.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "enabling" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Does this filter enable or disable a mechanism if it matches.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• http-server-mechanism-factory - The http server factory to be wrapped.

  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 http server factory to be wrapped.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.http-server-mechanism-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• properties - Custom properties to be passed in to the http server factory calls.

  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" : "Custom properties to be passed in to the http server factory calls.", "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 - The add operation for the http server factory.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  filters	LIST	false	false		Filtering to be applied to enable / disable mechanisms based on the name.
  http-server-mechanism-factory	STRING	true	false		The http server factory to be wrapped.
  properties	OBJECT	false	true		Custom properties to be passed in to the http server factory calls.

  Raw DMR model

  { "operation-name" : "add", "description" : "The add operation for the http server factory.", "request-properties" : { "filters" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Filtering to be applied to enable / disable mechanisms based on the name.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "pattern-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A regular expression pattern based filter.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "enabling" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Does this filter enable or disable a mechanism if it matches.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } } }, "http-server-mechanism-factory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The http server factory to be wrapped.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.http-server-mechanism-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Custom properties to be passed in to the http server factory calls.", "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 - The remove operation for the http server factory.

  Raw DMR model

  { "operation-name" : "remove", "description" : "The remove operation for the http server factory.", "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.elytron.configurable-http-server-mechanism-factory

          
  <feature spec="subsystem.elytron.configurable-http-server-mechanism-factory">
    <param name="configurable-http-server-mechanism-factory" value="{resource name}"/>
    <param name="filters" value="{value}"/>
    <param name="http-server-mechanism-factory" value="{value}"/>
    <param name="properties" value="{value}"/>
  <feature/>
          
        

  📋