de.citunius.businesslogicapi.common.services

Class WebService

java.lang.Object

de.citunius.businesslogicapi.common.services.WebService

public class WebService
extends java.lang.Object

WebService is the class to consume services from Business Bot Platform (BBP).

This class provides the web services from the Business Bot Platform such as BBP File store management (e.g. File registration), Chatbot callback services, Userstate management

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,java.lang.String>	pluginMap

Constructor Summary

Constructors

Constructor and Description
WebService(java.util.HashMap<java.lang.String,java.lang.String> pluginMap) Constructor

Method Summary

Modifier and Type	Method and Description
java.util.List<ChatbotTaskSchedule>	getChatbotCallbacks() Get chatbot callbacks from BBP and return the results
java.util.List<Userstate>	getUserstate(Userstate userstate) Get user state from BBP and return the results
java.lang.String	registerChatbotCallback(ChatbotCallback chatbotCallback) Register chatbot callback to BBP and return the receipt id
java.lang.String	registerFileToBBPFileStore(java.lang.String localImageFile) Upload a file to BBP filestore and return the File UUID
static java.lang.String	sendHttpGetRequest(java.lang.String targetURL, java.lang.String urlParameters, java.lang.String contentType, java.lang.String language) Perform HTTP GET request
static java.lang.String	sendHttpGetRequestWithBasicAuthentication(java.lang.String targetURL, java.lang.String username, java.lang.String password) Perform HTTP GET request with Basic authentication
static java.lang.String	sendHttpPostRequest(java.lang.String targetURL, java.lang.String body) Perform HTTP POST request
boolean	setUserstate(Userstate userstate) Set userstate on BBP and return the receipt
boolean	unregisterChatbotCallback(int callbackId) Unregister chatbot callback from BBP and return the receipt id

Methods inherited from class java.lang.Object

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

Field Detail

pluginMap

public java.util.HashMap<java.lang.String,java.lang.String> pluginMap

Constructor Detail

WebService

public WebService(java.util.HashMap<java.lang.String,java.lang.String> pluginMap)

Constructor

Parameters:

pluginMap - the plugin HashMap

Method Detail

setUserstate

public boolean setUserstate(Userstate userstate)

Set userstate on BBP and return the receipt

Parameters:

userstate - the Userstate object

Returns:

true on success; otherwise false

registerChatbotCallback

public java.lang.String registerChatbotCallback(ChatbotCallback chatbotCallback)
                                         throws java.lang.Exception

Register chatbot callback to BBP and return the receipt id

Parameters:

chatbotCallback - the ChatbotCallback object

Returns:

the receiptId on success; otherwise null

Throws:

java.lang.Exception - if something is wrong (e.g. JSON exception)

unregisterChatbotCallback

public boolean unregisterChatbotCallback(int callbackId)
                                  throws java.lang.Exception

Unregister chatbot callback from BBP and return the receipt id

Parameters:

callbackId - the callback identifier

Returns:

true on success; otherwise false

Throws:

java.lang.Exception - if something is wrong (e.g. JSON exception)

getUserstate

public java.util.List<Userstate> getUserstate(Userstate userstate)

Get user state from BBP and return the results

Parameters:

userstate - the Userstate object

Returns:

the List of Userstate object if exists; otherwise null

getChatbotCallbacks

public java.util.List<ChatbotTaskSchedule> getChatbotCallbacks()
                                                        throws java.lang.Exception

Get chatbot callbacks from BBP and return the results

Returns:

the List of ChatbotTaskSchedule object if exists; otherwise null

Throws:

java.lang.Exception - if something is wrong (e.g. JSON exception)

registerFileToBBPFileStore

public java.lang.String registerFileToBBPFileStore(java.lang.String localImageFile)
                                            throws java.lang.Exception

Upload a file to BBP filestore and return the File UUID

Parameters:

localImageFile - the local image file

Returns:

the fileUUID if file was registered successfully; otherwise null

Throws:

java.lang.Exception - if something is wrong (e.g. JSON exception)

sendHttpGetRequest

public static java.lang.String sendHttpGetRequest(java.lang.String targetURL,
                                                  java.lang.String urlParameters,
                                                  java.lang.String contentType,
                                                  java.lang.String language)

Perform HTTP GET request

Parameters:

targetURL - the destinal URL

urlParameters - the URL parameters

contentType - the content type of the HTTP request (e.g. "application/x-www-form-urlencoded")

language - the content language of the HTTP request (e.g. "en-US")

Returns:

the output from the HTTP response on success; otherwise null

sendHttpGetRequestWithBasicAuthentication

public static java.lang.String sendHttpGetRequestWithBasicAuthentication(java.lang.String targetURL,
                                                                         java.lang.String username,
                                                                         java.lang.String password)

Perform HTTP GET request with Basic authentication

Parameters:

targetURL - the URL

username - the basic authentication username

password - the basic authentication password

Returns:

the output from the HTTP response

sendHttpPostRequest

public static java.lang.String sendHttpPostRequest(java.lang.String targetURL,
                                                   java.lang.String body)

Perform HTTP POST request

Parameters:

targetURL - the URL

body - the URL parameters

Returns:

the output from the HTTP response