Class HttpClient
- java.lang.Object
-
- com.ibm.security.access.httpclient.HttpClient
-
public class HttpClient extends java.lang.Object
Implementation of a HTTP Client. Relies on com.tivoli.am.fim.soap.client implementation of HttpClient.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
HttpClient_java_copyright
static java.lang.String
HttpClient_java_sourceCodeID
static java.lang.String
SPECIAL_BODY_PARAM
-
Constructor Summary
Constructors Constructor Description HttpClient()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static HttpResponse
httpDelete(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client DELETE method.static HttpResponse
httpGet(java.lang.String urlstr)
HTTP client GET method.static HttpResponse
httpGet(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client GET method.static HttpResponse
httpGet(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client GET method.static HttpResponse
httpGet(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, boolean throwExec, int timeout)
HTTP client GET method.static HttpResponse
httpGet(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, int timeout)
HTTP client GET method.static HttpResponse
httpPatch(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
static HttpResponse
httpPost(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client POST method.static HttpResponse
httpPost(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client POST method.static HttpResponse
httpPost(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, boolean throwException, int timeout)
HTTP client POST method.static HttpResponse
httpPost(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client POST method.static HttpResponse
httpPost(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, int timeout)
HTTP client POST method.static HttpResponse
httpPost(java.lang.String urlstr, Parameters params)
HTTP client POST method.static HttpResponse
httpPut(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client PUT method.static HttpResponse
httpPut(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client PUT method.static HttpResponse
httpPut(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, int timeout)
HTTP client PUT method.static HttpResponse
httpPut(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client PUT method.static HttpResponse
httpPut(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, int timeout)
HTTP client PUT method.static HttpResponse
httpPut(java.lang.String urlstr, Parameters params)
HTTP client PUT method.
-
-
-
Field Detail
-
HttpClient_java_sourceCodeID
public static final java.lang.String HttpClient_java_sourceCodeID
- See Also:
- Constant Field Values
-
HttpClient_java_copyright
public static final java.lang.String HttpClient_java_copyright
-
SPECIAL_BODY_PARAM
public static final java.lang.String SPECIAL_BODY_PARAM
- See Also:
- Constant Field Values
-
-
Method Detail
-
httpGet
public static HttpResponse httpGet(java.lang.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(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client GET method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client GET method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, int timeout)
HTTP client GET method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpGet
public static HttpResponse httpGet(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, boolean throwExec, int timeout)
HTTP client GET method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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 handledtimeout
- Request timeout in seconds- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPost
public static HttpResponse httpPost(java.lang.String urlstr, Parameters params)
HTTP client POST method.- Parameters:
urlstr
- URLparams
- Parameters to be added to the request body.- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPost
public static HttpResponse httpPost(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client POST method.- Parameters:
urlstr
- URLheaders
- Headers to be added to the request header.body
- A String representation of the HTTP POST BodyhttpsTrustStore
- The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the override configs 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(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, int timeout)
HTTP client POST method.- Parameters:
urlstr
- URLheaders
- Headers to be added to the request header.body
- A String representation of the HTTP POST BodyhttpsTrustStore
- The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the override configs 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- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPost
public static HttpResponse httpPost(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client POST method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client POST method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, boolean throwException, int timeout)
HTTP client POST method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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 handledtimeout
- Request timeout in seconds- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPut
public static HttpResponse httpPut(java.lang.String urlstr, Parameters params)
HTTP client PUT method.- Parameters:
urlstr
- URLparams
- Parameters to be added to the request body.- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPut
public static HttpResponse httpPut(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client PUT method.- Parameters:
urlstr
- URLheaders
- Headers to be added to the request header.body
- A String representation of the HTTP PUT BodyhttpsTrustStore
- The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the override configs 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(java.lang.String urlstr, Headers headers, java.lang.String body, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, int timeout)
HTTP client PUT method.- Parameters:
urlstr
- URLheaders
- Headers to be added to the request header.body
- A String representation of the HTTP PUT BodyhttpsTrustStore
- The trust store to use. If a HTTPS connection is required and this is set to NULL, the default trust store specified in the override configs 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- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPut
public static HttpResponse httpPut(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias)
HTTP client PUT method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client PUT method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol, int timeout)
HTTP client PUT method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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- Returns:
- The HTTP response. Null if invalid URL or no response.
-
httpPatch
public static HttpResponse httpPatch(java.lang.String urlstr, Headers headers, Parameters params, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
- Parameters:
urlstr
- URLheaders
- 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 override configs 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(java.lang.String urlstr, Headers headers, java.lang.String httpsTrustStore, java.lang.String basicAuthUsername, java.lang.String basicAuthPassword, java.lang.String clientKeyStore, java.lang.String clientKeyAlias, java.lang.String protocol)
HTTP client DELETE method.- Parameters:
urlstr
- URLheaders
- 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 override configs 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.
-
-