com.atakmap.comms.http

Class TakHttpClient

java.lang.Object

com.atakmap.comms.http.TakHttpClient

public class TakHttpClient
extends java.lang.Object

Creates an HttpClient with proper TLS certificates

Constructor Summary

Constructors

Constructor and Description
TakHttpClient(java.lang.String url) Setup HTTP client.
TakHttpClient(java.lang.String baseUrl, org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory) Setup HTTP client with a given sslSocketFactory.
TakHttpClient(java.lang.String baseUrl, org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory, int connectTimeout, int soTimeout) Setup HTTP client with a given sslSocketFactory and custom timeout values.
TakHttpClient(java.lang.String url, java.lang.String connectString) Setup HTTP client.

Method Summary

Modifier and Type	Method and Description
void	addBasicAuthentication(HttpRequestBase request) Add Basic Auth for HTTP, not HTTPS (which typically uses client certificates)
void	addBasicAuthentication(HttpRequestBase request, AtakAuthenticationCredentials credentials) Add Basic Auth for the request using the credentials provided
TakHttpResponse	execute(HttpRequestBase request)
TakHttpResponse	execute(HttpRequestBase request, AtakAuthenticationCredentials credentials)
TakHttpResponse	execute(HttpRequestBase request, boolean bAddAuth)
java.lang.String	get(java.lang.String url) Perform an HTTP GET on the URL
java.lang.String	get(java.lang.String url, java.lang.String verify) Perform an HTTP GET on the URL
java.lang.String	get(java.lang.String url, java.lang.String verify, java.lang.String accept)
java.lang.String	get(java.lang.String url, java.lang.String verify, java.lang.String accept, java.lang.String acceptEncoding) Perform an HTTP GET on the URL
java.lang.String	getGZip(java.lang.String url, java.lang.String verify) Perform an HTTP GET on the URL, support GZip
java.lang.String	getGZip(java.lang.String url, java.lang.String verify, java.lang.String accept) Perform an HTTP GET on the URL, support GZip
static TakHttpClient	GetHttpClient(org.apache.http.conn.ssl.SSLSocketFactory factory, java.lang.String url) Creates an HttpClient using specified socket factory
static TakHttpClient	GetHttpClient(java.lang.String url) Creates an HttpClient and proper TAK Server base URL Uses internally stored certificates
static TakHttpClient	GetHttpClient(java.lang.String url, java.lang.String connectString) Creates an HttpClient and proper TAK Server base URL Uses internally stored certificates
java.lang.String	getUrl() Get the TAK (Server) base URL
java.lang.String	getUrl(java.lang.String path) Get the TAK (Server) URL for specified path
boolean	head(java.lang.String url) Perform HTTP HEAD on the URL
void	shutdown()
boolean	useBasicAuth() False for HTTPs, true for HTTP

Methods inherited from class java.lang.Object

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

Constructor Detail

TakHttpClient

public TakHttpClient(java.lang.String url)

Setup HTTP client. HTTPS base URLs use TLS to include client certificates. Uses internally stored certificates HTTP URLs use Basic Auth

Parameters:

url - the base url

TakHttpClient

public TakHttpClient(java.lang.String url,
                     java.lang.String connectString)

Setup HTTP client. HTTPS base URLs use TLS to include client certificates. Uses internally stored certificates HTTP URLs use Basic Auth

Parameters:

url - the base url

connectString - the connectString which is in turn used for the certificate lookup to ensure that https are made with the correct client cert for the port

TakHttpClient

public TakHttpClient(java.lang.String baseUrl,
                     org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)

Setup HTTP client with a given sslSocketFactory. Note it is up to the caller to provide a complete baseUrl with protocol, host, and port info

Parameters:

baseUrl - the base url

sslSocketFactory - the socket factory to be used

TakHttpClient

public TakHttpClient(java.lang.String baseUrl,
                     org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory,
                     int connectTimeout,
                     int soTimeout)

Setup HTTP client with a given sslSocketFactory and custom timeout values. Note it is up to the caller to provide a complete baseUrl with protocol, host, and port info

Parameters:

baseUrl - the base url

sslSocketFactory - the socket factory to be used

connectTimeout - the connection timeout

soTimeout - the socket timeout

Method Detail

GetHttpClient

public static TakHttpClient GetHttpClient(java.lang.String url)

Creates an HttpClient and proper TAK Server base URL Uses internally stored certificates

Parameters:

url - the base url

Returns:

the corresponding client

GetHttpClient

public static TakHttpClient GetHttpClient(java.lang.String url,
                                          java.lang.String connectString)

Creates an HttpClient and proper TAK Server base URL Uses internally stored certificates

Parameters:

url - the base url

connectString - the connectString which is in turn used for the certificate lookup to ensure that https are made with the correct client cert for the port

Returns:

the corresponding client

GetHttpClient

public static TakHttpClient GetHttpClient(org.apache.http.conn.ssl.SSLSocketFactory factory,
                                          java.lang.String url)

Creates an HttpClient using specified socket factory

Parameters:

factory - the socket factory to use

url - the url to use when creating a client

Returns:

the client corresponding to the url.

getUrl

public java.lang.String getUrl()

Get the TAK (Server) base URL

Returns:

the String representation of the baseURL

getUrl

public java.lang.String getUrl(java.lang.String path)

Get the TAK (Server) URL for specified path

Parameters:

path - the path to be used for lookup

Returns:

the path appropriately added to the url

useBasicAuth

public boolean useBasicAuth()

False for HTTPs, true for HTTP

Returns:

false if the url is https

addBasicAuthentication

public void addBasicAuthentication(HttpRequestBase request)

Add Basic Auth for HTTP, not HTTPS (which typically uses client certificates)

Parameters:

request - the request to add basic auth to.

addBasicAuthentication

public void addBasicAuthentication(HttpRequestBase request,
                                   AtakAuthenticationCredentials credentials)

Add Basic Auth for the request using the credentials provided

Parameters:

request - the request to add basic auth to.

credentials - the credentials to use to set up the basic auth.

get

public java.lang.String get(java.lang.String url)
                     throws java.io.IOException

Perform an HTTP GET on the URL

Parameters:

url - URL to get

Returns:

response body as String if HTTP OK 200 is returned by server

Throws:

java.io.IOException

get

public java.lang.String get(java.lang.String url,
                            java.lang.String verify)
                     throws java.io.IOException

Perform an HTTP GET on the URL

Parameters:

url - URL to get

verify - Verify response contains this string

Returns:

response body as String if HTTP OK 200 is returned by server

Throws:

java.io.IOException

get

public java.lang.String get(java.lang.String url,
                            java.lang.String verify,
                            java.lang.String accept)
                     throws java.io.IOException

Throws:

java.io.IOException

getGZip

public java.lang.String getGZip(java.lang.String url,
                                java.lang.String verify)
                         throws java.io.IOException

Perform an HTTP GET on the URL, support GZip

Parameters:

url - the url to perform a http get on.

verify - the string that is to be contained in the response

Returns:

response body as String if HTTP OK 200 is returned by serve

Throws:

java.io.IOException - when there is an issue with the gzip'd data

getGZip

public java.lang.String getGZip(java.lang.String url,
                                java.lang.String verify,
                                java.lang.String accept)
                         throws java.io.IOException

Perform an HTTP GET on the URL, support GZip

Parameters:

url - the url to perform a http get on.

verify - the string that is to be contained in the response

accept - Set "Accept" header on request

Returns:

response body as String if HTTP OK 200 is returned by serve

Throws:

java.io.IOException - when there is an issue with the gzip'd data

get

public java.lang.String get(java.lang.String url,
                            java.lang.String verify,
                            java.lang.String accept,
                            java.lang.String acceptEncoding)
                     throws java.io.IOException

Perform an HTTP GET on the URL

Parameters:

url - URL to get

verify - Verify response contains this string

accept - Set "Accept" header on request

Returns:

response body as String if HTTP OK 200 is returned by server

Throws:

java.io.IOException

head

public boolean head(java.lang.String url)
             throws java.io.IOException

Perform HTTP HEAD on the URL

Parameters:

url - url to perform a http head on.

Returns:

true if content is not on server (does not return HTTP OK 200)

Throws:

java.io.IOException

execute

public TakHttpResponse execute(HttpRequestBase request)
                        throws java.io.IOException

Throws:

java.io.IOException

execute

public TakHttpResponse execute(HttpRequestBase request,
                               boolean bAddAuth)
                        throws java.io.IOException

Throws:

java.io.IOException

execute

public TakHttpResponse execute(HttpRequestBase request,
                               AtakAuthenticationCredentials credentials)
                        throws java.io.IOException

Throws:

java.io.IOException

shutdown

public void shutdown()