...
Stereotype <<E2ESOAPService>> is used in the component diagram to mark a service as SOAP service.
...
MultiExcerptName | tagged_values |
---|
PageWithExcerpt | SOAP Service Components |
---|
<<E2ESOAPPortType>>
...
|
---|
MultiExcerptName | E2ESOAPService |
---|
|
Name Dialog / Tag / Parameter | Description | Allowed Values |
---|
Authentication | Authentication Mode (authenticationMode) | Multiexcerpt |
---|
MultiExcerptName | 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. |
| 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) | Multiexcerpt |
---|
| Specifies the machine port number the service is binding to. This port number can be given at the service level only. |
| any number |
| Proxy | External Proxy Host (externalProxyHost) | Multiexcerpt |
---|
MultiExcerptName | 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) | Multiexcerpt |
---|
MultiExcerptName | proxyProtocol |
---|
| Specifies the used proxy protocol. |
| HTTP | use the HTTP protocol | HTTPS | use the HTTPS protocol (default) | Proxy Host (proxyHost) | Multiexcerpt |
---|
MultiExcerptName | 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 |
| localhost | default | Proxy Port (proxyPort) | Multiexcerpt |
---|
MultiExcerptName | proxyPort |
---|
| Specifies the port the proxy is listening to. |
| any number |
| 80 | default for HTTP | 443 | default for HTTPS | Proxy Path (proxyPath) | Multiexcerpt |
---|
MultiExcerptName | proxyPath |
---|
| Specifies the part of the overall URL that is mapped to the actual host name and port. Note |
---|
| 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) | Multiexcerpt |
---|
| 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) | Multiexcerpt |
---|
| Time zone string as specified in the time zone appendix. timezone is used to print DateTime expressions. |
| Multiexcerpt |
---|
MultiExcerptName | timezone_examples |
---|
| 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) | Multiexcerpt |
---|
MultiExcerptName | dateFormatString |
---|
| Date formatting code as listed in Date and Time Formatting. If nothing is defined, the XSD standard is used. |
| Multiexcerpt |
---|
MultiExcerptName | dateFormatString_examples |
---|
| Example: %F |
| Wsdl Namespace (wsdlNamespace) | Multiexcerpt |
---|
MultiExcerptName | 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>>
Multiexcerpt |
---|
MultiExcerptName | E2ESOAPPortType |
---|
|
Name Dialog / Tag / Parameter
| Description | Allowed Values |
---|
Namespace (namespace) | Use namespace to overwrite the default namespace. | |
...
Info |
---|
| 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>>
...
Multiexcerpt |
---|
MultiExcerptName | 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 Block |
---|
<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. | Code Block |
---|
<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. | Code Block |
---|
<wsdl:output>
<soap:body [...] namespace="myOutputNamespace"/> |
| any valid namespace string default: urn:<containment tree path>.<port name> | |
<<SOAPDocumentOperation>>
...
Multiexcerpt |
---|
MultiExcerptName | 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 Block |
---|
<wsdl:operation name="mySOAPoperation">
<soap:operation soapAction="mySOAPaction"/> |
| any valid URL string | |