com.spacecode.sdk.network.alert

Class Alert

java.lang.Object

com.spacecode.sdk.network.alert.Alert

Direct Known Subclasses:

AlertTemperature

public class Alert
extends java.lang.Object

Alerts allow defining a critical information to be raised and sent by email.

There are several types of Alert for (remote) devices:

• Device disconnected: Communication with the RFID board is lost
• Door open delay: Device has been open for too long
• Temperature: A temperature measure is out of the defined limits
• Thief finger: Device has been open with an anti-thief finger

Constructor Summary

Constructors

Constructor and Description
Alert(AlertType type, java.lang.String to, java.lang.String emailSubject, java.lang.String emailContent, boolean enabled) Build an alert without defining cc/bcc recipients.
Alert(AlertType type, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String emailSubject, java.lang.String emailContent, boolean enabled) Default constructor, full set of parameters.
Alert(int id, AlertType type, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String emailSubject, java.lang.String emailContent, boolean enabled) Deprecated. Deprecated for SDK users. Exclusively designed for internal usages.

Method Summary

Methods

Modifier and Type	Method and Description
static Alert	deserialize(java.lang.String serializedAlert) Create a new Alert instance from a serialized one.
java.lang.String	getBccList()
java.lang.String	getCcList()
java.lang.String	getEmailContent()
java.lang.String	getEmailSubject()
int	getId()
java.lang.String	getToList()
AlertType	getType()
boolean	isEnabled()
java.lang.String	serialize() Format the data with markers (XML-like format) and encode it with base64.
void	setBccList(java.lang.String bccList) Update the list of email "blind copy" recipients ("Bcc: list").
void	setCcList(java.lang.String ccList) Update the list of email "copy" recipients ("Cc: list").
void	setEmailContent(java.lang.String emailContent) Update content of the email sent when the alert is raised.
void	setEmailSubject(java.lang.String emailSubject) Update subject of the email sent when the alert is raised.
void	setEnabled(boolean enabled) Allow enabling/disabling the alert.
void	setToList(java.lang.String toList) Update the list of email main recipients ("To: list").

Methods inherited from class java.lang.Object

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

Constructor Detail

Alert

public Alert(AlertType type,
     java.lang.String to,
     java.lang.String emailSubject,
     java.lang.String emailContent,
     boolean enabled)

Build an alert without defining cc/bcc recipients.

Parameters:

type - Type of Alert (AlertType value).

to - List of email addresses (split with commas) to send the alert to.

emailSubject - Subject of the email to be sent.

emailContent - Content of the email to be sent.

enabled - If false, the alert will not be used by SmartServer (AlertCenter).

Alert

public Alert(AlertType type,
     java.lang.String to,
     java.lang.String cc,
     java.lang.String bcc,
     java.lang.String emailSubject,
     java.lang.String emailContent,
     boolean enabled)

Default constructor, full set of parameters.

Parameters:

type - Type of Alert (AlertType value).

to - List of email addresses (split with commas) to send the alert to.

cc - List of "Cc" recipients (split with commas).

bcc - List of "Bcc" recipients (split with commas).

emailSubject - Subject of the email to be sent.

emailContent - Content of the email to be sent.

enabled - If false, the alert will not be used by SmartServer (AlertCenter).

Alert

@Deprecated
public Alert(int id,
                AlertType type,
                java.lang.String to,
                java.lang.String cc,
                java.lang.String bcc,
                java.lang.String emailSubject,
                java.lang.String emailContent,
                boolean enabled)

Deprecated. Deprecated for SDK users. Exclusively designed for internal usages.

Parameters:

id - Should not be set manually, please consider using another constructor.

type - Type of Alert (AlertType value).

to - List of email addresses (split with commas) to send the alert to.

cc - List of "Cc" recipients (split with commas).

bcc - List of "Bcc" recipients (split with commas).

emailSubject - Subject of the email to be sent.

emailContent - Content of the email to be sent.

enabled - If false, the alert will not be used by SmartServer (AlertCenter).

Method Detail

serialize

public java.lang.String serialize()

Format the data with markers (XML-like format) and encode it with base64.

Returns:

The base64 encoded marked text format Alert (or an empty string if it failed using UTF-8 for String encoding).

deserialize

public static Alert deserialize(java.lang.String serializedAlert)

Create a new Alert instance from a serialized one. If the serialized alert given in parameter is an AlertTemperature, then an AlertTemperature instance is returned.

Parameters:

serializedAlert - Serialized Alert.

Returns:

Deserialized Alert instance. Or null if the serialized data is invalid.

getId

public int getId()

Returns:

Unique identifier of Alert instance.

getType

public AlertType getType()

Returns:

Alert type (AlertType enum value).

setToList

public void setToList(java.lang.String toList)

Update the list of email main recipients ("To: list").

Parameters:

toList - List of recipients, split with commas ("a@a.com, b@a.com, c@a.com"). Can't be null/empty.

getToList

public java.lang.String getToList()

Returns:

List of main recipients ("To: list").

setCcList

public void setCcList(java.lang.String ccList)

Update the list of email "copy" recipients ("Cc: list"). Can be set empty.

Parameters:

ccList - List of recipients, split with commas ("a@a.com, b@a.com, c@a.com").

getCcList

public java.lang.String getCcList()

Returns:

List of carbon copy recipients ("Cc: list").

setBccList

public void setBccList(java.lang.String bccList)

Update the list of email "blind copy" recipients ("Bcc: list"). Can be set empty.

Parameters:

bccList - List of recipients, split with commas ("a@a.com, b@a.com, c@a.com").

getBccList

public java.lang.String getBccList()

Returns:

List of blind carbon copy recipients ("Cc: list").

setEmailSubject

public void setEmailSubject(java.lang.String emailSubject)

Update subject of the email sent when the alert is raised.

Parameters:

emailSubject - Subject. Can't be null/empty.

getEmailSubject

public java.lang.String getEmailSubject()

Returns:

Email (to be sent) subject.

setEmailContent

public void setEmailContent(java.lang.String emailContent)

Update content of the email sent when the alert is raised.

Parameters:

emailContent - Content. Can't be null/empty.

getEmailContent

public java.lang.String getEmailContent()

Returns:

Email (to be sent) content.

setEnabled

public void setEnabled(boolean enabled)

Allow enabling/disabling the alert.

Parameters:

enabled - If true, the alert is enabled.

isEnabled

public boolean isEnabled()

Returns:

True if alert is enabled. False otherwise.