org.hawkular.bus.restclient

Class RestClient

java.lang.Object

org.hawkular.bus.restclient.RestClient

public class RestClient
extends Object

You can use this to consume and produce messages on the Hawkular bus. This class is purposefully designed to be simple with very few dependencies (just requires Apache's httpclient and JBoss Logging). Specifically, you do not need any other Hawkular libraries to be able to use this to send messages to the Hawkular bus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestClient.Type

Constructor Summary

Constructors

Constructor and Description
RestClient(String host, Integer port) Creates the sender with a default HTTP endpoint of the REST server.
RestClient(String protocol, String host, Integer port) Creates the sender with a default endpoint of the REST server.
RestClient(URL endpoint) Endpoint of the REST server, not including the fragment that consists of the queue/topic name.

Method Summary

Modifier and Type	Method and Description
protected URL	appendToURL(URL url, String appendage)
URL	getEndpoint()
protected URL	getEndpointForType(RestClient.Type type, String name)
protected org.apache.http.HttpResponse	postMessage(RestClient.Type type, String name, String jsonPayload, Map<String,String> headers)
org.apache.http.HttpResponse	postQueueMessage(String queueName, String jsonPayload, Map<String,String> headers) Sends a message to the REST endpoint in order to put a message on the given queue.
org.apache.http.HttpResponse	postTopicMessage(String topicName, String jsonPayload, Map<String,String> headers) Sends a message to the REST endpoint in order to put a message on the given topic.
protected org.apache.http.HttpResponse	sendPost(URI uri, String jsonPayload, Map<String,String> headers)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

public RestClient(String host,
                  Integer port)
           throws RestClientException

Creates the sender with a default HTTP endpoint of the REST server.

Parameters:

host - the remote server

port - if null or -1, no port will be specified in the URL

Throws:

RestClientException - if the endpoint cannot be used to refer to queues or topics or if one of the parameters consists of invalid URL syntax

RestClient

public RestClient(String protocol,
                  String host,
                  Integer port)
           throws RestClientException

Creates the sender with a default endpoint of the REST server.

Parameters:

protocol - http or https

host - the remote server

port - if null or -1, no port will be specified in the URL

Throws:

RestClientException - if the endpoint cannot be used to refer to queues or topics or if one of the parameters consists of invalid URL syntax

RestClient

public RestClient(URL endpoint)
           throws RestClientException

Endpoint of the REST server, not including the fragment that consists of the queue/topic name. For example: http://host:8080/hawkular-bus/message/ If the given URL does not end with a "/", one will be added to it.

Parameters:

endpoint - the REST server endpoint, not including the queue/topic name

Throws:

RestClientException - if the endpoint cannot be used to refer to queues or topics

Method Detail

getEndpoint

public URL getEndpoint()

Returns:

the REST endpoint not inluding the fragment that consists of the queue/topic name.

postTopicMessage

public org.apache.http.HttpResponse postTopicMessage(String topicName,
                                                     String jsonPayload,
                                                     Map<String,String> headers)
                                              throws RestClientException

Sends a message to the REST endpoint in order to put a message on the given topic.

Parameters:

topicName - name of the topic

jsonPayload - the actual message (as a JSON string) to put on the bus

headers - any headers to send with the message (can be null or empty)

Returns:

the response

Throws:

RestClientException - if the response was not a 200 status code

postQueueMessage

public org.apache.http.HttpResponse postQueueMessage(String queueName,
                                                     String jsonPayload,
                                                     Map<String,String> headers)
                                              throws RestClientException

Sends a message to the REST endpoint in order to put a message on the given queue.

Parameters:

queueName - name of the queue

jsonPayload - the actual message (as a JSON string) to put on the bus

headers - any headers to send with the message (can be null or empty)

Returns:

the response

Throws:

RestClientException - if the response was not a 200 status code

postMessage

protected org.apache.http.HttpResponse postMessage(RestClient.Type type,
                                                   String name,
                                                   String jsonPayload,
                                                   Map<String,String> headers)
                                            throws RestClientException

Throws:

RestClientException

sendPost

protected org.apache.http.HttpResponse sendPost(URI uri,
                                                String jsonPayload,
                                                Map<String,String> headers)
                                         throws RestClientException

Throws:

RestClientException

getEndpointForType

protected URL getEndpointForType(RestClient.Type type,
                                 String name)
                          throws RestClientException

Throws:

RestClientException

appendToURL

protected URL appendToURL(URL url,
                          String appendage)
                   throws RestClientException

Throws:

RestClientException