...
| Drawio | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The HTTP participant runs a Control Loop Element to handle the REST dialogues for a particular application domain. The REST dialogues are whatever REST calls that are required to implement the functionality for the application domain.
...
The HTTP participant allows the REST dialogues for an Application Domain a Control Loop to be managed. A particular Application Domain Control Loop may require many things to be configured and managed and this may require many REST dialogues to achieve.
A Configuration Entity describes a concept that is managed by the HTTP participant. A Configuration Entity can be created, Read, Updated, and Deleted (CRUD). The user defines the Configuration Entities that it wants its HTTP Control Loop Element to manage and provides a sequence of parameterized REST commands to Create, Read, Update, and Delete each Configuration Entity.
Configuring a Control Loop Element on the HTTP participant for a Control Loop
The user configures the following properties in the CLAMP GUI for the HTTP participant:
| Property | Type | Description |
|---|---|---|
| baseUrl | URL | A well formed URL pointing at the REST server that is processing the REST requests |
| httpHeaders | map | A map of <String, String> defining the HTTP headers to send on all REST calls |
| configurationEntitiies | map | A map of <String, ConfigurationEntity> describing the names and definitions of configuration entities that are managed by this HTTP Control Loop Element |
The ConfigurationEntity type is described in the following table:
| Field | Type | Description |
|---|---|---|
| ID | ToscaConceptIdentifier | The name and version of the Configuration Entity |
| createRestSequence | List<RestSequence> | A list of REST requests to give to create the Configuration Entity |
| readRestSequence | List<RestSequence> | A list of REST requests to give to read the Configuration Entity |
| updateRestSequence | List<RestSequence> | A list of REST requests to give to update the Configuration Entity |
| deleteRestSequence | List<RestSequence> | A list of REST requests to give to delete the Configuration Entity |
The RestSequence type is described in the following table:
| Field | Type | Description |
|---|---|---|
| httpMethod | HttpMethod | An enum for the HTTP method {GET, PUT, POST, DELETE |
| path | String | The path of the REST endopint relative to the baseUrl |
| body | String | The body of the request for POST and PUT methods |
| expectedResponse | HttpStatus | The expected HTTP response code fo the REST request |