de.citunius.businesslogicapi.common

Class Utilities

java.lang.Object

de.citunius.businesslogicapi.common.Utilities

public class Utilities
extends java.lang.Object

Utilities is the class for system, filesystem, and network related tasks.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Utilities()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	abbreviate(java.lang.String str, int length) Short a string by a given string length
static java.lang.String	getAttributeFromPropertiesFile(java.util.HashMap<java.lang.String,java.lang.String> pluginMap, java.lang.String parameter) Get attribute value from config.properties file
static java.lang.String	getFormattedTimestamp(java.util.Date date, java.lang.String dateFormat) Get formatted string by a given date and date format
static <T,E> T	getKeyByValue(java.util.Map<T,E> map, E value) Get key by value in a hash map
static java.lang.String	getMobileAppSettingParameterNameUserId(java.lang.String tenantId, java.lang.String accountId, java.util.HashMap<java.lang.String,java.lang.String> pluginMap) Get parameter name of the user identifier from MobileAppSetting
static java.lang.String	getMobileAppSettingParameterNameUserId(java.lang.String tenantId, java.lang.String accountId, java.lang.String providerName) Get parameter name of the messenger provider from MobileAppSetting
static java.lang.String	getMobileAppSettingValue(java.lang.String parameter, java.util.List<MobileAppSetting> mobileAppSettings) Get the parameter value of the MobileAppSetting
static java.lang.String	getMobileAppSettingValue(java.lang.String parameter, MobileUserAccount mobileUserAccount) Get MobileAppSetting by MobileUserAccount
java.lang.String	getNewLongDateByFormat(java.lang.String longDateFormat) Create new long date format by a given format syntax
static java.lang.String	getParameter(java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String name) Get parameter from parameter map
static java.util.List<java.lang.String>	getParameterNames(java.util.Map<java.lang.String,java.lang.String[]> parameterMap) Get parameter names from parameter map
static java.lang.String[]	getParameterValues(java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String name) Get parameter values from parameter map
static Userstate	getUserState(java.lang.String tenantId, java.lang.String accountId, java.lang.String pluginName, java.util.HashMap<java.lang.String,java.lang.String> pluginMap, java.lang.String userId) Get user state from Business Bot Platform via web service request
static boolean	parameterExists(java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String name) Check if parameter exists in parameter map
static void	printParameterMap(java.util.Map<java.lang.String,java.lang.String[]> parameterMap) Prints the parameter map provided by the Business Bot Platform
static boolean	updateUserState(java.lang.String tenantId, java.lang.String accountId, java.lang.String pluginName, java.util.HashMap<java.lang.String,java.lang.String> pluginMap, java.lang.String userId, int userstate, java.lang.String defaultLanguage) Update user state on Business Bot Platform via web service request

Methods inherited from class java.lang.Object

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

Constructor Detail

Utilities

public Utilities()

Method Detail

getNewLongDateByFormat

public java.lang.String getNewLongDateByFormat(java.lang.String longDateFormat)

Create new long date format by a given format syntax

Parameters:

longDateFormat - the long date format syntax (e.g. yyyy-MM-dd HH:mm:ss.SSSSS for e.g. 2015-07-28 15:42:21.12711)

Returns:

the current date as long date for e.g. 2015-07-28 15:42:21.12711

getMobileAppSettingValue

public static java.lang.String getMobileAppSettingValue(java.lang.String parameter,
                                                        MobileUserAccount mobileUserAccount)

Get MobileAppSetting by MobileUserAccount

Parameters:

parameter - the parameter name

mobileUserAccount - the MobileUserAccount object (retrieved from BBP request)

Returns:

the MobileAppSetting value on success; otherwise null

getMobileAppSettingValue

public static java.lang.String getMobileAppSettingValue(java.lang.String parameter,
                                                        java.util.List<MobileAppSetting> mobileAppSettings)

Get the parameter value of the MobileAppSetting

Parameters:

parameter - the parameter name

mobileAppSettings - the parameter value

Returns:

the parameter value of the MobileAppSetting if parameter exists; otherwise null

getMobileAppSettingParameterNameUserId

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

Get parameter name of the user identifier from MobileAppSetting

Parameters:

tenantId - the tenant identifier

accountId - the account identifier

pluginMap - the map of plugin parameters

Returns:

the parameter name of the userId (e.g. 'XMPP.UserInfo.Username') if exists; otherwise null

getMobileAppSettingParameterNameUserId

public static java.lang.String getMobileAppSettingParameterNameUserId(java.lang.String tenantId,
                                                                      java.lang.String accountId,
                                                                      java.lang.String providerName)

Get parameter name of the messenger provider from MobileAppSetting

Parameters:

tenantId - the tenant identifier

accountId - the account identifier

providerName - the provider name (e.g. XMPP or Slack)

Returns:

the parameter name of the provider (e.g. 'XMPP.UserInfo.Username') if exists; otherwise null

updateUserState

public static boolean updateUserState(java.lang.String tenantId,
                                      java.lang.String accountId,
                                      java.lang.String pluginName,
                                      java.util.HashMap<java.lang.String,java.lang.String> pluginMap,
                                      java.lang.String userId,
                                      int userstate,
                                      java.lang.String defaultLanguage)

Update user state on Business Bot Platform via web service request

Parameters:

tenantId - the tenant identifier

accountId - the account identifier

pluginName - the plugin name

pluginMap - the plugin map

userId - the user identifier

userstate - the userstate to be update

defaultLanguage - the default language

Returns:

true on success; otherwise false

getUserState

public static Userstate getUserState(java.lang.String tenantId,
                                     java.lang.String accountId,
                                     java.lang.String pluginName,
                                     java.util.HashMap<java.lang.String,java.lang.String> pluginMap,
                                     java.lang.String userId)

Get user state from Business Bot Platform via web service request

Parameters:

tenantId - the tenant identifier

accountId - the account identifier

pluginName - the plugin name

pluginMap - the plugin map

userId - the user identifier

Returns:

Userstate on success; otherwise null

getAttributeFromPropertiesFile

public static java.lang.String getAttributeFromPropertiesFile(java.util.HashMap<java.lang.String,java.lang.String> pluginMap,
                                                              java.lang.String parameter)

Get attribute value from config.properties file

Parameters:

pluginMap - the plugin map

parameter - the parameter key

Returns:

the parameter value if exists; otherwise null

abbreviate

public static java.lang.String abbreviate(java.lang.String str,
                                          int length)

Short a string by a given string length

Parameters:

str - the input string

length - the max string length

Returns:

the shorted string

getKeyByValue

public static <T,E> T getKeyByValue(java.util.Map<T,E> map,
                                    E value)

Get key by value in a hash map

In case of one-to-one relationship, you can return the first matched key

Type Parameters:

T - This is the type parameter

E - This is the enum parameter

Parameters:

value - the search value

map - the map

Returns:

key of the hash map

parameterExists

public static boolean parameterExists(java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                      java.lang.String name)

Check if parameter exists in parameter map

Parameters:

parameterMap - the parameter map

name - the parameter name

Returns:

true on success; otherwise false

getFormattedTimestamp

public static java.lang.String getFormattedTimestamp(java.util.Date date,
                                                     java.lang.String dateFormat)

Get formatted string by a given date and date format

Parameters:

date - the date object

dateFormat - the date format

Returns:

the formatted string from date

getParameter

public static java.lang.String getParameter(java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                            java.lang.String name)

Get parameter from parameter map

Parameters:

parameterMap - the parameter map

name - the parameter name

Returns:

the parameter value

getParameterValues

public static java.lang.String[] getParameterValues(java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                    java.lang.String name)

Get parameter values from parameter map

Parameters:

parameterMap - the parameter map

name - the parameter name

Returns:

the parameter values

getParameterNames

public static java.util.List<java.lang.String> getParameterNames(java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

Get parameter names from parameter map

Parameters:

parameterMap - the parameter map

Returns:

the parameter names

printParameterMap

public static void printParameterMap(java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

Prints the parameter map provided by the Business Bot Platform

Parameters:

parameterMap - the parameter map