org.jboss.aerogear.simplepush.server
Interface Channel

All Known Implementing Classes:

DefaultChannel

public interface Channel

A Channel instance represents the server side information of a channel in the SimplePush specification protocol

Method Summary

String	getChannelId() Returns the channelId for this channel.
String	getEndpointToken() Returns the endpoint token for this channel.
String	getUAID() A unique identifier for a UserAgent created by the SimplePush Server.
long	getVersion() Returns the version for this channel.

Method Detail

getUAID

String getUAID()

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

Returns:

String a 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.

getChannelId

String getChannelId()

Returns the channelId for this channel. This identifier will be create on by the UserAgent and sent to the SimplePush Server.

Returns:

String this channels identifier.

getVersion

long getVersion()

Returns the version for this channel. The version is maintained and updated by the server side applications triggering push notifications. It is the server side application that will issue a PUT HTTP request with the update version to the SimplePush Server which in turn will notifiy the channel of the update.

Returns:

long the version for this channel.

getEndpointToken

String getEndpointToken()

Returns the endpoint token for this channel. This is the endpoint token that an encrypted hash of the UserAgent ID, a ':', and the channel Id.

Returns:

String the endpoint token.