Management API Reference for setting=http-invoker

The HTTP invoker services that allows remote HTTP based invocation of services such as Jakarta Enterprise Beans and naming

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.undertow.http-invoker.host	true	none

Attributes (3)

http-authentication-factory - The HTTP authentication factory to use for authentication

Type	STRING
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" : "STRING" }, "description" : "The HTTP authentication factory to use for authentication", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["security-realm"], "capability-reference" : "org.wildfly.security.http-authentication-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"authentication-factory-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

path - The path that the services are installed under

Type	STRING
Default Value	wildfly-services
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" : "STRING" }, "description" : "The path that the services are installed under", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "wildfly-services", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

security-realm - The legacy security realm to use for authentication

Deprecated Since 12.0.0

Use an http-authentication-factory to provide authentication capabilities to the invoker.

Type	STRING
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" : "STRING" }, "description" : "The legacy security realm to use for authentication", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["http-authentication-factory"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "12.0.0", "reason" : "Use an http-authentication-factory to provide authentication capabilities to the invoker." }, "access-constraints" : {"sensitive" : {"security-realm-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

add - Adds the HTTP invoker service to the host

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
http-authentication-factory	STRING	false	false		The HTTP authentication factory to use for authentication
path	STRING	false	false	wildfly-services	The path that the services are installed under
security-realm	STRING	false	false		The legacy security realm to use for authentication

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the HTTP invoker service to the host",
    "request-properties" : {
        "http-authentication-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The HTTP authentication factory to use for authentication",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["security-realm"],
            "capability-reference" : "org.wildfly.security.http-authentication-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The path that the services are installed under",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "wildfly-services",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "security-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The legacy security realm to use for authentication",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["http-authentication-factory"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "12.0.0",
                "reason" : "Use an http-authentication-factory to provide authentication capabilities to the invoker."
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the HTTP invoker service

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the HTTP invoker service",
    "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.setting.http-invoker

        
<feature spec="subsystem.undertow.server.host.setting.http-invoker">
  <param name="host" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="http-authentication-factory" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="security-realm" value="{value}"/>
<feature/>