org.myrobotlab.service

Class HttpClient

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.HttpClient

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, HttpDataListener, HttpResponseListener, QueueReporter

Direct Known Subclasses:

OpenWeatherMap, YahooFinanceStockQuote

public class HttpClient
extends Service
implements HttpDataListener, HttpResponseListener

HttpClient - wrapper for Apache HttpClient

Author:

GroG TODO - asynchronous call back similar to AngularJS promise - or at least a callback method is called .. onHttpResponse Synchronous or Asynchronous - Synchronous by default, Asynchronous if a callback method is supplied or Non-Blocking method is called Check out - Fluent interface - https://hc.apache.org/httpcomponents-client-ga/tutorial/html/fluent.html

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
HttpClient(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	addFormField(java.lang.String name, java.lang.String value)
void	addHttpDataListener(ServiceInterface listener)
void	addHttpResponseListener(ServiceInterface listener)
void	clearForm()
java.lang.String	get(java.lang.String uri)
byte[]	getBytes(java.lang.String uri)
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
static void	main(java.lang.String[] args)
void	onHttpData(HttpData data) publishHttpData contains more information content type, response code, etc...
void	onHttpResponse(java.lang.String data) for testing purposes
java.lang.String	post(java.lang.String uri)
java.lang.String	post(java.lang.String uri, java.util.HashMap<java.lang.String,java.lang.String> fields)
byte[]	postBytes(java.lang.String uri, java.util.HashMap<java.lang.String,java.lang.String> fields)
HttpData	processResponse(org.apache.http.client.methods.HttpUriRequest request, java.util.HashMap<java.lang.String,java.lang.String> fields)
HttpData	publishHttpData(HttpData data) publishing point for any http request this is the asynchronous callback which will arrive typically at publishHttpData(data) contains more data than just the text, can be used for any content type too, since the payload is in a byte[]
java.lang.String	publishHttpResponse(java.lang.String data) publishing point for any http request this is the asynchronous callback which will arrive typically at onHttpRespone(data)
void	startService()

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.slf4j.Logger log

Constructor Detail

HttpClient

public HttpClient(java.lang.String n)

Method Detail

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

addFormField

public void addFormField(java.lang.String name,
                         java.lang.String value)

addHttpDataListener

public void addHttpDataListener(ServiceInterface listener)

addHttpResponseListener

public void addHttpResponseListener(ServiceInterface listener)

clearForm

public void clearForm()

get

public java.lang.String get(java.lang.String uri)
                     throws org.apache.http.client.ClientProtocolException,
                            java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

getBytes

public byte[] getBytes(java.lang.String uri)
                throws org.apache.http.client.ClientProtocolException,
                       java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

onHttpData

public void onHttpData(HttpData data)

publishHttpData contains more information content type, response code, etc... need to subscribe to it manually for testing purposes

Specified by:

onHttpData in interface HttpDataListener

onHttpResponse

public void onHttpResponse(java.lang.String data)

for testing purposes

Specified by:

onHttpResponse in interface HttpResponseListener

post

public java.lang.String post(java.lang.String uri)
                      throws org.apache.http.client.ClientProtocolException,
                             java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

post

public java.lang.String post(java.lang.String uri,
                             java.util.HashMap<java.lang.String,java.lang.String> fields)
                      throws org.apache.http.client.ClientProtocolException,
                             java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

postBytes

public byte[] postBytes(java.lang.String uri,
                        java.util.HashMap<java.lang.String,java.lang.String> fields)
                 throws org.apache.http.client.ClientProtocolException,
                        java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

processResponse

public HttpData processResponse(org.apache.http.client.methods.HttpUriRequest request,
                                java.util.HashMap<java.lang.String,java.lang.String> fields)
                         throws java.io.IOException

Throws:

java.io.IOException

publishHttpData

public HttpData publishHttpData(HttpData data)

publishing point for any http request this is the asynchronous callback which will arrive typically at publishHttpData(data) contains more data than just the text, can be used for any content type too, since the payload is in a byte[]

Parameters:

data - the http data

Returns:

the http data

publishHttpResponse

public java.lang.String publishHttpResponse(java.lang.String data)

publishing point for any http request this is the asynchronous callback which will arrive typically at onHttpRespone(data)

Parameters:

data - the data

Returns:

the data

startService

public void startService()

Specified by:

startService in interface ServiceInterface

Overrides:

startService in class Service

main

public static void main(java.lang.String[] args)