org.mitre.taxii.client

Class HttpClient

java.lang.Object

org.mitre.taxii.client.HttpClient

public class HttpClient
extends java.lang.Object

This class does its best to comply with the "TAXII HTTP Protocol Binding Specification". It handles interaction with a TAXII HTTP server. This includes serializing TAXII Messages, managing the connection to the remote end point, parsing and unmarshaling the responses, and returning a TAXII Message back to the user.

There are two important components of this class.

1. An Apache Components CloseableHttpClient, HttpClient#getHttpClient This manages the HTTP protocol interaction. The default constructor will create a simple, pre-configured HttpClient based on the system properties. If you wish to use an HttpClient configured to use an explicit proxy, or a security certificate, you will need to construct and configure it, then apply it to the TAXII HttpClient.
2. One or more TaxiiXml objects, stored in taxiiXmlMap. These objects understand the TAXII JAXB environment. They are configured to handle parsing and generating a certain version of TAXII messages. There can be only one TaxiiXml object per TAXII version. The default constructor will create TaxiiXml objects for TAXII 1.0 and 1.1. You may, for example, want to provide a TaxiiXml object configured to handle STIX content blocks as well as TAXII 1.1 messages.

Usage example

    HttpClient taxiiClient = new HttpClient();

    final String serverUrl = "http://127.0.0.1:8080/services/discovery/";

    // Prepare the message to send.
    DiscoveryRequest dr = factory.createDiscoveryRequest()
            .withMessageId(MessageHelper.generateMessageId());

    // Call the service
    Object responseObj = taxiiClient.callTaxiiService(new URI(serverUrl), dr);
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_ACCEPT HTTP Accept header name
static java.lang.String	HEADER_CONTENT_TYPE HTTP Content-Type header name
static java.lang.String	HEADER_X_TAXII_ACCEPT X-TAXII-Accept header name
static java.lang.String	HEADER_X_TAXII_CONTENT_TYPE X-TAXII-Content-Type header name
static java.lang.String	HEADER_X_TAXII_PROTOCOL The X-TAXII-Protocol header name
static java.lang.String	HEADER_X_TAXII_SERVICES The X-TAXII-Services header name
static java.lang.String	SCHEME_HTTP
static java.lang.String	SCHEME_HTTPS

Constructor Summary

Constructors

Constructor and Description
HttpClient() Default constructor.
HttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient) Create a client with a pre-configured Apache HttpClient.
HttpClient(TaxiiXml taxiiXml, org.apache.http.impl.client.CloseableHttpClient httpClient) Create a client that uses a specific TaxiiXml object and a pre-configured Apache HttpClient.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	callTaxiiService(java.net.URI uri, java.lang.Object message) Send a TAXII message to an endpoint.
org.apache.http.impl.client.CloseableHttpClient	getHttpclient() Get the Apache Components HTTP Client in use by this object.
TaxiiXml	getVersionHandler(java.lang.String key)
void	setHttpclient(org.apache.http.impl.client.CloseableHttpClient httpclient) Set the Apache Components HTTP Client.
void	setVersionHandler(TaxiiXml taxiiXml) Assign a TAXII message handler.

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_HTTP

public static final java.lang.String SCHEME_HTTP

See Also:

Constant Field Values

SCHEME_HTTPS

public static final java.lang.String SCHEME_HTTPS

See Also:

Constant Field Values

HEADER_ACCEPT

public static final java.lang.String HEADER_ACCEPT

HTTP Accept header name

See Also:

Constant Field Values

HEADER_CONTENT_TYPE

public static final java.lang.String HEADER_CONTENT_TYPE

HTTP Content-Type header name

See Also:

Constant Field Values

HEADER_X_TAXII_ACCEPT

public static final java.lang.String HEADER_X_TAXII_ACCEPT

X-TAXII-Accept header name

See Also:

Constant Field Values

HEADER_X_TAXII_CONTENT_TYPE

public static final java.lang.String HEADER_X_TAXII_CONTENT_TYPE

X-TAXII-Content-Type header name

See Also:

Constant Field Values

HEADER_X_TAXII_PROTOCOL

public static final java.lang.String HEADER_X_TAXII_PROTOCOL

The X-TAXII-Protocol header name

See Also:

Constant Field Values

HEADER_X_TAXII_SERVICES

public static final java.lang.String HEADER_X_TAXII_SERVICES

The X-TAXII-Services header name

See Also:

Constant Field Values

Constructor Detail

HttpClient

public HttpClient(TaxiiXml taxiiXml,
          org.apache.http.impl.client.CloseableHttpClient httpClient)

Create a client that uses a specific TaxiiXml object and a pre-configured Apache HttpClient.

Parameters:

taxiiXml -

httpClient -

HttpClient

public HttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)

Create a client with a pre-configured Apache HttpClient. For example, one configured to use a proxy or SSL. TaxiiXml objects that handle TAXII 1.0 and 1.1 will be created.

Parameters:

httpClient -

HttpClient

public HttpClient()

Default constructor. Create a basic default CloseableHttpClient, handle TAXII 1.0 and 1.1 versions.

Method Detail

callTaxiiService

public java.lang.Object callTaxiiService(java.net.URI uri,
                                java.lang.Object message)
                                  throws javax.xml.bind.JAXBException,
                                         java.io.UnsupportedEncodingException,
                                         java.io.IOException

Send a TAXII message to an endpoint. The version of the message will be determined by its package name, which must match the package name of a TaxiiXml object in the taxiiXmlMap. If an appropriate message handler cannot be found, an exception is thrown. NOTE: It is expected that the response received will match the version of the message sent. The TAXII specification allows setting multiple values in the "x-taxii-accept" header. This library only sets and sends the version of the message being sent.

Parameters:

uri - The address of the endpoint to send the message to

message - The message to send.

Returns:

resultObj Either a TAXII response object of the same version as was passed in or "null" if parsing fails in a way that does not throw an exception.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

java.io.IOException

getHttpclient

public org.apache.http.impl.client.CloseableHttpClient getHttpclient()

Get the Apache Components HTTP Client in use by this object.

Returns:

the Apache Components HTTP Client used by this TAXII HTTP Client.

setHttpclient

public void setHttpclient(org.apache.http.impl.client.CloseableHttpClient httpclient)

Set the Apache Components HTTP Client. This method is very useful when needing an HttpClient configured to use a proxy or SSL certificates or other authorization technique.

Parameters:

httpclient -

setVersionHandler

public void setVersionHandler(TaxiiXml taxiiXml)

Assign a TAXII message handler. The version of TAXII the handler understands is extracted from the provided object. If another handler for the same version already exists, it will be replaced. There can be only one handler per TAXII version.

Parameters:

taxiiXml -

getVersionHandler

public TaxiiXml getVersionHandler(java.lang.String key)