AeroGear SimplePush Server Protocol 0.11.0
A C E F G H J M N O P R S T U V

A

Ack - Interface in org.jboss.aerogear.simplepush.protocol
Represents an update entry in the Notification message, 'notification' message type, in the SimplePush specification protocol.
AckImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
Concrete Ack implementation.
AckImpl(String, long) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.AckImpl
 
AckMessage - Interface in org.jboss.aerogear.simplepush.protocol
Represents the acknowledgement message, 'ack' message type, in the SimplePush specification protocol.
AckMessageImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
AckMessageImpl(Set<Ack>) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.AckMessageImpl
 

C

CHANNEL_ID_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.RegisterMessage
The name of the channelID JSON field.
CHANNEL_IDS_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.HelloMessage
The name of the channelIDs JSON field.

E

equals(Object) - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckImpl
 

F

fromJson(String, Class<T>) - Static method in class org.jboss.aerogear.simplepush.protocol.impl.json.JsonUtil
Transforms from JSON to the type specified.

G

getAcks() - Method in interface org.jboss.aerogear.simplepush.protocol.AckMessage
Returns the channel ids that have been acknowledged by UserAgent
getAcks() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckMessageImpl
 
getAcks() - Method in class org.jboss.aerogear.simplepush.protocol.impl.NotificationMessageImpl
 
getAcks() - Method in interface org.jboss.aerogear.simplepush.protocol.NotificationMessage
Returns the set channel ids that have been updated for a UserAgent
getChannelId() - Method in interface org.jboss.aerogear.simplepush.protocol.Ack
Returns the channel id for this ack.
getChannelId() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckImpl
 
getChannelId() - Method in class org.jboss.aerogear.simplepush.protocol.impl.RegisterMessageImpl
 
getChannelId() - Method in class org.jboss.aerogear.simplepush.protocol.impl.UnregisterMessageImpl
 
getChannelId() - Method in interface org.jboss.aerogear.simplepush.protocol.RegisterMessage
Returns the channelId that was sent from the UserAgent.
getChannelId() - Method in interface org.jboss.aerogear.simplepush.protocol.UnregisterMessage
Returns the channelId that was sent from the UserAgent.
getChannelIds() - Method in interface org.jboss.aerogear.simplepush.protocol.HelloMessage
Channel identifiers are created on the UserAgent side and are stored by the SimplePush Server and associated with the UserAgent.
getChannelIds() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
getCode() - Method in class org.jboss.aerogear.simplepush.protocol.impl.StatusImpl
 
getCode() - Method in interface org.jboss.aerogear.simplepush.protocol.Status
Returns the error code for this Status.
getMessage() - Method in class org.jboss.aerogear.simplepush.protocol.impl.StatusImpl
 
getMessage() - Method in interface org.jboss.aerogear.simplepush.protocol.Status
Returns the message for this Status.
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckMessageImpl
 
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloResponseImpl
 
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.NotificationMessageImpl
 
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.PingMessageImpl
 
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.RegisterMessageImpl
 
getMessageType() - Method in class org.jboss.aerogear.simplepush.protocol.impl.UnregisterMessageImpl
 
getMessageType() - Method in interface org.jboss.aerogear.simplepush.protocol.MessageType
Returns the Type of this message.
getPingMessage() - Method in class org.jboss.aerogear.simplepush.protocol.impl.PingMessageImpl
 
getPingMessage() - Method in interface org.jboss.aerogear.simplepush.protocol.PingMessage
Returns contents of the ping message, which should be '{}'.
getPushEndpoint() - Method in class org.jboss.aerogear.simplepush.protocol.impl.RegisterResponseImpl
 
getPushEndpoint() - Method in interface org.jboss.aerogear.simplepush.protocol.RegisterResponse
Returns the push endpoint for this channel.
getStatus() - Method in class org.jboss.aerogear.simplepush.protocol.impl.RegisterResponseImpl
 
getStatus() - Method in class org.jboss.aerogear.simplepush.protocol.impl.UnregisterResponseImpl
 
getStatus() - Method in interface org.jboss.aerogear.simplepush.protocol.RegisterResponse
Returns the result of the Register call
getStatus() - Method in interface org.jboss.aerogear.simplepush.protocol.UnregisterResponse
Returns the result of the Register call
getUAID() - Method in interface org.jboss.aerogear.simplepush.protocol.HelloMessage
A globally unique identifier for a UserAgent created by the SimplePush Server.
getUAID() - Method in interface org.jboss.aerogear.simplepush.protocol.HelloResponse
A globally unique identifier for a UserAgent created by the SimplePush Server.
getUAID() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
getUAID() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloResponseImpl
 
getVersion() - Method in interface org.jboss.aerogear.simplepush.protocol.Ack
Returns the version for this ack.
getVersion() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckImpl
 

H

hashCode() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckImpl
 
HelloMessage - Interface in org.jboss.aerogear.simplepush.protocol
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.
HelloMessageImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
HelloMessageImpl() - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
HelloMessageImpl(String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
HelloMessageImpl(String, Set<String>) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
HelloResponse - Interface in org.jboss.aerogear.simplepush.protocol
Represents the handshake response message, 'hello' message type, in the SimplePush specification protocol.
HelloResponseImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
HelloResponseImpl(String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.HelloResponseImpl
 

J

JSON - Static variable in class org.jboss.aerogear.simplepush.protocol.impl.PingMessageImpl
 
JsonUtil - Class in org.jboss.aerogear.simplepush.protocol.impl.json
JSON utility class for transforming SimplePush messages to and from JSON.

M

MessageType - Interface in org.jboss.aerogear.simplepush.protocol
Represents the 'messageType' of a messages in the SimplePush specification protocol.
MessageType.Type - Enum in org.jboss.aerogear.simplepush.protocol
 
MESSSAGE_TYPE_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.MessageType
The name of the messageType JSON field.

N

NotificationMessage - Interface in org.jboss.aerogear.simplepush.protocol
Represents the Notification message, 'notification' messageType, in the SimplePush specification protocol.
NotificationMessageImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
NotificationMessageImpl(Ack) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.NotificationMessageImpl
 
NotificationMessageImpl(Set<Ack>) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.NotificationMessageImpl
 

O

org.jboss.aerogear.simplepush.protocol - package org.jboss.aerogear.simplepush.protocol
 
org.jboss.aerogear.simplepush.protocol.impl - package org.jboss.aerogear.simplepush.protocol.impl
 
org.jboss.aerogear.simplepush.protocol.impl.json - package org.jboss.aerogear.simplepush.protocol.impl.json
 

P

parseFrame(String) - Static method in class org.jboss.aerogear.simplepush.protocol.impl.json.JsonUtil
A convenience method for transforming a SimplePush message frame into an instance of MessageType.
PING_MESSAGE - Static variable in interface org.jboss.aerogear.simplepush.protocol.PingMessage
The default value for a Ping message body.
PingMessage - Interface in org.jboss.aerogear.simplepush.protocol
Represents the Ping message in the SimplePush specification protocol This message can be send by the UserAgent to verify that the connection to the server is working.
PingMessageImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
PingMessageImpl() - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.PingMessageImpl
 
PingMessageImpl(String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.PingMessageImpl
 
PUSH_ENDPOINT__FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.RegisterResponse
The name of the pushEndpoint JSON field.

R

RegisterMessage - Interface in org.jboss.aerogear.simplepush.protocol
Represents the Register message, 'register' message type, in the SimplePush specification protocol.
RegisterMessageImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
RegisterMessageImpl(String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.RegisterMessageImpl
 
RegisterResponse - Interface in org.jboss.aerogear.simplepush.protocol
Represents the Register response message, 'register' message type, in the SimplePush specification protocol This message is sent from the PushServer to the UserAgent with the result of a registration request.
RegisterResponseImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
RegisterResponseImpl(String, Status, String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.RegisterResponseImpl
 

S

Status - Interface in org.jboss.aerogear.simplepush.protocol
Represents a status that may be returned by a Register, Unregister messages in SimplePush specification protocol.
STATUS_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.RegisterResponse
The name of the status JSON field.
STATUS_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.UnregisterResponse
The name of the status JSON field.
StatusImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
StatusImpl(int, String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.StatusImpl
 

T

toJson(Object) - Static method in class org.jboss.aerogear.simplepush.protocol.impl.json.JsonUtil
Transforms from Java object notation to JSON.
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.AckMessageImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloMessageImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.HelloResponseImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.NotificationMessageImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.PingMessageImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.RegisterMessageImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.RegisterResponseImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.StatusImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.UnregisterMessageImpl
 
toString() - Method in class org.jboss.aerogear.simplepush.protocol.impl.UnregisterResponseImpl
 

U

UAID_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.HelloMessage
The name of the uaid JSON field.
UAID_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.HelloResponse
 
UnregisterMessage - Interface in org.jboss.aerogear.simplepush.protocol
Represents the Unregister message, 'unregister' message type, in the SimplePush specification protocol This message is sent from the UserAgent to the PushServer to unregister for notifications using the channelId.
UnregisterMessageImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
UnregisterMessageImpl(String) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.UnregisterMessageImpl
 
UnregisterResponse - Interface in org.jboss.aerogear.simplepush.protocol
Represents the Unregister response message, 'unregister' message type, in the SimplePush specification protocol This message is sent from the PushServer to the UserAgent with the result of a unregistration request.
UnregisterResponseImpl - Class in org.jboss.aerogear.simplepush.protocol.impl
 
UnregisterResponseImpl(String, Status) - Constructor for class org.jboss.aerogear.simplepush.protocol.impl.UnregisterResponseImpl
 
UPDATES_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.AckMessage
The name of the updates JSON field.
UPDATES_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.NotificationMessage
The name of the updates JSON field.

V

valueOf(String) - Static method in enum org.jboss.aerogear.simplepush.protocol.MessageType.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jboss.aerogear.simplepush.protocol.MessageType.Type
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.AckMessage
The name of the version JSON field.
VERSION_FIELD - Static variable in interface org.jboss.aerogear.simplepush.protocol.NotificationMessage
The name of the version JSON field.

A C E F G H J M N O P R S T U V
AeroGear SimplePush Server Protocol 0.11.0

Copyright © 2014 JBoss by Red Hat. All Rights Reserved.