com.lightstreamer.ls_client.mpn

Class MpnInfo

java.lang.Object

com.lightstreamer.ls_client.mpn.MpnInfo

All Implemented Interfaces:

java.lang.Cloneable

public class MpnInfo
extends java.lang.Object
implements java.lang.Cloneable

Contains the table and format specification of mobile push notifications (MPN) to be sent on the update of an MPN subscription. The only required parameter is tableInfo, other parameters are optional and may be left to nil. Common GCM service restrictions apply, such as maximum total length of 4 Kbytes.
Every parameter value may include references to table update fields by position, e.g.:

• "Stock value of $[1] is now $[2]"
• "Latest news: $[1] of $[2]"

If the Metadata Adapter to which the table belongs is a subclass of LiteralBasedProvider (or of an equivalent class), the value may also include field references by name, e.g.:

• "Stock value of ${stock_name} is now ${last_price}"
• "Latest news: ${title} of ${time}"

In this case common metadata rules apply: field names are checked against the Metadata Adapter and as such they must be consistent with the schema and group specified on the SimpleTableInfo corresponding to the MPN subscription.
A Server-managed special value may also be referenced:

• ${LS_MPN_subscription_ID} is the ID of the MPN subscription generating the mobile push notification.

Field and special value references will be expanded to their corresponding content before mobile push notification delivery, so that the user may receive a human-readable notification (e.g. "Stock value of Google is now 500").
Objects of this class may be created and passed to LSClient on calls like LSClient.activateMpn(MpnInfo,boolean), but may also be returned as part of an MpnSubscription by calls like LSClient.inquireMpn(MpnKey). In this case some of their properties may not be restored to the value they had when the MpnInfo objects have been originally submitted. In particular field references may have all been transformed in positional format (e.g. "$[2]" instead of "${last_price}").
For more information on the meaning and use of each parameter please consult Google Cloud Messaging for Android reference guide.

Constructor Summary

Constructors

Constructor and Description
MpnInfo(SimpleTableInfo tableInfo, java.util.Map<java.lang.String,java.lang.String> data) Creates an MpnInfo object with the specified parameters.
MpnInfo(SimpleTableInfo tableInfo, java.lang.String collapseKey) Creates an MpnInfo object with the specified parameters.
MpnInfo(SimpleTableInfo tableInfo, java.lang.String collapseKey, java.util.Map<java.lang.String,java.lang.String> data) Creates an MpnInfo object with the specified parameters.
MpnInfo(SimpleTableInfo tableInfo, java.lang.String collapseKey, java.util.Map<java.lang.String,java.lang.String> data, java.lang.String delayWhileIdle, java.lang.String timeToLive) Creates an MpnInfo object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String	getCollapseKey() The collapse key to be used with the mobile push notification.
java.util.Map<java.lang.String,java.lang.String>	getData() The data to be used with the mobile push notification.
java.lang.String	getDelayWhileIdle() The delay while idle flag to be used with the mobile push notification.
SimpleTableInfo	getTableInfo() The specification of the table to be subscribed.
java.lang.String	getTimeToLive() The time to live to be used with the mobile push notification.
java.lang.String	getTriggerExpression() Specifies a boolean expression that, when set, will be evaluated against each table update and will act as a trigger to deliver the mobile push notification.
void	setCollapseKey(java.lang.String collapseKey) Specifies the collapse key to be used with the mobile push notification.
void	setData(java.util.Map<java.lang.String,java.lang.String> data) Specifies the data to be used with the mobile push notification.
void	setDelayWhileIdle(java.lang.String delayWhileIdle) Specifies the delay while idle flag to be used with the mobile push notification.
void	setTableInfo(SimpleTableInfo tableInfo) Sets the specification of the table to be subscribed.
void	setTimeToLive(java.lang.String timeToLive) Specifies the time to live to be used with the mobile push notification.
void	setTriggerExpression(java.lang.String triggerExpression) Specifies a boolean expression that, when set, will be evaluated against each table update and will act as a trigger to deliver the mobile push notification.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MpnInfo

public MpnInfo(SimpleTableInfo tableInfo,
               java.lang.String collapseKey)

Creates an MpnInfo object with the specified parameters.

Parameters:

tableInfo - contains the specification of the table to be subscribed. A copy of the object is stored internally.

collapseKey - specifies the collapse key to be used with the mobile push notification.

MpnInfo

public MpnInfo(SimpleTableInfo tableInfo,
               java.util.Map<java.lang.String,java.lang.String> data)

Creates an MpnInfo object with the specified parameters.

Parameters:

tableInfo - contains the specification of the table to be subscribed. A copy of the object is stored internally.

data - specifies the data to be used with the mobile push notification.

MpnInfo

public MpnInfo(SimpleTableInfo tableInfo,
               java.lang.String collapseKey,
               java.util.Map<java.lang.String,java.lang.String> data)

Creates an MpnInfo object with the specified parameters.

Parameters:

tableInfo - contains the specification of the table to be subscribed. A copy of the object is stored internally.

collapseKey - specifies the collapse key to be used with the mobile push notification.

data - specifies the data to be used with the mobile push notification.

MpnInfo

public MpnInfo(SimpleTableInfo tableInfo,
               java.lang.String collapseKey,
               java.util.Map<java.lang.String,java.lang.String> data,
               java.lang.String delayWhileIdle,
               java.lang.String timeToLive)

Creates an MpnInfo object with the specified parameters.

Parameters:

tableInfo - contains the specification of the table to be subscribed. A copy of the object is stored internally.

collapseKey - specifies the collapse key to be used with the mobile push notification.

data - specifies the data to be used with the mobile push notification.

delayWhileIdle - specifies the delay while idle flag to be used with the mobile push notification.

timeToLive - specifies the time to live to be used with the mobile push notification.

Method Detail

getTableInfo

public SimpleTableInfo getTableInfo()

The specification of the table to be subscribed. May be a SimpleTableInfo or an ExtendedTableInfo.

Returns:

the table specifications.

setTableInfo

public void setTableInfo(SimpleTableInfo tableInfo)

Sets the specification of the table to be subscribed. May be a SimpleTableInfo or an ExtendedTableInfo. A copy of the object is stored internally.
This parameter is mandatory and must be set.

Parameters:

tableInfo - the specification of a table.

getCollapseKey

public java.lang.String getCollapseKey()

The collapse key to be used with the mobile push notification.

Returns:

the collapse key.

setCollapseKey

public void setCollapseKey(java.lang.String collapseKey)

Specifies the collapse key to be used with the mobile push notification.
The content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Parameters:

collapseKey - a string to be used as a collapse key.

getData

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

The data to be used with the mobile push notification.

Returns:

the data as string map.

setData

public void setData(java.util.Map<java.lang.String,java.lang.String> data)

Specifies the data to be used with the mobile push notification.
The content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Parameters:

data - a String map to be used as the notification data.

getDelayWhileIdle

public java.lang.String getDelayWhileIdle()

The delay while idle flag to be used with the mobile push notification.

Returns:

the delay while idle expressed as the string "true" or "false".

setDelayWhileIdle

public void setDelayWhileIdle(java.lang.String delayWhileIdle)

Specifies the delay while idle flag to be used with the mobile push notification.
The content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Parameters:

delayWhileIdle - a string that must evaluate to "true" or "false" to be considered valid.

getTimeToLive

public java.lang.String getTimeToLive()

The time to live to be used with the mobile push notification.

Returns:

the time to live expressed as the string representation of an integer.

setTimeToLive

public void setTimeToLive(java.lang.String timeToLive)

Specifies the time to live to be used with the mobile push notification.
The content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Parameters:

timeToLive - a string that must evaluate to an integer to be considered valid.

getTriggerExpression

public java.lang.String getTriggerExpression()

Specifies a boolean expression that, when set, will be evaluated against each table update and will act as a trigger to deliver the mobile push notification.

Returns:

a Java boolean expression.

setTriggerExpression

public void setTriggerExpression(java.lang.String triggerExpression)

Specifies a boolean expression that, when set, will be evaluated against each table update and will act as a trigger to deliver the mobile push notification. The expression must be in Java syntax with the addition of field references. At time of evaluation, the value of referenced fields (e.g. "${last_price}") is included as String variables, and as such appropriate type conversion must be considered (e.g. "Double.parseDouble(${last_price}) > 500.0"). The names of these variables are composed by the prefix "LS_MPN_field" followed by an index. Thus, variable names like "LS_MPN_field1" should be considered reserved and their use avoided in the expression.
Consider potential impact on Server performance when writing trigger expressions. Since Java code may use classes and methods of the JDK, a trigger may cause CPU hogging or memory exhaustion if not well considered. For this reason, a Server-side filter may be applied to refuse poorly written (or even maliciously crafted) trigger expressions. See the Server's MPN notifier configuration file for more information.
If NO expression is set, each table update will result in a mobile push notification. If an expression IS set, a mobile push notification will result only if the expression evaluates to true and no other successive push notifications will be sent.
The content of this property may be subject to length restrictions (see the Server's MPN database configuration for more information).

Parameters:

triggerExpression - a trigger expression in Java syntax.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object