com.brein.api

Class BreinActivity

java.lang.Object

com.brein.api.BreinBase

com.brein.api.BreinActivity

All Implemented Interfaces:

ISecretStrategy

public class BreinActivity
extends BreinBase
implements ISecretStrategy

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

Constructor Summary

Constructors

Constructor and Description
BreinActivity()

Method Summary

Modifier and Type	Method and Description
void	activity(BreinUser breinUser, java.lang.String breinActivityType, java.lang.String breinCategoryType, java.lang.String description, boolean sign) Sends an activity to the Breinify server.
java.lang.String	createSignature() Generates the signature for the request
java.lang.String	getBreinActivityType() returns activity type
java.lang.String	getBreinCategoryType() retrieves brein category.
java.lang.String	getDescription() retrieves the description
java.lang.String	getEndPoint() retrieves the configured activity endpoint (e.g.
java.util.Map<java.lang.String,java.lang.Object>	getTagsMap() retrieves the tagMap
void	init() initializes the values of this instance
java.lang.String	prepareJsonRequest() creates the json request based on the necessary data
void	resetAllValues() resets all values of this class and base class to initial values.
BreinActivity	setBreinActivityType(java.lang.String breinActivityType) Sets activity type
BreinActivity	setBreinCategoryType(java.lang.String breinCategoryType) sets brein category
BreinActivity	setDescription(java.lang.String description) sets the description
BreinActivity	setTagsMap(java.util.Map<java.lang.String,java.lang.Object> tagsMap) sets the tagsMap

Methods inherited from class com.brein.api.BreinBase

getBreinEngine, getBreinUser, getConfig, getUnixTimestamp, isSign, setBreinUser, setConfig, setSign, setUnixTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinActivity

public BreinActivity()

Method Detail

getBreinActivityType

public java.lang.String getBreinActivityType()

returns activity type

Returns:

activity type

setBreinActivityType

public BreinActivity setBreinActivityType(java.lang.String breinActivityType)

Sets activity type

Parameters:

breinActivityType - to set

getBreinCategoryType

public java.lang.String getBreinCategoryType()

retrieves brein category. if it is empty or null then the default category (if set) will be used.

Returns:

category object

setBreinCategoryType

public BreinActivity setBreinCategoryType(java.lang.String breinCategoryType)

sets brein category

Parameters:

breinCategoryType - object

getDescription

public java.lang.String getDescription()

retrieves the description

Returns:

description

setDescription

public BreinActivity setDescription(java.lang.String description)

sets the description

Parameters:

description - string to set as description

getEndPoint

public java.lang.String getEndPoint()

retrieves the configured activity endpoint (e.g. \activity)

Overrides:

getEndPoint in class BreinBase

Returns:

endpoint

getTagsMap

public java.util.Map<java.lang.String,java.lang.Object> getTagsMap()

retrieves the tagMap

Returns:

value

setTagsMap

public BreinActivity setTagsMap(java.util.Map<java.lang.String,java.lang.Object> tagsMap)

sets the tagsMap

Parameters:

tagsMap - created map (e.g. HashMap)

Returns:

self

init

public void init()

initializes the values of this instance

Overrides:

init in class BreinBase

resetAllValues

public void resetAllValues()

resets all values of this class and base class to initial values. This will lead to empty strings or null objects

activity

public void activity(BreinUser breinUser,
                     java.lang.String breinActivityType,
                     java.lang.String breinCategoryType,
                     java.lang.String description,
                     boolean sign)

Sends an activity to the Breinify server.

Parameters:

breinUser - the user-information

breinActivityType - the type of activity

breinCategoryType - the category (can be null or undefined)

description - the description for the activity

sign - true if a signature should be added (needs the secret to be configured - not recommended in open systems), otherwise false (can be null or undefined)

prepareJsonRequest

public java.lang.String prepareJsonRequest()

creates the json request based on the necessary data

Overrides:

prepareJsonRequest in class BreinBase

Returns:

json string

createSignature

public java.lang.String createSignature()

Generates the signature for the request

Specified by:

createSignature in interface ISecretStrategy

Returns:

full signature