com.brein.api

Class BreinActivity

java.lang.Object

com.brein.api.BreinBase<BreinActivity>

com.brein.api.BreinActivity

All Implemented Interfaces:

IAsyncExecutable<BreinResult>, ISecretStrategy

public class BreinActivity
extends BreinBase<BreinActivity>
implements IAsyncExecutable<BreinResult>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BreinActivity.ActivityField This list may not be complete it just contains some values.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVITY_FIELD
static java.lang.String	TAGS_FIELD

Fields inherited from class com.brein.api.BreinBase

API_KEY_FIELD, GSON, IP_ADDRESS, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinActivity()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Generates the signature for the request
void	execute(java.util.function.Consumer<BreinResult> callback) Method to execute the request asynchronous with a callback.
<T> T	get(java.lang.String key)
protected <T> T	getActivityField(BreinActivity.ActivityField field)
java.lang.String	getActivityType() returns activity type
java.lang.String	getCategory(BreinConfig config) retrieves brein category.
java.lang.String	getDescription() retrieves the description
java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.
BreinActivity	set(java.lang.String key, java.lang.Object value) Sets a base value.
BreinActivity	setActivityType(java.lang.String type) Sets activity type
BreinActivity	setBase(java.lang.String key, java.lang.Object value)
BreinActivity	setCategory(java.lang.String category) sets brein category
BreinActivity	setDescription(java.lang.String description) sets the description
BreinActivity	setTag(java.lang.String key, java.lang.Object value)

Methods inherited from class com.brein.api.BreinBase

getClientIpAddress, getGson, getHeaders, getThis, getUnixTimestamp, getUser, prepareRequestData, setAdditional, setClientIpAddress, setHeader, setHeaders, setUnixTimestamp, setUser, setUser, setUser, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.brein.api.IAsyncExecutable

execute

Field Detail

ACTIVITY_FIELD

public static final java.lang.String ACTIVITY_FIELD

See Also:

Constant Field Values

TAGS_FIELD

public static final java.lang.String TAGS_FIELD

See Also:

Constant Field Values

Constructor Detail

BreinActivity

public BreinActivity()

Method Detail

getActivityType

public java.lang.String getActivityType()

returns activity type

Returns:

activity type

setActivityType

public BreinActivity setActivityType(java.lang.String type)

Sets activity type

Parameters:

type - to set

Returns:

self

getCategory

public java.lang.String getCategory(BreinConfig config)

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

Returns:

category object

setCategory

public BreinActivity setCategory(java.lang.String category)

sets brein category

Parameters:

category - object

Returns:

self

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

Returns:

self

getEndPoint

public java.lang.String getEndPoint(BreinConfig config)

Description copied from class: BreinBase

Gets the endpoint to be used to send the request to

Specified by:

getEndPoint in class BreinBase<BreinActivity>

Parameters:

config - the current configuration

Returns:

the endpoint to be used to send the request to

See Also:

BreinConfig

setBase

public BreinActivity setBase(java.lang.String key,
                             java.lang.Object value)

set

public BreinActivity set(java.lang.String key,
                         java.lang.Object value)

Description copied from class: BreinBase

Sets a base value. The method cannot be used to set the user base-value, instead setUser has to be used.

     {
          'key': 'value'
     }
 

Overrides:

set in class BreinBase<BreinActivity>

Returns:

this

prepareRequestData

public void prepareRequestData(BreinConfig config,
                               java.util.Map<java.lang.String,java.lang.Object> requestData)

Description copied from class: BreinBase

This method adds the request specific information to the requestData. It is called by BreinBase.prepareRequestData(BreinConfig) after the request data of the base information is added.

Specified by:

prepareRequestData in class BreinBase<BreinActivity>

requestData - the request data to be sent to the endpoint

createSignature

public java.lang.String createSignature(BreinConfig config,
                                        java.util.Map<java.lang.String,java.lang.Object> requestData)

Generates the signature for the request

Specified by:

createSignature in interface ISecretStrategy

Parameters:

config - the configuration

requestData - the data used for the request including all the data that will be sent, without the signature

Returns:

full signature

setTag

public BreinActivity setTag(java.lang.String key,
                            java.lang.Object value)

execute

public void execute(java.util.function.Consumer<BreinResult> callback)

Description copied from interface: IAsyncExecutable

Method to execute the request asynchronous with a callback.

Specified by:

execute in interface IAsyncExecutable<BreinResult>

Parameters:

callback - the callback containing the response of the request, can be null

get

public <T> T get(java.lang.String key)

getActivityField

protected <T> T getActivityField(BreinActivity.ActivityField field)