Tagged Values

<<E2ESOAPService>>

Stereotype <<E2ESOAPService>> is used in the component diagram to mark a service as SOAP service.

Name Dialog / Tag / ParameterDescriptionAllowed Values
Authentication
Authentication Mode
(authenticationMode)

Defines the authentication mode to be used with this SOAP service.

  • If HTTPBasicAuth is used, you define that the service composite authenticates the user. User name and password must then be given in the tagged value user.
    For more details see Basic Authentication with the E2E Bridge.
  • If HTTPRemoteAuth is used, a revers proxy needs to authenticate the user and pass it to the service. The service then expects a set REMOTE-USER HTTP header.
    Typically the Apache reverse proxy is used for that.

Independent of the authentication mode, the user is found in the principal object if the authentication succeeded.

noneno authentication
HTTPBasicAuthHTTP basic authentication
HTTPRemoteAuthHTTP 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).

2048Builder 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.

  • If a server certificate is used, the certificate must be issued for this name.
  • If this tagged value is not set, the name of the node hosting the proxy is being used.

Proxy Protocol
(proxyProtocol)
Specifies the used proxy protocol.
HTTPuse the HTTP protocol
HTTPSuse 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.
See also externalProxyHost.
any name
localhostdefault
Proxy Port
(proxyPort)
Specifies the port the proxy is listening to.
any number
80default for HTTP
443default 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/soapSOAP Remote Procedure Call (RPC) encoding
doc/literalSOAP document-style encoding
Timezone
(timezone)
Time zone string as specified in the time zone appendix. timezone is used to print DateTime expressions.

Examples: "Australia/Melbourne", "CET", "Etc/GMT+10".

If "local" is used, the date/time is printed relative to the local timezone of the Bridge, for example:
2012-10-01T12:36:47.0+02:00 (the timezone of the Bridge is UTC+02:00)

Date Format String
(dateFormatString)
Date formatting code as listed in Date and Time Formatting. If nothing is defined, the XSD standard is used.
Example: %F
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
DescriptionAllowed 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:<containment tree path>.<port name>

Example:
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 / ParameterDescriptionWSDL SnippetAllowed Values
Rpc Response Name
(rpcResponseName)		Use to overwrite the RPC response message name in the WSDL.
<wsdl:message name="myReponseName">
      <wsdl:part name="output" type="stns1:OutputClass"/>
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.
<wsdl:input>
    <soap:body [...] namespace="myInputNamespace"/>
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.
<wsdl:output>
    <soap:body [...] namespace="myOutputNamespace"/>
any valid namespace string
default: urn:<containment tree path>.<port name>

<<SOAPDocumentOperation>>

Name Dialog / Tag / ParameterDescriptionWSDL SnippetAllowed 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.
<wsdl:operation name="mySOAPoperation">
         <soap:operation soapAction="mySOAPaction"/>
any valid URL string

On this Page:
  • No labels