Management API Reference for mechanism-provider-filtering-sasl-server-factory

Provided Capabilities (1)

Attributes (4)

• available-mechanisms - The SASL mechanisms available from this factory after all filtering has been applied.

  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 SASL mechanisms available from this factory after all filtering has been applied.", "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 }

• enabling - When set to 'true' no provider loaded mechanisms are enabled unless matched by one of the filters, setting to 'false' has the inverse effect.

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "When set to 'true' no provider loaded mechanisms are enabled unless matched by one of the filters, setting to 'false' has the inverse effect.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• filters - The filters to apply when comparing the mechanisms from the providers, a filter matches when all of the specified values match the mechanism / provider pair.

  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" : "The filters to apply when comparing the mechanisms from the providers, a filter matches when all of the specified values match the mechanism / provider pair.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "mechanism-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "This configuration will only apply where a mechanism with the name specified is used. If this attribute is omitted then this will match any mechanism name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the provider to match against.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-version" : { "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "Version to compare against the version reported by the provider.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "version-comparison" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "When set to 'less-than' a Provider will match against the filter if the Provider's version is less-than the version specified here. Setting to 'greater-than' has the opposite effect. Has no effect if a provider-version has not been specified in the filter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "less-than", "requires" : ["provider-version"], "allowed" : [ "less-than", "greater-than" ], "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• sasl-server-factory - Reference to a sasl server factory to be wrapped by this definition.

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

Operations (2)

• add - The add operation for the sasl server factory.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  enabling	BOOLEAN	false	true	true	When set to 'true' no provider loaded mechanisms are enabled unless matched by one of the filters, setting to 'false' has the inverse effect.
  filters	LIST	false	false		The filters to apply when comparing the mechanisms from the providers, a filter matches when all of the specified values match the mechanism / provider pair.
  sasl-server-factory	STRING	true	false		Reference to a sasl server factory to be wrapped by this definition.

  Raw DMR model

  { "operation-name" : "add", "description" : "The add operation for the sasl server factory.", "request-properties" : { "enabling" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "When set to 'true' no provider loaded mechanisms are enabled unless matched by one of the filters, setting to 'false' has the inverse effect.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "filters" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The filters to apply when comparing the mechanisms from the providers, a filter matches when all of the specified values match the mechanism / provider pair.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "mechanism-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "This configuration will only apply where a mechanism with the name specified is used. If this attribute is omitted then this will match any mechanism name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the provider to match against.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-version" : { "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "Version to compare against the version reported by the provider.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "version-comparison" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "When set to 'less-than' a Provider will match against the filter if the Provider's version is less-than the version specified here. Setting to 'greater-than' has the opposite effect. Has no effect if a provider-version has not been specified in the filter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "less-than", "requires" : ["provider-version"], "allowed" : [ "less-than", "greater-than" ], "stability" : "default" } } }, "sasl-server-factory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to a sasl server factory to be wrapped by this definition.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.sasl-server-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

• remove - The remove operation for the sasl server factory.

  Raw DMR model

  { "operation-name" : "remove", "description" : "The remove operation for the sasl 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.mechanism-provider-filtering-sasl-server-factory

          
  <feature spec="subsystem.elytron.mechanism-provider-filtering-sasl-server-factory">
    <param name="mechanism-provider-filtering-sasl-server-factory" value="{resource name}"/>
    <param name="enabling" value="{value}"/>
    <param name="filters" value="{value}"/>
    <param name="sasl-server-factory" value="{value}"/>
  <feature/>
          
        

  📋