org.botlibre.sense.service

Class RemoteService

java.lang.Object

org.botlibre.sense.BasicSense

org.botlibre.sense.service.RemoteService

All Implemented Interfaces:

Sense

public class RemoteService
extends BasicSense

Process remote service requests, such as SRAIX, Pannous, BotBots, Freebase, Wikidata, HTML, XML, Twiter, Facebook, RSS.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PANNOUS
static java.lang.String	SERVER

Fields inherited from class org.botlibre.sense.BasicSense

conversations, DAY, DEFAULT_SPEAKER, engaged, HOUR, MAX_FILE_SIZE, MINUTE, RETRY

Constructor Summary

Constructors

Constructor and Description
RemoteService()

Method Summary

Modifier and Type	Method and Description
void	disconnect()
javax.xml.parsers.DocumentBuilder	getParser()
void	output(Vertex output) Post, process the post request.
org.w3c.dom.Element	parseXML(java.lang.String xml) Parse the input XML stream into a DOM.
void	pool() Reset state when instance is pooled.
java.lang.String	request(java.lang.String message, java.lang.String bot, java.lang.String botid, java.lang.String server, Primitive service, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the remote service request, and return the result.
java.lang.String	requestFORGE(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the XML HTTP request.
java.lang.String	requestFreebase(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the Freebase sense.
java.lang.String	requestHTML(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the HTML HTTP request.
java.lang.String	requestJSON(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the XML HTTP request.
java.lang.String	requestPannous(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit) Invoke the Pannous service.
java.lang.String	requestWikidata(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the Wikidata sense.
java.lang.String	requestWiktionary(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the Wiktionary sense.
java.lang.String	requestXML(java.lang.String message, java.lang.String botid, java.lang.String server, java.lang.String apikey, int limit, java.lang.String hint, Network network) Invoke the XML HTTP request.
void	shutdown() Stop sensing.

Methods inherited from class org.botlibre.sense.BasicSense

addListener, awake, checkEngaged, checkSentence, discover, discoverSentence, getAction, getBot, getEmotionalState, getLanguageState, getListeners, getName, getPrimitive, getResponseListener, getShortTermMemory, initialize, input, input, isEnabled, log, log, log, migrateProperties, notifyExceptionListeners, notifyResponseListener, printInput, removeListener, saveProperties, setAction, setBot, setEmotionalState, setIsEnabled, setLanguageState, setName, setResponseListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

PANNOUS

public static java.lang.String PANNOUS

SERVER

public static java.lang.String SERVER

Constructor Detail

RemoteService

public RemoteService()

Method Detail

request

public java.lang.String request(java.lang.String message,
                                java.lang.String bot,
                                java.lang.String botid,
                                java.lang.String server,
                                Primitive service,
                                java.lang.String apikey,
                                int limit,
                                java.lang.String hint,
                                Network network)
                         throws java.lang.Exception

Invoke the remote service request, and return the result.

Throws:

java.lang.Exception

requestWikidata

public java.lang.String requestWikidata(java.lang.String message,
                                        java.lang.String botid,
                                        java.lang.String server,
                                        java.lang.String apikey,
                                        int limit,
                                        java.lang.String hint,
                                        Network network)
                                 throws java.lang.Exception

Invoke the Wikidata sense.

Throws:

java.lang.Exception

requestXML

public java.lang.String requestXML(java.lang.String message,
                                   java.lang.String botid,
                                   java.lang.String server,
                                   java.lang.String apikey,
                                   int limit,
                                   java.lang.String hint,
                                   Network network)
                            throws java.lang.Exception

Invoke the XML HTTP request.

Throws:

java.lang.Exception

requestJSON

public java.lang.String requestJSON(java.lang.String message,
                                    java.lang.String botid,
                                    java.lang.String server,
                                    java.lang.String apikey,
                                    int limit,
                                    java.lang.String hint,
                                    Network network)
                             throws java.lang.Exception

Invoke the XML HTTP request.

Throws:

java.lang.Exception

requestFORGE

public java.lang.String requestFORGE(java.lang.String message,
                                     java.lang.String botid,
                                     java.lang.String server,
                                     java.lang.String apikey,
                                     int limit,
                                     java.lang.String hint,
                                     Network network)
                              throws java.lang.Exception

Invoke the XML HTTP request.

Throws:

java.lang.Exception

requestHTML

public java.lang.String requestHTML(java.lang.String message,
                                    java.lang.String botid,
                                    java.lang.String server,
                                    java.lang.String apikey,
                                    int limit,
                                    java.lang.String hint,
                                    Network network)
                             throws java.lang.Exception

Invoke the HTML HTTP request.

Throws:

java.lang.Exception

requestFreebase

public java.lang.String requestFreebase(java.lang.String message,
                                        java.lang.String botid,
                                        java.lang.String server,
                                        java.lang.String apikey,
                                        int limit,
                                        java.lang.String hint,
                                        Network network)
                                 throws java.lang.Exception

Invoke the Freebase sense.

Throws:

java.lang.Exception

requestWiktionary

public java.lang.String requestWiktionary(java.lang.String message,
                                          java.lang.String botid,
                                          java.lang.String server,
                                          java.lang.String apikey,
                                          int limit,
                                          java.lang.String hint,
                                          Network network)
                                   throws java.lang.Exception

Invoke the Wiktionary sense.

Throws:

java.lang.Exception

requestPannous

public java.lang.String requestPannous(java.lang.String message,
                                       java.lang.String botid,
                                       java.lang.String server,
                                       java.lang.String apikey,
                                       int limit)
                                throws java.lang.Exception

Invoke the Pannous service.

Throws:

java.lang.Exception

shutdown

public void shutdown()

Stop sensing.

Specified by:

shutdown in interface Sense

Overrides:

shutdown in class BasicSense

pool

public void pool()

Reset state when instance is pooled.

Specified by:

pool in interface Sense

Overrides:

pool in class BasicSense

disconnect

public void disconnect()

getParser

public javax.xml.parsers.DocumentBuilder getParser()
                                            throws java.lang.Exception

Throws:

java.lang.Exception

parseXML

public org.w3c.dom.Element parseXML(java.lang.String xml)
                             throws java.lang.Exception

Parse the input XML stream into a DOM.

Throws:

java.lang.Exception

output

public void output(Vertex output)

Post, process the post request.

Specified by:

output in interface Sense

Overrides:

output in class BasicSense