FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
Constant summary | |
---|---|
string | CONFIG_AUTH_TYPE := "authenticationType" The configuration name to specify the authentication type configuration of the HTTP transport. The default value is none. |
string | CONFIG_BASE_PATH := "basePath" The configuration name to specify the basePath configuration of the HTTP transport. The default value is an empty string. |
string | CONFIG_DYNAMIC_CHAIN_DEF_NAME := "dynamicChainDefinitionName" The configuration name to specify the name of dynamic chain definition to use for the chain instances. The default value is HTTPClientGenericJSONChain. |
string | CONFIG_NUM_CLIENTS := "numClients" The configuration name to specify the number of clients configuration of the HTTP transport. The default value is 1. |
string | CONFIG_PASSWORD := "password" The configuration name to specify the password configuration of the HTTP transport. The default value is an empty string. |
string | CONFIG_PROXY_AUTH_TYPE := "proxyAuthenticationType" The configuration name to specify the proxy authentication type configuration of the HTTP transport. The default value is none. |
string | CONFIG_PROXY_HOST := "proxyHost" The configuration name to specify the proxy host configuration of the HTTP transport. The default value is an empty string which means no proxy server. |
string | CONFIG_PROXY_PASSWORD := "proxyPassword" The configuration name to specify the proxy password configuration of the HTTP transport. The default value is an empty string. |
string | CONFIG_PROXY_PORT := "proxyPort" The configuration name to specify the proxy port configuration of the HTTP transport. A port value must be provided if a proxy server is specified in the CONFIG_PROXY_HOST. |
string | CONFIG_PROXY_USERNAME := "proxyUsername" The configuration name to specify the proxy username configuration of the HTTP transport when proxyAuthenticationType is HTTP_BASIC. The default value is an empty string. |
string | CONFIG_TIMEOUT_SECS := "timeoutSecs" The configuration name to specify the timeoutSecs configuration of the HTTP transport. The default value is 120 seconds. |
string | CONFIG_TLS := "tls" The configuration name to specify tls configuration of the HTTP transport. The default value is false. |
string | CONFIG_TLS_ACCEPT_UNRECOGNIZED_CERTS := "tlsAcceptUnrecognizedCertificates" The configuration name to specify the tlsAcceptUnrecognizedCertificates configuration of the HTTP transport. The default value is false. |
string | CONFIG_TLS_CERT_AUTH_FILE := "tlsCertificateAuthorityFile" The configuration name to specify the tlsCertificateAuthorityFile configuration of the HTTP transport. The default value is an empty string. |
string | CONFIG_USERNAME := "username" The configuration name to specify the username configuration of the HTTP transport. The default value is an empty string. |
Action summary | |
---|---|
void |
createAndExecuteRequest(string method, string path, any payload, com.softwareag.connectivity.httpclient.HttpOptions options, action<com.softwareag.connectivity.httpclient.Response> callback) Create an HTTP request and execute it. The callback action is executed when the corresponding response is received. |
com.softwareag.connectivity.httpclient.Request |
createDELETERequest(string path) Create an HTTP DELETE request for the specified path. |
com.softwareag.connectivity.httpclient.Request |
createGETRequest(string path) Create an HTTP GET request for the specified path. |
com.softwareag.connectivity.httpclient.Request |
createPOSTRequest(string path, any payload) Create an HTTP POST request for the specified path and the payload. |
com.softwareag.connectivity.httpclient.Request |
createPUTRequest(string path, any payload) Create an HTTP PUT request for the specified path and the payload. |
com.softwareag.connectivity.httpclient.Request |
createRequest(string method, string path, any payload, com.softwareag.connectivity.httpclient.HttpOptions options) Create an HTTP request which can be further customized and then executed. |
dictionary<string, string> | static defaultConfigurations() Return a dictionary populated with the default values for the configuration options used for the HTTP client transport and name of the dynamic chain definition to use for the chain instances. |
com.softwareag.connectivity.httpclient.HttpTransport | static getOrCreate(string host, integer port) Create a new instance of the HttpTransport event holding an instance of the HTTP client connectivity chain for the specified host, port and default configurations. It enables the TLS if the value of the port is 443. |
com.softwareag.connectivity.httpclient.HttpTransport | static getOrCreateWithConfigurations(string host, integer port, dictionary<string, string> configurations) Create a new instance of the HttpTransport event holding an instance of the HTTP client connectivity chain for the specified host, port, and configurations. |
Constant detail |
---|
string CONFIG_AUTH_TYPE := "authenticationType"The configuration name to specify the authentication type configuration of the HTTP transport. The default value is none.
string CONFIG_BASE_PATH := "basePath"The configuration name to specify the basePath configuration of the HTTP transport. The default value is an empty string.
string CONFIG_DYNAMIC_CHAIN_DEF_NAME := "dynamicChainDefinitionName"The configuration name to specify the name of dynamic chain definition to use for the chain instances. The default value is HTTPClientGenericJSONChain.
string CONFIG_NUM_CLIENTS := "numClients"The configuration name to specify the number of clients configuration of the HTTP transport. The default value is 1.
string CONFIG_PASSWORD := "password"The configuration name to specify the password configuration of the HTTP transport. The default value is an empty string.
string CONFIG_PROXY_AUTH_TYPE := "proxyAuthenticationType"The configuration name to specify the proxy authentication type configuration of the HTTP transport. The default value is none.
string CONFIG_PROXY_HOST := "proxyHost"The configuration name to specify the proxy host configuration of the HTTP transport. The default value is an empty string which means no proxy server.
string CONFIG_PROXY_PASSWORD := "proxyPassword"The configuration name to specify the proxy password configuration of the HTTP transport. The default value is an empty string.
string CONFIG_PROXY_PORT := "proxyPort"The configuration name to specify the proxy port configuration of the HTTP transport. A port value must be provided if a proxy server is specified in the CONFIG_PROXY_HOST.
string CONFIG_PROXY_USERNAME := "proxyUsername"The configuration name to specify the proxy username configuration of the HTTP transport when proxyAuthenticationType is HTTP_BASIC. The default value is an empty string.
string CONFIG_TIMEOUT_SECS := "timeoutSecs"The configuration name to specify the timeoutSecs configuration of the HTTP transport. The default value is 120 seconds.
string CONFIG_TLS := "tls"The configuration name to specify tls configuration of the HTTP transport. The default value is false.
string CONFIG_TLS_ACCEPT_UNRECOGNIZED_CERTS := "tlsAcceptUnrecognizedCertificates"The configuration name to specify the tlsAcceptUnrecognizedCertificates configuration of the HTTP transport. The default value is false.
string CONFIG_TLS_CERT_AUTH_FILE := "tlsCertificateAuthorityFile"The configuration name to specify the tlsCertificateAuthorityFile configuration of the HTTP transport. The default value is an empty string.
string CONFIG_USERNAME := "username"The configuration name to specify the username configuration of the HTTP transport. The default value is an empty string.
Action detail |
---|
void createAndExecuteRequest(string method, string path, any payload, com.softwareag.connectivity.httpclient.HttpOptions options, action<com.softwareag.connectivity.httpclient.Response> callback)Create an HTTP request and execute it. The callback action is executed when the corresponding response is received.
com.softwareag.connectivity.httpclient.Request createDELETERequest(string path)Create an HTTP DELETE request for the specified path.
com.softwareag.connectivity.httpclient.Request createGETRequest(string path)Create an HTTP GET request for the specified path.
com.softwareag.connectivity.httpclient.Request createPOSTRequest(string path, any payload)Create an HTTP POST request for the specified path and the payload.
com.softwareag.connectivity.httpclient.Request createPUTRequest(string path, any payload)Create an HTTP PUT request for the specified path and the payload.
com.softwareag.connectivity.httpclient.Request createRequest(string method, string path, any payload, com.softwareag.connectivity.httpclient.HttpOptions options)Create an HTTP request which can be further customized and then executed.
dictionary<string, string> static defaultConfigurations()Return a dictionary populated with the default values for the configuration options used for the HTTP client transport and name of the dynamic chain definition to use for the chain instances.
com.softwareag.connectivity.httpclient.HttpTransport static getOrCreate(string host, integer port)Create a new instance of the HttpTransport event holding an instance of the HTTP client connectivity chain for the specified host, port and default configurations. It enables the TLS if the value of the port is 443.
com.softwareag.connectivity.httpclient.HttpTransport static getOrCreateWithConfigurations(string host, integer port, dictionary<string, string> configurations)Create a new instance of the HttpTransport event holding an instance of the HTTP client connectivity chain for the specified host, port, and configurations.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |