SOAP Service Reference
Tagged Values
<<E2ESOAPService>>
Stereotype <<E2ESOAPService>> is used in the component diagram to mark a service as SOAP service.
| Name Dialog / Tag / Parameter | Description | Allowed Values | |
|---|---|---|---|
| Authentication | |||
| Authentication Mode (authenticationMode) | Defines the authentication mode to be used with this SOAP service.
Independent of the authentication mode, the user is found in the principal object if the authentication succeeded. | none | no authentication |
| HTTPBasicAuth | HTTP basic authentication | ||
| HTTPRemoteAuth | HTTP remote authentication | ||
| User (user) | Specifies user and password for the use of HTTP Basic authentication. | Example: user/password | |
| HTTP | |||
| Port (port) | Specifies the machine port number the service is binding to. This port number can be given at the service level only. | any positive integer | |
| Max Request Body Size (maxRequestBodySize) | Runtime 2021.2 Specifies the maximum size of the request in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the payload of the service exceeds the given maximum, incoming request are rejected. 
If you have multiple SOAP services in one composite, you can only apply the same value to all. If you specify different values on each of them, the Runtime will pick one and apply them to all. | any positive integer | |
| 0 | Accept unlimited requests (default of services compiled with Builder versions < 7.12.0). | ||
| 2048 | Builder 7.12.0 2MB (default if not specified). | ||
| Max Request Header Size (maxRequestHeaderSize) | Runtime 2022.6 Specifies the maximum size of the request header in KB (1 KB = 1024 Bytes). This can be used to prevent DoS or similar attacks. When the header payload of the service exceeds the given maximum, incoming request are rejected.
Compatibility Hint For older Runtimes, a limit of 8 KB applies.
If you have multiple SOAP services in one composite, you can only apply the same value to all. If you specify different values on each of them, the Runtime will pick one and apply them to all. | any positive integer | |
| 8 | 8 KB (default if not specified). | ||
| Proxy | |||
| External Proxy Host (externalProxyHost) | Specifies the host name as seen by the client.
| ||
| Proxy Protocol (proxyProtocol) | Specifies the used proxy protocol. | HTTP | use the HTTP protocol |
| HTTPS | use the HTTPS protocol (default) | ||
| Proxy Host (proxyHost) | Specifies the host for the proxy deployment. If localhost is used, the proxy will be created on the same host the service is deployed to. Use a dedicated host, if you want to run your proxy on a different host of the same Bridge domain. | any name | |
| localhost | default | ||
| Proxy Port (proxyPort) | Specifies the port the proxy is listening to. | any number | |
| 80 | default for HTTP | ||
| 443 | default for HTTPS | ||
| Proxy Path (proxyPath) | Specifies the part of the overall URL that is mapped to the actual host name and port.
If proxyPath is used, the modeler must ensure that this value is unique within the proxy. | <proxy URL>/<service host>/<composite name> | default |
| SOAP | |||
| Encoding (encoding) | Defines the encoding of the SOAP operation. See Encoding of SOAP Operations for more information on SOAP encoding and the Bridge. | rpc/soap | SOAP Remote Procedure Call (RPC) encoding |
| doc/literal | SOAP document-style encoding | ||
| Timezone (timezone) | Time zone string as specified in the time zone appendix. timezone is used to print DateTime expressions. | Examples: If "local" is used, the date/time is printed relative to the local timezone of the Bridge, for example: | |
| Date Format String (dateFormatString) | Date formatting code as listed in Date and Time Formatting. If nothing is defined, the XSD standard is used. | Example: | |
| Wsdl Namespace (wsdlNamespace) | Specifies the target namespace of the generated WSDL file. This is relevant only, if wsdlPerService in the xUML composite is true (see Frontend Components). | ||
<<E2ESOAPPortType>>
| Name Dialog / Tag / Parameter | Description | Allowed Values | |
|---|---|---|---|
| Namespace (namespace) | Use namespace to overwrite the default namespace.
This tag is used for the namespace of the RPC input/output body only.
| default: urn:Services.HelloWorldService.Ports.HelloWorldPort | |
| Path (path) | Specifies the service location. | Example: If path = "/my/path", the service location will be: http://<host name>:<port>/my /path. Otherwise, the service location will be: http:// <host name> : <port> /<service name>/<port type> | |
<<SOAPRPCOperation>>
| Name Dialog / Tag / Parameter | Description | WSDL Snippet | Allowed Values | |
|---|---|---|---|---|
| Rpc Response Name (rpcResponseName) | Use to overwrite the RPC response message name in the WSDL. |
CODE
| any valid string default: <soap port type name>_<operation name>_Response | |
| Soap Input Namespace (soapInputNamespace) | Use to overwrite the SOAP input namespace in the WSDL. |
CODE
| any valid namespace string default: urn:<containment tree path>.<port name> | |
| Soap Output Namespace (soapOutputNamespace) | Use to overwrite the SOAP output namespace in the WSDL. |
CODE
| any valid namespace string default: urn:<containment tree path>.<port name> | |
<<SOAPDocumentOperation>>
| Name Dialog / Tag / Parameter | Description | WSDL Snippet | Allowed Values | |||
|---|---|---|---|---|---|---|
| Soap Action (soapAction) | Use to set a SOAP action URL in the WSDL. See The SOAPAction HTTP Header Field in the W2C documentation for more information. soapAction should not be empty for document style operations. The Compiler will throw a warning in this case. |
CODE
| any valid URL string | |||