Package com.ibm.security.access.httpclient

Class HttpClientV2

java.lang.Object

com.ibm.security.access.httpclient.HttpClientV2

public class HttpClientV2
extends Object

Implementation of a HTTP Client. Relies on Apache HttpClient. Example 1. Mapping rule invocation that uses the CookieStore functionality.

 importClass(Packages.com.ibm.security.access.httpclient.HttpClientV2);
 importClass(Packages.com.ibm.security.access.httpclient.RequestParameters);
 importClass(Packages.com.tivoli.am.fim.trustserver.sts.utilities.IDMappingExtUtils);

 // 1. Do an initial request to retrieve the PD-SESSION-ID cookie
 // Build the RequestParameters object.
 let params = new RequestParameters();
 params.setUrlString("https://www.mmfa.ibm.com");
 params.setTrustStore("pdsrv");
 params.setBasicAuthUsername("testuser");
 params.setBasicAuthPassword("Password");
 
 let resp = HttpClientV2.httpGet(params);
 var cookieStr = resp.getSerializedCookieStore();
 
 // 2. Store the cookie store string in the IDMappingExtCache (Not shown here)
 Cache.store("CookieStore", cookieStr);
 
 // 3. Make a second request that uses the PD-SESSION-ID cookie rather than BA
 params = new RequestParameters();
 params.setUrlString("https://www.mmfa.ibm.com");
 params.setTrustStore("pdsrv");
 params.setSerializedCookieStore(Cache.get("CookieStore"));
 resp = HttpClientV2.httpGet(params);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpClientV2.ClientMap	Client map class, which should be cleared on runtime reload.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SPECIAL_BODY_PARAM

Constructor Summary

Constructors

Constructor	Description
HttpClientV2()

Method Summary

Modifier and Type	Method	Description
static HttpResponse	httpDelete(RequestParameters params)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, String proxyServer)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout)	HTTP client DELETE method.
static HttpResponse	httpDelete(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout, String proxyServer)	HTTP client DELETE method.
static HttpResponse	httpGet(RequestParameters params)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client GET method.
static HttpResponse	httpGet(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout)	HTTP client GET method.
static HttpResponse	httpHead(RequestParameters params)	HTTP client HEAD method.
static HttpResponse	httpHead(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer)	HTTP client HEAD method.
static HttpResponse	httpHead(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client HEAD method.
static HttpResponse	httpHead(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client HEAD method.
static HttpResponse	httpOptions(RequestParameters params)	HTTP client OPTIONS method.
static HttpResponse	httpOptions(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer)	HTTP client OPTIONS method.
static HttpResponse	httpOptions(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client OPTIONS method.
static HttpResponse	httpOptions(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client OPTIONS method.
static HttpResponse	httpPatch(RequestParameters params)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout, boolean sendDataAsJson)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout, boolean sendDataAsJson, String proxyServer)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Headers headers, String body, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Parameters params)	HTTP client PATCH method.
static HttpResponse	httpPatch(String urlstr, Parameters params, boolean sendDataAsJson)	HTTP client PATCH method.
static HttpResponse	httpPost(RequestParameters params)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, boolean sendDataAsJson)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean sendDataAsJson)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, String body, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Headers headers, String body, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, int timeout)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Parameters params)	HTTP client POST method.
static HttpResponse	httpPost(String urlstr, Parameters params, boolean sendDataAsJson)	HTTP client POST method.
static HttpResponse	httpPut(RequestParameters params)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, boolean sendDataAsJson)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean sendDataAsJson)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwException, int timeout, boolean sendDataAsJson, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout, boolean sendDataAsJson)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, Parameters params, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, int timeout, boolean sendDataAsJson, String proxyServer)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, String body, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Headers headers, String body, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, int timeout)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Parameters params)	HTTP client PUT method.
static HttpResponse	httpPut(String urlstr, Parameters params, boolean sendDataAsJson)	HTTP client PUT method.
static HttpResponse	httpTrace(RequestParameters params)	HTTP client TRACE method.
static HttpResponse	httpTrace(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer)	HTTP client TRACE method.
static HttpResponse	httpTrace(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword)	HTTP client TRACE method.
static HttpResponse	httpTrace(String urlstr, Headers headers, String httpsTrustStore, String basicAuthUsername, String basicAuthPassword, String clientKeyStore, String clientKeyAlias, String protocol, boolean throwExec, int timeout, String proxyServer, String proxyUsername, String proxyPassword, CookieStore cookieStore)	HTTP client TRACE method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SPECIAL_BODY_PARAM

public static final String SPECIAL_BODY_PARAM

See Also:

• Constant Field Values

Constructor Details

HttpClientV2

public HttpClientV2()

Method Details

httpGet

public static HttpResponse httpGet(String urlstr)

HTTP client GET method.

Parameters:

urlstr - URL

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(RequestParameters params)

HTTP client GET method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

HttpResponse

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpGet

public static HttpResponse httpGet(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client GET method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpHead

public static HttpResponse httpHead(RequestParameters params)

HTTP client HEAD method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

HttpResponse

httpHead

public static HttpResponse httpHead(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer)

HTTP client HEAD method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpHead

public static HttpResponse httpHead(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client HEAD method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpHead

public static HttpResponse httpHead(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client HEAD method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpOptions

public static HttpResponse httpOptions(RequestParameters params)

HTTP client OPTIONS method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

HttpResponse

httpOptions

public static HttpResponse httpOptions(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer)

HTTP client OPTIONS method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpOptions

public static HttpResponse httpOptions(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client OPTIONS method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpOptions

public static HttpResponse httpOptions(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client OPTIONS method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpTrace

public static HttpResponse httpTrace(RequestParameters params)

HTTP client TRACE method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

HttpResponse

httpTrace

public static HttpResponse httpTrace(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer)

HTTP client TRACE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpTrace

public static HttpResponse httpTrace(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client TRACE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpTrace

public static HttpResponse httpTrace(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwExec,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client TRACE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The name of the trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwExec - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Parameters params)

HTTP client POST method.

Parameters:

urlstr - URL

params - Parameters to be added to the request body.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Parameters params,
 boolean sendDataAsJson)

HTTP client POST method.

Parameters:

urlstr - URL

params - Parameters to be added to the request body.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 String body,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

body - A String representation of the HTTP POST Body

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 String body,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 int timeout)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

body - A String representation of the HTTP POST Body

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 boolean sendDataAsJson)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean sendDataAsJson)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(RequestParameters params)

HTTP client POST method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

HttpResponse

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPost

public static HttpResponse httpPost(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client POST method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Parameters params)

HTTP client PUT method.

Parameters:

urlstr - URL

params - Parameters to be added to the request body.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Parameters params,
 boolean sendDataAsJson)

HTTP client PUT method.

Parameters:

urlstr - URL

params - Parameters to be added to the request body.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 String body,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

body - A String representation of the HTTP PUT Body

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 String body,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 int timeout)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

body - A String representation of the HTTP PUT Body

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 boolean sendDataAsJson)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean sendDataAsJson)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout,
 boolean sendDataAsJson)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(RequestParameters params)

HTTP client PUT method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPut

public static HttpResponse httpPut(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client PUT method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Parameters params)

HTTP client PATCH method.

Parameters:

urlstr - URL

params - Parameters to be added to the request body.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Parameters params,
 boolean sendDataAsJson)

HTTP client PATCH method.

Parameters:

urlstr - URL

params - Parameters to be added to the request body.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 String body,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

body - A String representation of the HTTP PUT Body

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout,
 boolean sendDataAsJson)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(RequestParameters params)

HTTP client PATCH method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpPatch

public static HttpResponse httpPatch(String urlstr,
 Headers headers,
 Parameters params,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 boolean sendDataAsJson,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client PATCH method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

params - Parameters to be added to the request body.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

sendDataAsJson - If the post data should be json formatted or not.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(String urlstr)

HTTP client DELETE method.

Parameters:

urlstr - URL

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol)

HTTP client DELETE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout)

HTTP client DELETE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 int timeout,
 String proxyServer)

HTTP client DELETE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(RequestParameters params)

HTTP client DELETE method.

Parameters:

params - The parameter object containing the required request parameters.

Returns:

httpDelete

public static HttpResponse httpDelete(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 String proxyServer)

HTTP client DELETE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword)

HTTP client DELETE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.

httpDelete

public static HttpResponse httpDelete(String urlstr,
 Headers headers,
 String httpsTrustStore,
 String basicAuthUsername,
 String basicAuthPassword,
 String clientKeyStore,
 String clientKeyAlias,
 String protocol,
 boolean throwException,
 int timeout,
 String proxyServer,
 String proxyUsername,
 String proxyPassword,
 CookieStore cookieStore)

HTTP client DELETE method.

Parameters:

urlstr - URL

headers - Headers to be added to the request header.

httpsTrustStore - The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the advanced configuration parameter util.httpClientv2.defaultTrustStore will be used.

basicAuthUsername - Basic-auth username. If null, basic-auth will be disabled.

basicAuthPassword - Basic-auth password. If null, basic-auth will be disabled.

clientKeyStore - Client key store. If null, client cert auth will be disabled.

clientKeyAlias - Client key alias. If null, client cert auth will be disabled.

protocol - SSL protocol to use for this connection. Valid values are: TLS, TLSv1, TLSv1.1, TLSv1.2. If not provided the value of the advanced configuration property 'util.httpClient.defaultSSLProtocol' will be used. FIPS and NIST mode will override this value.

throwException - If an exception should be raised, or handled

timeout - Request timeout in seconds. A value of 0 will result in no connection timeout. If set to a value less than 0 the timeout will be set as the advanced configuration property util.httpClientv2.connectTimeout.

proxyServer - The full name of the proxy server to use. Eg: https://proxy.com:443. Set as null if a proxy server is not required.

proxyUsername - The username to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

proxyPassword - The password to use for authentication to the proxy server. Eg: username:password@proxy Set as null if a proxy authentication is not required.

cookieStore - The CookieStore to set in the request. Set as null if not required.

Returns:

The HTTP response. Null if invalid URL or no response.