de.citunius.businesslogicapi.common.services

Class CallbackService

java.lang.Object

de.citunius.businesslogicapi.common.services.CallbackService

public class CallbackService
extends java.lang.Object

CallbackService is the class responsible to manage callbacks in the business logic which are scheduled on the Business Bot Platform. Callback are useful to perform a task in the business logic at a specified time. For example you can register, unregister, delete a callback but also to get all scheduled callbacks from the platform. The syntax of a cron schedule is similar to UNIX crontab, e.g. "0 0/1 * * * ? *"; to fire every minute. A business logic can schedule multiple cron jobs for different tasks and different users.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	accountId
static java.lang.String	CRONSCHEDULE_EVERY_DAY
static java.lang.String	CRONSCHEDULE_EVERY_MINUTE
static java.lang.String	CRONSCHEDULE_EVERY_MONTH
static java.lang.String	CRONSCHEDULE_EVERY_WEEK
static java.lang.String	CRONSCHEDULE_EVERY_WORKDAY
java.util.HashMap<java.lang.String,java.lang.String>	pluginMap
java.lang.String	tenantId

Constructor Summary

Constructors

Constructor and Description
CallbackService(java.lang.String tenantId, java.lang.String accountId, java.util.HashMap<java.lang.String,java.lang.String> pluginMap) The constructor

Method Summary

Modifier and Type	Method and Description
boolean	chatbotTaskScheduleExists(int id) Get all scheduled callbacks from webservice for this plugin
java.util.List<ChatbotTaskSchedule>	getCallbacks() Get all scheduled callbacks from webservice for this plugin
java.lang.String	getUserIdFromChatbotTaskScheduleMobileUserAccount(ChatbotTaskSchedule chatbotTaskSchedule) Get userId from ChatbotTaskSchedule's MobileUserAccount object
boolean	scheduleCallback(java.lang.String cronSchedule, boolean hasAnonymousUserAccount, AnonymousUserAccount anonymousUserAccount, boolean hasMobileUserAccount, MobileUserAccount mobileUserAccount) Call webservice to schedule a callback
boolean	unregisterAllCallbacks(MobileUserAccount mobileUserAccount) Call webservice to unregister all callbacks for this user
boolean	unregisterCallback(int id) Call webservice to unregister a callback for this user by ChatbotCallback ID
boolean	unregisterCallbackByUser(java.lang.String userId) Call webservice to unregister a callback for this user

Methods inherited from class java.lang.Object

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

Field Detail

CRONSCHEDULE_EVERY_MINUTE

public static final java.lang.String CRONSCHEDULE_EVERY_MINUTE

See Also:

Constant Field Values

CRONSCHEDULE_EVERY_WORKDAY

public static final java.lang.String CRONSCHEDULE_EVERY_WORKDAY

See Also:

Constant Field Values

CRONSCHEDULE_EVERY_DAY

public static final java.lang.String CRONSCHEDULE_EVERY_DAY

See Also:

Constant Field Values

CRONSCHEDULE_EVERY_WEEK

public static final java.lang.String CRONSCHEDULE_EVERY_WEEK

See Also:

Constant Field Values

CRONSCHEDULE_EVERY_MONTH

public static final java.lang.String CRONSCHEDULE_EVERY_MONTH

See Also:

Constant Field Values

tenantId

public java.lang.String tenantId

accountId

public java.lang.String accountId

pluginMap

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

Constructor Detail

CallbackService

public CallbackService(java.lang.String tenantId,
                       java.lang.String accountId,
                       java.util.HashMap<java.lang.String,java.lang.String> pluginMap)

The constructor

Parameters:

tenantId - the tenant identifier

accountId - the account identifier

pluginMap - the plugin map

Method Detail

scheduleCallback

public boolean scheduleCallback(java.lang.String cronSchedule,
                                boolean hasAnonymousUserAccount,
                                AnonymousUserAccount anonymousUserAccount,
                                boolean hasMobileUserAccount,
                                MobileUserAccount mobileUserAccount)

Call webservice to schedule a callback

Parameters:

cronSchedule - the cron schedule (e.g. "0 0/1 * * * ? *"; to fire every minute)

hasAnonymousUserAccount - if BBP request contains a AnonymousUserAccount

anonymousUserAccount - the AnonymousUserAccount provided in BBP request or null

hasMobileUserAccount - if BBP request contains a MobileUserAccount

mobileUserAccount - the MobileUserAccount provided in BBP request or null

Returns:

true if schedule callback has been placed (success); otherwise false

unregisterCallbackByUser

public boolean unregisterCallbackByUser(java.lang.String userId)

Call webservice to unregister a callback for this user

Parameters:

userId - the mobile username

Returns:

true on success; otherwise false

getUserIdFromChatbotTaskScheduleMobileUserAccount

public java.lang.String getUserIdFromChatbotTaskScheduleMobileUserAccount(ChatbotTaskSchedule chatbotTaskSchedule)

Get userId from ChatbotTaskSchedule's MobileUserAccount object

Parameters:

chatbotTaskSchedule - the ChatbotTaskSchedule object containing the MobileUserAccount object with the userId (as MobileAppSetting)

Returns:

the userId (e.g. max)

unregisterCallback

public boolean unregisterCallback(int id)

Call webservice to unregister a callback for this user by ChatbotCallback ID

Parameters:

id - the ChatbotTaskSchedule identifier

Returns:

true on success; otherwise false

unregisterAllCallbacks

public boolean unregisterAllCallbacks(MobileUserAccount mobileUserAccount)

Call webservice to unregister all callbacks for this user

Parameters:

mobileUserAccount - the mobile user account object

Returns:

true on success; otherwise false

getCallbacks

public java.util.List<ChatbotTaskSchedule> getCallbacks()

Get all scheduled callbacks from webservice for this plugin

Returns:

List of ChatbotTaskSchedule objects if exists; otherwise null

chatbotTaskScheduleExists

public boolean chatbotTaskScheduleExists(int id)

Get all scheduled callbacks from webservice for this plugin

Parameters:

id - the ChatbotTaskSchedule identifier

Returns:

true if cronSchedule for given user exists; otherwise false