HttpService (splunk 1.9.1 API)

java.lang.Object
- com.splunk.HttpService

Direct Known Subclasses:

Service
```
public class HttpService
extends Object
```
The HttpService class represents a generic HTTP service at a given address (host:port), accessed using a given protocol scheme (http or https).

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`connectTimeout`
`protected com.splunk.SimpleCookieStore`	`cookieStore`
`protected Map<String,String>`	`customHeaders`
`protected String`	`host` The host name of the service.
`protected URLStreamHandler`	`httpsHandler` A variable to hold an optional custom HTTPS handler
`protected int`	`port` The port number of the service.
`protected Integer`	`readTimeout`
`protected String`	`scheme` The scheme used to access the service.
`protected static SSLSecurityProtocol`	`sslSecurityProtocol`
`protected static boolean`	`validateCertificates` Boolean flag for validating certificates at either of the sides (client/server).

Constructor Summary

Constructors
Constructor and Description
`HttpService()` Constructs a new `HttpService` instance.
`HttpService(String host)` Constructs a new `HttpService` instance at the given host.
`HttpService(String host, int port)` Constructs a new `HttpService` instance at the given host and port.
`HttpService(String host, int port, String scheme)` Constructs a new `HttpService` instance using the given host, port, and scheme.
`HttpService(String host, int port, String scheme, URLStreamHandler httpsHandler)` Constructs a new `HttpService` instance using the given host, port, and scheme, and instructing it to use the specified HTTPS handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCookie(String setCookieHeader)` Adds the passed cookie header to the cookieStore
`static SSLSocketFactory`	`createSSLFactory()`
`ResponseMessage`	`delete(String path)` Issues a DELETE request against the service using a given path.
`ResponseMessage`	`delete(String path, Map<String,Object> args)` Issues a DELETE request against the service using a given path and query arguments.
`ResponseMessage`	`get(String path)` Issues an HTTP GET request against the service using a given path.
`ResponseMessage`	`get(String path, Map<String,Object> args)` Issues an HTTP GET request against the service using a given path and query arguments.
`Integer`	`getConnectTimeout()` Returns the connect timeout used by this service.
`Map<String,String>`	`getCustomHeaders()` Returns all the stored custom headers
`String`	`getHost()` Returns the host name of this service.
`int`	`getPort()` Returns the port number of this service.
`String`	`getPrefix()` Returns the URL prefix of this service, consisting of `scheme://host[:port]`.
`Integer`	`getReadTimeout()` Returns the read timeout used by this service.
`String`	`getScheme()` Returns the scheme used by this service.
`static SSLSecurityProtocol`	`getSslSecurityProtocol()` Returns the SSL security protocol of this service.
`static SSLSocketFactory`	`getSSLSocketFactory()`
`URL`	`getUrl(String path)` Constructs a fully-qualified URL for this service using a given path.
`Boolean`	`hasSplunkAuthCookies()` Returns true if the cookieStore has any Splunk Authorization cookies, false otherwise
`ResponseMessage`	`post(String path)` Issues a POST request against the service using a given path.
`ResponseMessage`	`post(String path, Map<String,Object> args)` Issues a POST request against the service using a given path and form arguments.
`void`	`removeAllCookies()` Removes all cookies from the cookieStore
`ResponseMessage`	`send(String path, RequestMessage request)` Issue an HTTP request against the service using a given path and request message.
`void`	`setConnectTimeout(Integer connectTimeout)` Sets a specified timeout value, in milliseconds, to be used when opening a communications link.
`void`	`setCustomHeaders(Map<String,String> headers)` Sets Custom Headers of this service
`void`	`setReadTimeout(Integer readTimeout)` Sets a specified timeout value, in milliseconds, to be used when reading from a communications link.
`static void`	`setSslSecurityProtocol(SSLSecurityProtocol securityProtocol)` Sets the SSL security protocol of this service.
`static void`	`setSSLSocketFactory(SSLSocketFactory sslSocketFactory)`
`static void`	`setValidateCertificates(boolean validateCertificates)`
`String`	`stringifyCookies()` Returns all the stored cookies

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sslSecurityProtocol
```
protected static SSLSecurityProtocol sslSecurityProtocol
```
  - validateCertificates
```
protected static boolean validateCertificates
```
    Boolean flag for validating certificates at either of the sides (client/server). If true, then it will check and validate relevant certificates otherwise, in case of false, it will accept all certificates. For PROD environment, TRUE is strongly recommended, whereas working in localhost OR development environment, FALSE is used. Default Value: TRUE
  - httpsHandler
```
protected URLStreamHandler httpsHandler
```
    A variable to hold an optional custom HTTPS handler
  - scheme
```
protected String scheme
```
    The scheme used to access the service.
  - host
```
protected String host
```
    The host name of the service.
  - port
```
protected int port
```
    The port number of the service.
  - connectTimeout
```
protected Integer connectTimeout
```
  - readTimeout
```
protected Integer readTimeout
```
  - customHeaders
```
protected Map<String,String> customHeaders
```
  - cookieStore
```
protected com.splunk.SimpleCookieStore cookieStore
```
- Constructor Detail
  - HttpService
```
public HttpService()
```
    Constructs a new HttpService instance.
  - HttpService
```
public HttpService(String host)
```
    Constructs a new HttpService instance at the given host.
    
    Parameters:
    
    host - The host name of the service.
  - HttpService
```
public HttpService(String host,
                   int port)
```
    Constructs a new HttpService instance at the given host and port.
    
    Parameters:
    
    host - The host name of the service.
    
    port - The port number of the service.
  - HttpService
```
public HttpService(String host,
                   int port,
                   String scheme)
```
    Constructs a new HttpService instance using the given host, port, and scheme.
    
    Parameters:
    
    host - The host name of the service.
    
    port - The port number of the service.
    
    scheme - Scheme for accessing the service (http or https).
  - HttpService
```
public HttpService(String host,
                   int port,
                   String scheme,
                   URLStreamHandler httpsHandler)
```
    Constructs a new HttpService instance using the given host, port, and scheme, and instructing it to use the specified HTTPS handler.
    
    Parameters:
    
    host - The host name of the service.
    
    port - The port number of the service.
    
    scheme - Scheme for accessing the service (http or https).
    
    httpsHandler - A custom URL Stream handler.
- Method Detail
  - get
```
public ResponseMessage get(String path)
```
    Issues an HTTP GET request against the service using a given path.
    
    Parameters:
    
    path - The request path.
    
    Returns:
    
    The HTTP response.
  - get
```
public ResponseMessage get(String path,
                           Map<String,Object> args)
```
    Issues an HTTP GET request against the service using a given path and query arguments.
    
    Parameters:
    
    path - The request path.
    
    args - The query arguments.
    
    Returns:
    
    The HTTP response.
  - getHost
```
public String getHost()
```
    Returns the host name of this service.
    
    Returns:
    
    The host name.
  - getPort
```
public int getPort()
```
    Returns the port number of this service.
    
    Returns:
    
    The port number.
  - setCustomHeaders
```
public void setCustomHeaders(Map<String,String> headers)
```
    Sets Custom Headers of this service
    
    Parameters:
    
    headers - The custom headers.
  - getSslSecurityProtocol
```
public static SSLSecurityProtocol getSslSecurityProtocol()
```
    Returns the SSL security protocol of this service.
    
    Returns:
    
    The SSL security protocol.
  - setSslSecurityProtocol
```
public static void setSslSecurityProtocol(SSLSecurityProtocol securityProtocol)
```
    Sets the SSL security protocol of this service.
    
    Parameters:
    
    securityProtocol - The SSLSecurityProtocal instance
  - getPrefix
```
public String getPrefix()
```
    Returns the URL prefix of this service, consisting of scheme://host[:port].
    
    Returns:
    
    The URL prefix.
  - getScheme
```
public String getScheme()
```
    Returns the scheme used by this service.
    
    Returns:
    
    The scheme.
  - getUrl
```
public URL getUrl(String path)
```
    Constructs a fully-qualified URL for this service using a given path.
    
    Parameters:
    
    path - The path to qualify.
    
    Returns:
    
    The fully-qualified URL for the service.
  - getCustomHeaders
```
public Map<String,String> getCustomHeaders()
```
    Returns all the stored custom headers
    
    Returns:
    
    customHeaders The custom headers
  - stringifyCookies
```
public String stringifyCookies()
```
    Returns all the stored cookies
    
    Returns:
    
    All cookies as in a string in the format key=value; key=value; etc=etc
  - addCookie
```
public void addCookie(String setCookieHeader)
```
    Adds the passed cookie header to the cookieStore
    
    Parameters:
    
    setCookieHeader - The result from a getRequestHeader("Set-Cookie") call
  - removeAllCookies
```
public void removeAllCookies()
```
    Removes all cookies from the cookieStore
  - hasSplunkAuthCookies
```
public Boolean hasSplunkAuthCookies()
```
    Returns true if the cookieStore has any Splunk Authorization cookies, false otherwise
    
    Returns:
    
    True if there are cookies, false otherwise
  - getConnectTimeout
```
public Integer getConnectTimeout()
```
    Returns the connect timeout used by this service.
    
    Returns:
    
    The timeout in milliseconds.
  - setConnectTimeout
```
public void setConnectTimeout(Integer connectTimeout)
```
    Sets a specified timeout value, in milliseconds, to be used when opening a communications link.
    
    Parameters:
    
    connectTimeout - timeout in milliseconds, a timeout of zero is interpreted as an infinite timeout.
  - getReadTimeout
```
public Integer getReadTimeout()
```
    Returns the read timeout used by this service.
    
    Returns:
    
    The timeout in milliseconds.
  - setReadTimeout
```
public void setReadTimeout(Integer readTimeout)
```
    Sets a specified timeout value, in milliseconds, to be used when reading from a communications link.
    
    Parameters:
    
    readTimeout - timeout in milliseconds, a timeout of zero is interpreted as an infinite timeout.
  - post
```
public ResponseMessage post(String path)
```
    Issues a POST request against the service using a given path.
    
    Parameters:
    
    path - The request path.
    
    Returns:
    
    The HTTP response.
  - post
```
public ResponseMessage post(String path,
                            Map<String,Object> args)
```
    Issues a POST request against the service using a given path and form arguments.
    
    Parameters:
    
    path - The request path.
    
    args - The form arguments.
    
    Returns:
    
    The HTTP response.
  - delete
```
public ResponseMessage delete(String path)
```
    Issues a DELETE request against the service using a given path.
    
    Parameters:
    
    path - The request path.
    
    Returns:
    
    The HTTP response.
  - delete
```
public ResponseMessage delete(String path,
                              Map<String,Object> args)
```
    Issues a DELETE request against the service using a given path and query arguments.
    
    Parameters:
    
    path - The request path.
    
    args - The query arguments.
    
    Returns:
    
    The HTTP response.
  - send
```
public ResponseMessage send(String path,
                            RequestMessage request)
```
    Issue an HTTP request against the service using a given path and request message.
    
    Parameters:
    
    path - The request path.
    
    request - The request message.
    
    Returns:
    
    The HTTP response.
  - setSSLSocketFactory
```
public static void setSSLSocketFactory(SSLSocketFactory sslSocketFactory)
```
  - getSSLSocketFactory
```
public static SSLSocketFactory getSSLSocketFactory()
```
  - setValidateCertificates
```
public static void setValidateCertificates(boolean validateCertificates)
```
  - createSSLFactory
```
public static SSLSocketFactory createSSLFactory()
```

Class HttpService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sslSecurityProtocol

validateCertificates

httpsHandler

scheme

host

port

connectTimeout

readTimeout

customHeaders

cookieStore

Constructor Detail

HttpService

HttpService

HttpService

HttpService

HttpService

Method Detail

get

get

getHost

getPort

setCustomHeaders

getSslSecurityProtocol

setSslSecurityProtocol

getPrefix

getScheme

getUrl

getCustomHeaders

stringifyCookies

addCookie

removeAllCookies

hasSplunkAuthCookies

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

post

post

delete

delete

send

setSSLSocketFactory

getSSLSocketFactory

setValidateCertificates

createSSLFactory