To open the HTTP/2 Server agent configuration dialog from a workflow configuration, you can do either one of the following:
...
| Setting | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Settings | |||||||||||
Use SSL | Select this option to use the SSL. | ||||||||||
| Security Profile |
| ||||||||||
| Enable 2-way Authentication | If you have selected to use SSL, you can select this option to enable 2-way Authentication. If this option is selected, the Security Profile used must be configured using Java Truststore. | ||||||||||
| Host | Enter the IP address or hostname that you want the agent to bind to. | ||||||||||
| Port | Enter the port number you want the agent to bind to. | ||||||||||
| Request Handling | |||||||||||
| Default connection concurrent streams | Fundamentally HTTP/2 is designed to make it easy for a client to send multiple parallel requests. Each request is entitled to a thread and if blocking APIs are used, then there are many ways a client can cause that thread to block. To handle the resource problem this can cause, the setting Default connection concurrent streams can be used. The setting specifies the maximum number of concurrently open streams allowed per single HTTP/2 connection. The default value uses in Jetty HTTP/2 server is 128. Larger values increase parallelism, but cost a memory commitment. | ||||||||||
| Route Error to APL | Select this option if you want to route HTTP errors to APL for custom handling. For more information on how to handle the error using APL, refer to Route Error to APL. | ||||||||||
| Timeout | |||||||||||
| Client Timeout (sec) | The period in seconds after which the HTTP/2 Server should close the connection if a client is inactive. That is, this is the period of inactivity from when the client has opened the connection or received the last expected response until the server should close the connection. For example, if Client Timeout is set to 6, this means that the server will close the connection if the client is inactive for 6 seconds. | ||||||||||
| Server Timeout (sec) | The period in seconds before which the HTTP/2 Server has to reply to a request. That is, this is the period within which a server has to process a request and send a response to a client. If the time limit is reached, an error response with a status code of 500 will be sent. | ||||||||||
| Responses | |||||||||||
| Default Charset | Select the character set you want to use as default character set. UTF-8 is preselected. This character set will be used if the character set requested by Accept-Charset is not found in system. | ||||||||||
| GZIP Compression Level | If gzip is requested, then the response will be be gzipped with the compression level you specify in this field, 1-9. | ||||||||||
...
| Setting | Description |
|---|---|
Enable Overload Protection | Select this option if you want enable overload protection. |
| Number of Requests | If you have selected enable overload protection, enter the maximum number of requests that are allowed to be sent during the time specified in Average Period (sec). When this number of requests has been reached, further requests will be blocked until the time specified in Wait Duration (sec) has passed, then a retry will be attempted. |
| Period (sec) | Enter the time period in seconds for which the number of requests should be counted. |
| Wait Before Retry (sec) | Enter the number of seconds to wait before attempting to retry a request. |
OpenAPI/5G Tab
HTTP/2 Server Agent Configuration - OpenAPI/5G tab
...
| Setting | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| OpenAPI | |||||||||||
Use OpenAPI Profile | Select this option if you want the agent to use an OpenAPI profile. | ||||||||||
| OpenAPI Profile | Browse and select the profile to be used. This field is enabled when the Use OpenAPI Profile option is selected. | ||||||||||
| Enable Validation | Select this option if you want to validate the OpenAPI profile.
| ||||||||||
| Override Error Response | |||||||||||
| Override Error Response on Server Shutdown | Select this option to enable the customization of the HTTP response for when a request to the server is received upon the server being terminated. | ||||||||||
| Override Error Response on Server Overload | Select this option to enable the customization of the HTTP response for when a request to the server is received upon the server being overloaded.
| ||||||||||
| Status Code | The HTTP error code for the error response. The default error code set is 503 for server shutdown and 429 for server overload. | ||||||||||
| Content Type | |||||||||||
| UDR Type | Browse for the UDR that will be populated as part of the HTTP response message. | ||||||||||
| UDR Field | The fields in the selected UDR Type will be shown in this column. | ||||||||||
| Type | The data type for the each of the UDR fields will be shown here. supports
| ||||||||||
| Value | Enter a value that conforms to the data type of the UDR field. The value will then be parsed into the HTTP response when the error is triggered. | ||||||||||
| 5G | |||||||||||
| Use 5G Profile | Select this option if you want the agent to use a 5G profile. | ||||||||||
| 5G Profile | Browse and select the profile to be used. This field is enabled when the Use 5G Profile option is selected. | ||||||||||
| NRF Address (Primary) | Enter the primary NRF (NF Repository Function) address in this field. | ||||||||||
| Additional NRF Address Settings (Secondary) | |||||||||||
| Reconnect to primary address when it is available | Select this option to have the agent reconnect to the primary NRF address from the secondary address. The agent will constantly send a registration request to the primary NRF address at every heartbeat interval. The heartbeat interval will be based off of the value that you have configured in the 5G profile. | ||||||||||
| NRF Address (Secondary) | Enter one or more secondary NRF (NF Repository Function) address in this list, this is to allow for alternative connections when the heartbeat with the primary NRF Address is not established. | ||||||||||
...