url | String URL of the resource that you want to access. For example: http://www.rubicon.com/orders/orders.html Important: This string must begin with http:// or https://. | ||
method | String Specifies the HTTP method you want to use. Valid values are: delete get head options patch post put trace | ||
loadAs | String Optional. Form in which you want the pub.client:http service to store the returned document. Set to: ![]() ![]() | ||
data | Document Data that you want the pub.client:http service to submit with the HTTP request. Specify data using one or more of the following keys. Important: When you use more than one key, args is appended first, table is appended second, and string is appended last. | ||
Key | Description | ||
args | Document Optional. Name/value pairs that you want this service to submit to the resource in url. You can use args to submit data via the POST, PUT, PATCH, GET, DELETE, or HEAD method. To specify data using args, create one String element for each name/value pair that you want to submit, where the element's name represents the name portion of the pair and the element's value represents the value portion of the pair. When you use args, the pub.client:http service will automatically: ![]() ![]() ![]() When you submit data using args, Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type value, you must submit the value using the string or bytes variable. | ||
table | String Table Optional. Data that the pub.client:http service will use to construct a query string to submit to the resource specified in url. You can use table to submit data via the POST, PUT, PATCH, GET, DELETE, or HEAD method. table is similar to args, but it allows you to submit unnamed values in a query string, not just name/value pairs. To specify data using table, create one row for each value that you want to submit, where the contents of column 0 of the String Table represents the name portion of the pair (leave this column null to submit an unnamed value) and the contents of column 1 represents the value portion of the pair. When you use table, the pub.client:http service will automatically: ![]() ![]() ![]() When you submit data using table, Integration Server automatically sets the value of the Content-Type header to application/x-www-form-urlencoded. If you want to explicitly specify a different Content-Type, you must submit your data using the string or bytes variable. | ||
string | String Optional. Text that you want the pub.client:http service to submit to the resource in url. You can use string to submit data via the POST, PUT, PATCH, GET, or HEAD method. If you use string to submit data, make sure that you specify the string exactly as you want it presented in the HTTP request. (If you are using the GET or HEAD method, make sure you URL-encode the contents of string.) Note: When you use string, the pub.client:http service will automatically prefix the entire query string with "?" if it submits the data in string via a GET or HEAD. You do not need to include this character in string. When performing a POST, PUT, or PATCH, string will be submitted to the resource defined by url as the body of the request message. | ||
bytes | byte[ ] Optional. Data that you want this service to submit to the resource in url. You can use bytes to submit data via the DELETE, POST, PUT, or PATCH methods only. Important: When you use bytes and another element (args, table, or string) to specify data, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the bytes element in the body of the post. Note: For POST, PUT, and PATCH, you can specify only stream, bytes, or mimeStream. If you specify more than one, the pub.client:http service ends with an exception. | ||
mimeStream | Java.io.InputStream Optional. MIME or SMIME message that you want this service to submit to the resource in url. A mimeStream is created by the
pub.mime:getEnvelopeStream,
pub.smime:createEncryptedData,
pub.smime:createSignedData,
pub.smime.keystore:createSignedData or services. It contains both headers and content. The headers in the mimeStream are appended to the http headers. You can use mimeStream to submit data via the POST, PUT, or PATCH methods only. Note: For POST, PUT, and PATCH, you can specify only stream, bytes, or mimeStream. If you specify more than one, the pub.client:http service ends with an exception. | ||
stream | java.io.InputStream Optional. Data that you want the pub.client:http service to submit to the resource in url. You can use stream to submit data via the POST, PUT, or PATCH methods only. Important: When you use stream and another element (args, table, string or bytes) to specify data, the service appends the data from the args, table, or string element to url. The service appends args to url first, table second, and string last. The service encodes the data from the stream element in the body of the post. Note: For POST, PUT, and PATCH, you can specify only stream, bytes, or mimeStream. If you specify more than one, the pub.client:http service ends with an exception. | ||
encoding | String Optional. Character set in which the URL data parameters are encoded (args, table and string). Encoding is required to correctly convert the String object to bytes when generating the URL for a post. Specify an IANA-registered character set (for example, ISO-8859-1). If this variable is null, the default JVM encoding is used. Because string is used in the body of the post and not used for building the URL, you do not need to specify encoding for the data parameter string. | ||
auth | Document Optional. Authorization information that the pub.client:http service will submit if the resource specified in url is protected. | ||
Key | Description | ||
type | String Type of authentication scheme that you want this service to use when it submits this request. Set to: ![]() ![]() ![]() ![]() You do not need to specify a value for type if this request will specify values for kerberos to use Kerberos authentication. If you specify a value for type and provide kerberos values, Integration Server includes the authentication information related to the specified type and the Kerberos ticket in the outbound request. | ||
user | String User name that this service will submit when requesting a protected resource. Note: If you have specified NTLM as type, you must specify user in the following format: domain_name\user_name | ||
pass | String Password associated with user. | ||
delegation | String Type of delegation to execute a service on behalf of other user. Set to: ![]() ![]() | ||
token | String The access token to submit to the OAuth resource server. Required only when type is set to Bearer. | ||
kerberos | Document Optional. Kerberos information that Integration Server uses to acquire a Kerberos ticket to include in the outbound client request. Integration Server includes the ticket in the HTTP Authorization header using the Negotiate authentication scheme. Specify kerberos details only if you need to use Kerberos authentication to access a secured website. | ||
Key | Description | ||
jaasContext | String Optional. The custom JAAS context used for Kerberos authentication. You must specify a JAAS context for the outbound request to use Kerberos authentication. Integration Server includes a JAAS context named IS_KERBEROS_OUTBOUND that can be used with outbound requests. If you specify a value for jaasContext, you must also specify a value for servicePrincipal. | ||
clientPrincipal | String Optional. The name of the client principal to use for Kerberos authentication. You must specify a clientPrincipal value if the specified jaasContext does not include the principal parameter. If you specify clientPrincipal and the specified jaasContext includes a principal parameter, the principal parameter in the jaasContext takes precedence. The IS_KERBEROS_OUTBOUND JAAS context does not include a principal parameter. You must specify clientPrincipal if you specified IS_KERBEROS_OUTBOUND as the jaasContext value. | ||
clientPassword | String Optional. The password for the specified client principal. You must specify clientPassword if the specified jaasContext does not specify a keytab file. | ||
servicePrincipal | String Optional. The name of the principal that is used with the service that the Kerberos client wants to access. The service provider provides the Service Principal Name. Specify the Service Principal Name in the following format: principal-name.instance-name@realm-name You must specify servicePrincipal if you supplied a jaasContext. | ||
servicePrincipalForm | String Optional. The format in which you want to specify the principal name of the service that is registered with the principal database. Set to: ![]() This is the default. ![]() | ||
requestDelegatableToken | String Optional. Specify if you want to request for a forwardable ticket granting ticket to send to the intermediary. The intermediary can use this forwardable ticket granting ticket for Kerberos delegation. Set to: ![]() ![]() | ||
headers | Document Optional. Fields that you want to explicitly override in the HTTP request header issued by the pub.client:http service. Specify a key in headers for each header field that you want to set, where the key's name represents the name of the header field and the key's value represents the value of that header field. If you do not set headers, the pub.client:http service uses the default header values for the Accept and User-Agent headers as determined by the watt.net.default.accept and watt.net.userAgent respectively. | ||
timeout | String Optional. Time, measured in milliseconds, that Integration Server waits for a response from the remote server before timing out and terminating the request. If you do not specify a value, Integration Server uses the value of the watt.net.timeout server configuration parameter. For information about the watt.net.timeout server configuration parameter, see webMethods Integration Server Administrator’s Guide. | ||
maxKeepAlive Connections | String Optional. Number of client keep alive connections that you want Integration Server to retain in the client connection pool it uses for this HTTP connection. Integration Server establishes a client connection pool for each protocol (i.e., HTTP or HTTPS), host, and port combination. How the service uses this input value differs based on whether a suitable client connection pool already exists for the HTTP connection. ![]() ![]() | ||
keepAliveTimeout | String Optional. Number of seconds that you want Integration Server to keep an idle connection in the client connection pool before closing it. Integration Server establishes a client connection pool for each protocol (i.e., HTTP or HTTPS), host, and port combination. How the service uses this input value differs based on whether a suitable client connection pool already exists for the HTTP connection. ![]() ![]() | ||
newSession | String Optional. Flag indicating whether a new session will be created for this HTTP request. This parameter overrides the watt.server.new.http.session.context server configuration parameter. For information about the watt.server.new.http.session.context server configuration parameter, see webMethods Integration Server Administrator’s Guide. Set to: ![]() ![]() | ||
trustStore | String Optional. Alias for the truststore that contains the list of certificates that Integration Server uses to validate the trust relationship. If you do not specify a truststore alias, the default truststore alias will be used. | ||
proxyAlias | String Optional. Name of the proxy alias for the proxy server to which Integration Server routes the HTTP request. If you do not specify a proxyAlias, Integration Server routes the HTTP request through the proxy server specified in the default HTTP proxy alias. If there is no default HTTP proxy alias, the action taken by Integration Server depends on the value specified for the watt.net.proxy.useNonDefaultProxies parameter. ![]() ![]() For more information about proxy server usage, refer to webMethods Integration Server Administrator’s Guide. | ||
connectTimeout | String Optional. Time, measured in milliseconds, that Integration Server waits to connect to the remote server before timing out and terminating the request. If you do not specify a value for connectTimeout, Integration Server uses the value specified for the watt.net.timeout server configuration parameter. If no value is specified for the watt.net.timeout server configuration parameter, Integration Server waits for the timeout value defined by the operating system before terminating the connection request. For more information about the watt.net.timeout server configuration parameter, see webMethods Integration Server Administrator’s Guide. | ||
useJSSE | String Optional. Whether to enable the use of the Java Secure Socket Extension (JSSE) socket factory for creating outbound HTTPS connections. Set to: ![]() ![]() Note: A value of yes or no for the useJSSE input parameter overrides the value of the watt.net.ssl.client.useJSSE server configuration property. Note: To control the cipher suites used on JSSE sockets that are used while making outbound HTTPS requests, set the server configuration property watt.net.jsse.client.enabledCipherSuiteList. For more information, see webMethods Integration Server Administrator’s Guide. |
encodedURL | String The URL that was submitted by pub.client:http. This will contain any argument set in args, table, or string. If the remote server redirected pub.client:http to a different location, encodedURL will contain the URL that pub.client:http submitted to the server to which it was redirected. | |
header | Document Conditional. HTTP response headers. | |
Key | Description | |
lines | Document Fields in the response header, where key names represent field names and values represent field values. | |
status | String HTTP status code of the response. | |
statusMessage | String HTTP status message of the response. | |
body | Document Body of the HTTP response. | |
Key | Description | |
bytes | byte[ ] Conditional. Body of the HTTP response represented as a byte[ ]. bytes is returned only when the loadAs input parameter is set to bytes. | |
stream | java.io.InputStream Conditional. The body of the HTTP response represented as an InputStream. stream is returned only when the loadAs input parameter is set to stream. |