Management API Reference for subsystem=webservices

The configuration of the web services subsystem.

Children (2)

Attributes (7)

modify-wsdl-address - Whether the soap address can be modified.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the soap address can be modified.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

statistics-enabled - Whether statistics are to be gathered for endpoints, default value is 'false'.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether statistics are to be gathered for endpoints, default value is 'false'.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

wsdl-host - The WSDL, that is a required deployment artifact for an endpoint, has a element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the

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?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The WSDL, that is a required deployment artifact for an endpoint, has a element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the ", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

wsdl-path-rewrite-rule - This string defines a SED substitution command (e.g., 's/regexp/replacement/g') that JBossWS executes against the path component of each URL published from the server. When wsdl-path-rewrite-rule is not defined, JBossWS retains the original path component of each URL. When 'modify-wsdl-address' is set to "false" this element is ignored.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "This string defines a SED substitution command (e.g., 's/regexp/replacement/g') that JBossWS executes against the path component of each URL published from the server. When wsdl-path-rewrite-rule is not defined, JBossWS retains the original path component of each URL. When 'modify-wsdl-address' is set to \"false\" this element is ignored.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

wsdl-port - The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

wsdl-secure-port - The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

wsdl-uri-scheme - The URI scheme to use for rewriting . Valid values are 'http' and 'https'. This configuration overrides scheme computed by processing the endpoint (even if a transport guarantee is specified). The provided values for 'wsdl-port' and 'wsdl-secure-port' (or their default values) are used depending on specified scheme.

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?	no-services
Allowed Values	http https
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The URI scheme to use for rewriting . Valid values are 'http' and 'https'. This configuration overrides scheme computed by processing the endpoint (even if a transport guarantee is specified). The provided values for 'wsdl-port' and 'wsdl-secure-port' (or their default values) are used depending on specified scheme.", "expressions-allowed" : true, "required" : false, "nillable" : true, "allowed" : [ "http", "https" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

add - Adds the web services subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
modify-wsdl-address	BOOLEAN	false	true	true	Whether the soap address can be modified.
statistics-enabled	BOOLEAN	false	true	false	Whether statistics are to be gathered for endpoints, default value is 'false'.
wsdl-host	STRING	false	true		The WSDL, that is a required deployment artifact for an endpoint, has a element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the
wsdl-path-rewrite-rule	STRING	false	false		This string defines a SED substitution command (e.g., 's/regexp/replacement/g') that JBossWS executes against the path component of each URL published from the server. When wsdl-path-rewrite-rule is not defined, JBossWS retains the original path component of each URL. When 'modify-wsdl-address' is set to "false" this element is ignored.
wsdl-port	INT	false	true		The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.
wsdl-secure-port	INT	false	true		The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.
wsdl-uri-scheme	STRING	false	true		The URI scheme to use for rewriting . Valid values are 'http' and 'https'. This configuration overrides scheme computed by processing the endpoint (even if a transport guarantee is specified). The provided values for 'wsdl-port' and 'wsdl-secure-port' (or their default values) are used depending on specified scheme.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the web services subsystem.",
    "request-properties" : {
        "modify-wsdl-address" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether the soap address can be modified.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether statistics are to be gathered for endpoints, default value is 'false'.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "wsdl-host" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The WSDL, that is a required deployment artifact for an endpoint, has a  element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of  is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of  is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the ",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "wsdl-path-rewrite-rule" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "This string defines a SED substitution command (e.g., 's/regexp/replacement/g') that JBossWS executes against the path component of each  URL published from the server. When wsdl-path-rewrite-rule is not defined, JBossWS retains the original path component of each  URL. When 'modify-wsdl-address' is set to \"false\" this element is ignored.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "wsdl-port" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "wsdl-secure-port" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "wsdl-uri-scheme" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The URI scheme to use for rewriting  . Valid values are 'http' and 'https'. This configuration overrides scheme computed by processing the endpoint (even if a transport guarantee is specified). The provided values for 'wsdl-port' and 'wsdl-secure-port' (or their default values) are used depending on specified scheme.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "http",
                "https"
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the web services subsystem.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the web services subsystem.",
    "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.webservices

        
<feature spec="subsystem.webservices">
  <param name="modify-wsdl-address" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
  <param name="wsdl-host" value="{value}"/>
  <param name="wsdl-path-rewrite-rule" value="{value}"/>
  <param name="wsdl-port" value="{value}"/>
  <param name="wsdl-secure-port" value="{value}"/>
  <param name="wsdl-uri-scheme" value="{value}"/>
<feature/>