org.jboss.aerogear.simplepush.protocol
Interface HelloMessage

All Superinterfaces:

MessageType

All Known Implementing Classes:

HelloMessageImpl

public interface HelloMessage
extends MessageType

Represents the handshake message, 'hello' message type, in the SimplePush specification protocol

This message is sent after the initial connection handshake has been completed and represents the handshake between the UserAgent and the SimplePush Server.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

MessageType.Type

Field Summary

static String	CHANNEL_IDS_FIELD The name of the channelIDs JSON field.
static String	UAID_FIELD The name of the uaid JSON field.

Fields inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

MESSSAGE_TYPE_FIELD

Method Summary

Set<String>	getChannelIds() Channel identifiers are created on the UserAgent side and are stored by the SimplePush Server and associated with the UserAgent.
String	getUAID() A globally unique identifier for a UserAgent created by the SimplePush Server.

Methods inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

getMessageType

Field Detail

CHANNEL_IDS_FIELD

static final String CHANNEL_IDS_FIELD

The name of the channelIDs JSON field.

See Also:

Constant Field Values

UAID_FIELD

static final String UAID_FIELD

The name of the uaid JSON field.

See Also:

Constant Field Values

Method Detail

getUAID

String getUAID()

A globally unique identifier for a UserAgent created by the SimplePush Server.

Returns:

String a globally unique id for a UserAgent, or an empty String if the UserAgent has not been assigned a UAID yet or wants to reset it, which will create a new one.

getChannelIds

Set<String> getChannelIds()

Channel identifiers are created on the UserAgent side and are stored by the SimplePush Server and associated with the UserAgent. Every channelId has a version and an endpoint associated with it.

Returns:

Set<String> a set of channelIds sent from the UserAgent, or an empty list if no channel ids were sent.