org.jboss.aerogear.adm

Class PayloadBuilder

java.lang.Object

org.jboss.aerogear.adm.PayloadBuilder

public class PayloadBuilder
extends Object

A builder class to construct a Payload message to be send to ADM Network

Method Summary

Methods

Modifier and Type	Method and Description
String	build() Builds your complete payload
PayloadBuilder	consolidationKey(Object value) This is an arbitrary string used to indicate that multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this new one
PayloadBuilder	dataField(String key, Object value) Adds an custom payload value for the given key.
PayloadBuilder	dataFields(Map<String,?> dataFields)
PayloadBuilder	expiresAfter(Object value) The number of seconds that ADM should retain the message if the device is offline.
PayloadBuilder	md5(Object value) This is a base-64-encoded MD5 checksum of the data parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

dataField

public PayloadBuilder dataField(String key,
                       Object value)

Adds an custom payload value for the given key.

Parameters:

key - of an user custom field

value - of an user custom field

Returns:

the current PayloadBuilder instance

dataFields

public PayloadBuilder dataFields(Map<String,?> dataFields)

Parameters:

dataFields, - a map containing custom key/value entries

Returns:

the current PayloadBuilder instance

consolidationKey

public PayloadBuilder consolidationKey(Object value)

This is an arbitrary string used to indicate that multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this new one

Parameters:

value - of the consolidation key

Returns:

the current PayloadBuilder instance

expiresAfter

public PayloadBuilder expiresAfter(Object value)

The number of seconds that ADM should retain the message if the device is offline. After this time, the message may be discarded

Parameters:

value - of the timeout (in seconds)

Returns:

the current PayloadBuilder instance

md5

public PayloadBuilder md5(Object value)

This is a base-64-encoded MD5 checksum of the data parameter. If you provide a value for the md5 parameter, ADM verifies its accuracy. If you do not provide a value, the server calculates the value on your behalf

Parameters:

value - of the MD5

Returns:

the current PayloadBuilder instance

build

public String build()

Builds your complete payload

Returns:

a String representing your complete payload

toString

public String toString()

Overrides:

toString in class Object