EnsLib.HTTP.OutboundAdapter

This is the debug flag setting (0 do nothing, 1 show request, 2 show request/response)

These are the production settings for this object

Array of Cookies. Indexed by Domain/Server; each element is $LB(name, domain, path, value, expires, secure)

The Proxy-Authorization header value

The size of each chunk for chunked streaming.
Only effective if Chunked is set true.
The value needs to be at least 1.

If set true, chunked Transfer-Encoding will be applied on each outgoing message.

If the HttpRequest object used to make requests is not re-instantiated by the operation then any cookies that are set by the HttpRequest object will remain cached in the HttpRequest object - see %Net.HttpRequest
Set this property to true for the adapter code to clear any cached response cookies after each send.

Number of seconds to wait on each connection attempt

This is the ID of the Credentials object (Username, Password) to be used to access the HTTP server

Extra HTTP Headers to be sent with the outbound HTTP request.
It needs to be a comma-separated list, and each element needs to be a colon-separated key-value pair.
Example:
Content-Type:text/plain,Custom-Header:Custom-Value

TCP Port on the server to send HTTP requests to (will use 80 by default, or 443 if SSLConfig is specified)

IP address of the server to send HTTP requests to.

In a multi-homed system, specify which network interface the TCP connection should go through. An empty value means to use any interface.
To be able to bind to IPv6 interfaces you may need to enable IPv6 in your instance. This is done in the System Management Portal under System Administration > Configuration > Additional Settings > Startup, by editing the IPv6 setting.

The OAuth2AccessTokenPlacement specifies one of three ways defined by RFC 6750 to send the access token to the Resource Server:
"header" to use Bearer token HTTP header.
"body" to use form encoded body. In this case, request must be a POST with form encoded body.
"query" to use a query parameter.

The supported grant types are Password, JWT authorization, and Client Credentials.

Password: The Credentials object, which includes a username and password, is required.

JWT Authorization: OAuth2 JWT Subject is required.

Client Credentials: No Credentials object required - Client ID and Client secret from the OAuth 2.0 client are used.

If System Alert and Monitoring for interoperability is enabled then report HTTP request metrics as given in Ens.SAM.SensorDefinitions for EnsHTTPRequest.

This is the ID of the Credentials object to be used to access the proxy server.
The Proxy-Authorization header value will be set to the Password field of the selected Credentials object, and the other fields, including Username, are ignored.
A valid value needs to be of format " .
e.g. A Credentials object with the Password field "Basic YWxhZGRpbjpvcGVuc2VzYW1l" sets the HTTP request header
Proxy-Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
If the Proxy-Authorization header is set elsewhere, this setting will overwrite the existing header, unless it is left empty.

Property methods: ProxyAuthorizationDisplayToLogical(), ProxyAuthorizationGet(), ProxyAuthorizationIsValid(), ProxyAuthorizationLogicalToDisplay(), ProxyAuthorizationLogicalToOdbc(), ProxyAuthorizationNormalize(), ProxyAuthorizationSet()

Should the proxy (if any) use HTTPS to communicate with the real HTTP/HTTPS server?

Should the Adapter use the HTTP CONNECT command to establish a tunnel through the proxy to the target HTTP server?

Proxy server port on which to send HTTP requests, if using a proxy server (will use 8080 by default)

Proxy server through which to send HTTP requests, if any

Timeout for getting a response from the server (the timeout for opening the connection to the server is always 5 seconds). Setting the timeout to -1 means wait forever.

Class that contains the XData JSON definition

XData JSON definition name

When making an SSL connection check the server identity in the certificate matches the name of the system we are connecting to. This defaults to being on and matches based on the rules layed out in section 3.1 of RFC 2818.

The name of an existing SSL/TLS system configuration set to use (Secure Socket Layer / Transport Layer Security, configured via the system portal's Security Management page).

If your SSL Configuration requires you to supply a password for the local private key file, specify it in the Private key password property of the SSL/TLS Configuration.

A comma-separated list of body stream attribute names that should not be copied to the outbound HTTP header. The default value of "*" means to skip all, i.e. to copy none. If this value is empty and the input stream is a %Library.AbstractStream subclass, then double copying of the stream data will be avoided by passing the stream object directly through to the %Net.HttpRequest.Send() method.

URL path to request from the server (not including 'http://' or server address)

• If set to empty or '*' and used on a GenericOperation, this setting will employ the HTTPHeaders array value for the key 'URL' (case insensitive) contained in the GenericMessage being processed.
• If this value starts with '^' and is used on a GenericOperation, this setting will remove the Application attribute from the URL of the GenericMessage being processed and replace it with the remaining portion of this value if any. If combined with '*' the '^' should come first.
• If this value starts with '|' and is used on a GenericOperation, this setting will remove the Application and ConfigName attributes from the URL of the GenericMessage being processed and replace them with the remaining portion of this value if any. If combined with '*' the '|' should come first.

Save Cookies received in HTTP responses while this adapter is instantiated, and insert them in each subsequent HTTP request.
If the HttpRequest object used to make requests is not re-instantiated by the operation then any cookies that are set by the HttpRequest object will remain cached in the HttpRequest object - see %Net.HttpRequest - which is independent of this setting.
See ClearCachedResponseCookies for clearing reused request cache.

Set this to the timeout to use when writing to the remote HTTP server.
The default is -1 means it will wait indefinitely for the remote server to accept the written data, change it to another value to specify the timeout in seconds.

Send a DELETE to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. To use a request Body instead of form variables, leave pFormVarNames empty and pass the body text as the pData argument. Otherwise, for each name in the list, a pData argument should be supplied. If you need to pass multiple values for any form variable, you can put the name of that variable multiple times in the pFormVarNames list. Also, any extra pData arguments will be assigned to the last form variable in the list. Note: Data values passed for body text may be of either String type or Stream. Data values passed for form variables must be of String type.

Delete a particular Cookie

Delete all cookies from the specified domain and/or path

Send a DELETE to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. For each name in the list, a pData argument should be supplied. The pData argument is an array. The top node of the array is not used. Each sub-node is subscripted by the index of the form variable from the pFormVarNames list that it corresponds to. The value at that subscript is the form data for that variable. For single-valued form variables this value is just the value. In this case this node should have no sub-nodes. For multiple valued form variables, the value at this node should be the count of form variable values, and each of the values for this form variable should appear in a sub-node, subscripted by its position in the node.

Send a GET to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. To use a request Body instead of form variables, leave pFormVarNames empty and pass the body text as the pData argument. Otherwise, for each name in the list, a pData argument should be supplied. If you need to pass multiple values for any form variable, you can put the name of that variable multiple times in the pFormVarNames list. Also, any extra pData arguments will be assigned to the last form variable in the list. Note: Data values passed for body text may be of either String type or Stream. Data values passed for form variables must be of String type.

Send a GET to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. For each name in the list, a pData argument should be supplied. The pData argument is an array. The top node of the array is not used. Each sub-node is subscripted by the index of the form variable from the pFormVarNames list that it corresponds to. The value at that subscript is the form data for that variable. For single-valued form variables this value is just the value. In this case this node should have no sub-nodes. For multiple valued form variables, the value at this node should be the count of form variable values, and each of the values for this form variable should appear in a sub-node, subscripted by its position in the node.

Carry out various internal tasks when exiting the SendFormDataArray method

Inherited description: This user callback method is called just after %OnNew()

Inherited description: This user callback method is called just before %OnClose()

Send a PATCH to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. To use a request Body instead of form variables, leave pFormVarNames empty and pass the body text as the pData argument. Otherwise, for each name in the list, a pData argument should be supplied. If you need to pass multiple values for any form variable, you can put the name of that variable multiple times in the pFormVarNames list. Also, any extra pData arguments will be assigned to the last form variable in the list. Note: Data values passed for body text may be of either String type or Stream. Data values passed for form variables must be of String type.

Send a PATCH to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. For each name in the list, a pData argument should be supplied. The pData argument is an array. The top node of the array is not used. Each sub-node is subscripted by the index of the form variable from the pFormVarNames list that it corresponds to. The value at that subscript is the form data for that variable. For single-valued form variables this value is just the value. In this case this node should have no sub-nodes. For multiple valued form variables, the value at this node should be the count of form variable values, and each of the values for this form variable should appear in a sub-node, subscripted by its position in the node.

Send a POST to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. To use a request Body instead of form variables, leave pFormVarNames empty and pass the body text as the pData argument. Otherwise, for each name in the list, a pData argument should be supplied. If you need to pass multiple values for any form variable, you can put the name of that variable multiple times in the pFormVarNames list. Also, any extra pData arguments you supply will be assigned to the last form variable in the list. Note: A Data value passed for body text may be of either String type or Stream. Data values passed for form variables must be of String type.

Send a POST to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. For each name in the list, a pData argument should be supplied. The pData argument is an array. The top node of the array is not used. Each sub-node is subscripted by the index of the form variable from the pFormVarNames list that it corresponds to. The value at that subscript is the form data for that variable. For single-valued form variables this value is just the value. In this case this node should have no sub-nodes. For multiple valued form variables, the value at this node should be the count of form variable values, and each of the values for this form variable should appear in a sub-node, subscripted by its position in the node.

Send a PUT to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. To use a request Body instead of form variables, leave pFormVarNames empty and pass the body text as the pData argument. Otherwise, for each name in the list, a pData argument should be supplied. If you need to pass multiple values for any form variable, you can put the name of that variable multiple times in the pFormVarNames list. Also, any extra pData arguments will be assigned to the last form variable in the list. Note: Data values passed for body text may be of either String type or Stream. Data values passed for form variables must be of String type.

Send a PUT to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. For each name in the list, a pData argument should be supplied. The pData argument is an array. The top node of the array is not used. Each sub-node is subscripted by the index of the form variable from the pFormVarNames list that it corresponds to. The value at that subscript is the form data for that variable. For single-valued form variables this value is just the value. In this case this node should have no sub-nodes. For multiple valued form variables, the value at this node should be the count of form variable values, and each of the values for this form variable should appear in a sub-node, subscripted by its position in the node.

Send a pOp request ("POST","GET","PUT" or "PATCH") to the configured Server, Port and URL, sending form data to the named form variables. pFormVarNames is a comma-separated list of form variable names to use. For each name in the list, a pData argument should be supplied. The pData argument is an array. The top node of the array is not used. Each sub-node is subscripted by the index of the form variable from the pFormVarNames list that it corresponds to. The value at that subscript is the form data for that variable. For single-valued form variables this value is just the value. In this case this node should have no sub-nodes. For multiple valued form variables, the value at this node should be the count of form variable values, and each of the values for this form variable should appear in a sub-node, subscripted by its position in the node. For special needs, the pHttpRequestIn argument can be used to pre-populate properties of the %Net.HTTPRequest object used to send the HTTP request.