You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

On this Page:

Related Pages:

The Bridge can be used as HTTP server or as HTTP client. In order to access HTTP resources (backends), the URL adapter can be used.
In order to act as server, an HTTP frontend can be defined for a service.

Example File (Builder project Basic Modeling/Frontend):

<your example path>\Basic Modeling\Frontend\uml\simpleHttpService.xml
<your example path>\Basic Modeling\Frontend\uml\simpleRESTSupportManager.xml

Refer to HTTP Protocol Support regarding general information on HTTP protocol support in this context.

Since Runtime 2018.5, the E2E HTTP service supports IPv6.

HTTP Components

The HTTP service is defined in the component diagram as <<E2EHTTPService>> component containing one ore many <<E2EHTTPPortType>> classes:

Each <<E2EHTTPService>> contains the following tagged values:

Tagged ValueDescriptionAllowed Values
portMultiExcerpt named port was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macroany number
Using ports below 1024 may require additional privileges.
tracePort In order to test the HTTP service using the Trace Analyzer, the model compiler generates a SOAP interface for each HTTP service interface. The SOAP service will be listening on this trace port.any number 
service port +40000default
authenticationMode MultiExcerpt named authenticationMode was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macrononeno authentication 
HTTPBasicAuthHTTP basic authentication
HTTPRemoteAuthHTTP remote authentication
 userSpecifies user and password for the use of HTTP Basic authentication.Example: user/password 

At the moment HTTP is the only supported protocol. If HTTPS is required, use the E2E Apache reverse proxy.

HTTP Port Type Operation Parameters

Each operation of an <<E2EHTTPPortType>> may contain the following parameters - all of them being optional:

NameTypeDirectionDescriptionValues
methodStringinHTTP method.get, post, put, patch, delete, ...
uriStringincomplete URI. 
inputContentBlobincontent send by POST or PUT. 
getParameters Array of Parameterinall GET parameters encoded in the URL as an array of Parameter classes containing name/value pairs. 
postParameters Array of Parameterinall form parameters posted by the client. 
inputHeaderParameters HeaderFieldinall header fields as an array of HeaderField classes containing name/value pairs. 
pathParametersMapinfor RESTful service calls: all parameters derived from the path as a Map of name/value pairs. 
outputContent Bloboutthe content sent back. 
outputHeaderParameters HeaderFieldoutif necessary, HTTP output header can be set using this object. 
httpStatusDescription Stringoutthe resulting HTTP status description. If not set explicitly using this object, the service returns OK if no exception occurred or Internal Error otherwise. 
httpStatusCode Integeroutthe resulting HTTP status code. If not set explicitly using this object, the service returns 200 if no exception occurred or 500 otherwise. 
  • No labels