com.whizzosoftware.hobson.api.plugin.http

Class AbstractHttpClientPlugin

java.lang.Object

com.whizzosoftware.hobson.api.plugin.AbstractHobsonPlugin

com.whizzosoftware.hobson.api.plugin.http.AbstractHttpClientPlugin

All Implemented Interfaces:

EventLoopExecutor, HobsonPlugin

public abstract class AbstractHttpClientPlugin
extends AbstractHobsonPlugin

An abstract base class for plugins that poll their devices using HTTP/HTTPS. It provides some convenience methods for making HTTP calls asynchronously.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
AbstractHttpClientPlugin(java.lang.String pluginId, java.lang.String version, java.lang.String description)
AbstractHttpClientPlugin(java.lang.String pluginId, java.lang.String version, java.lang.String description, HttpClientChannel httpChannel)

Method Summary

Modifier and Type	Method and Description
WebSocketHandle	createWebSocket(java.net.URI uri) Creates a WebSocket client.
WebSocketHandle	createWebSocket(java.net.URI uri, java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> headers) Creates a WebSocket client.
abstract void	onHttpRequestFailure(java.lang.Throwable cause, java.lang.Object context) Callback for unsuccessful HTTP responses.
abstract void	onHttpResponse(HttpResponse response, java.lang.Object context) Callback for successful HTTP responses.
void	sendHttpRequest(java.net.URI uri, HttpRequest.Method method, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Collection<Cookie> cookies, byte[] body, java.lang.Object context) Sends an HTTP request.
void	sendHttpRequest(java.net.URI uri, HttpRequest.Method method, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Collection<Cookie> cookies, java.lang.Object context) Sends an HTTP request.
void	sendHttpRequest(java.net.URI uri, HttpRequest.Method method, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.Object context) Sends an HTTP request.
void	sendHttpRequest(java.net.URI uri, HttpRequest.Method method, java.lang.Object context) Sends an HTTP request.

Methods inherited from class com.whizzosoftware.hobson.api.plugin.AbstractHobsonPlugin

addJobStatusMessage, deleteDeviceProxy, executeInEventLoop, executeTask, getAccessManager, getActionClass, getActionClasses, getConfigurationClass, getConfigurationPropertyTypes, getContext, getDataDirectory, getDataFile, getDescription, getDescriptor, getDeviceAdvertisementSnapshot, getDeviceConfigurationProperty, getDeviceLastCheckin, getDeviceProxies, getDeviceProxy, getDeviceVariableState, getDeviceVariableState, getDiscoManager, getEventLoopExecutor, getHubManager, getLocalHub, getName, getPublishedDeviceDescriptions, getRefreshInterval, getStatus, getTaskManager, getTaskProvider, getType, hasDeviceProxy, hasDeviceVariable, hasDeviceVariableState, hasDeviceVariableState, hasTaskProvider, onDeviceConfigurationUpdateEvent, onDeviceDeletedEvent, onDeviceVariablesUpdate, onHandleTaskEvents, onPluginConfigurationUpdate, onPluginConfigurationUpdateEvent, onRefresh, onSetDeviceVariables, postEvent, publishActionProvider, publishDeviceAdvertisement, publishDeviceProxy, publishDeviceProxy, publishTaskConditionClass, scheduleAtFixedRateInEventLoop, setAccessManager, setActionManager, setDeviceConfigurationProperties, setDeviceConfigurationProperty, setDeviceManager, setDiscoManager, setEventManager, setGlobalVariable, setGlobalVariables, setHubManager, setPluginConfigurationProperty, setPluginManager, setStatus, setTaskManager, setTaskProvider

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whizzosoftware.hobson.api.plugin.HobsonPlugin

onShutdown, onStartup

Constructor Detail

AbstractHttpClientPlugin

public AbstractHttpClientPlugin(java.lang.String pluginId,
                                java.lang.String version,
                                java.lang.String description)

AbstractHttpClientPlugin

public AbstractHttpClientPlugin(java.lang.String pluginId,
                                java.lang.String version,
                                java.lang.String description,
                                HttpClientChannel httpChannel)

Method Detail

sendHttpRequest

public void sendHttpRequest(java.net.URI uri,
                            HttpRequest.Method method,
                            java.lang.Object context)

Sends an HTTP request. The response will be returned via the onHttpResponse() or onHttpRequestFailure() callbacks.

Parameters:

uri - the URI to send the request to

method - the request method

context - a context object that will be returned in the response callback (or null if one is not needed)

sendHttpRequest

public void sendHttpRequest(java.net.URI uri,
                            HttpRequest.Method method,
                            java.util.Map<java.lang.String,java.lang.String> headers,
                            java.lang.Object context)

Sends an HTTP request. The response will be returned via the onHttpResponse() or onHttpRequestFailure() callbacks.

Parameters:

uri - the URI to send the request to

method - the request method

headers - request headers (or null if none)

context - a context object that will be returned in the response callback (or null if one is not needed)

sendHttpRequest

public void sendHttpRequest(java.net.URI uri,
                            HttpRequest.Method method,
                            java.util.Map<java.lang.String,java.lang.String> headers,
                            java.util.Collection<Cookie> cookies,
                            java.lang.Object context)

Sends an HTTP request. The response will be returned via the onHttpResponse() or onHttpRequestFailure() callbacks.

Parameters:

uri - the URI to send the request to

method - the request method

headers - request headers (or null if none)

cookies - cookies to include in the request (or null if none)

context - a context object that will be returned in the response callback (or null if one is not needed)

sendHttpRequest

public void sendHttpRequest(java.net.URI uri,
                            HttpRequest.Method method,
                            java.util.Map<java.lang.String,java.lang.String> headers,
                            java.util.Collection<Cookie> cookies,
                            byte[] body,
                            java.lang.Object context)

Sends an HTTP request. The response will be returned via the onHttpResponse() or onHttpRequestFailure() callbacks.

Parameters:

uri - the URI to send the request to

method - the request method

headers - request headers (or null if none)

cookies - cookies to include in the request (or null if none)

body - the response body

context - a context object that will be returned in the response callback (or null if one is not needed)

createWebSocket

public WebSocketHandle createWebSocket(java.net.URI uri)

Creates a WebSocket client.

Parameters:

uri - the URI to connect to

Returns:

a WebSocketHandle

createWebSocket

public WebSocketHandle createWebSocket(java.net.URI uri,
                                       java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> headers)

Creates a WebSocket client.

Parameters:

uri - the URI to connect to

headers - HTTP request headers to include in the connection request

Returns:

a WebSocketHandle

onHttpResponse

public abstract void onHttpResponse(HttpResponse response,
                                    java.lang.Object context)

Callback for successful HTTP responses. Note that "successful" here refers to transport level success. For example, a 500 status code response is still considered successful.

Parameters:

response - the response object

context - the context object passed in the request

onHttpRequestFailure

public abstract void onHttpRequestFailure(java.lang.Throwable cause,
                                          java.lang.Object context)

Callback for unsuccessful HTTP responses. Note that "unsuccessful" means that there was a transport level problem.

Parameters:

cause - the cause of the failure

context - the context object passed in the request