AeroGear SimplePush Server API 0.12.1
A C D E G H N O P R S T U V 

A

ack() - Method in class org.jboss.aerogear.simplepush.server.Notification
 
acknowledmentInterval() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
Returns the acknowledgement interval.

C

Channel - Interface in org.jboss.aerogear.simplepush.server
A Channel instance represents the server side information of a channel in the SimplePush specification protocol
channelId() - Method in exception org.jboss.aerogear.simplepush.server.datastore.ChannelNotFoundException
Return the channel id that could not be located.
ChannelNotFoundException - Exception in org.jboss.aerogear.simplepush.server.datastore
An exception to signal that a channel could not be located in the DataStore in use.
ChannelNotFoundException(String, String) - Constructor for exception org.jboss.aerogear.simplepush.server.datastore.ChannelNotFoundException
 
ChannelNotFoundException(String, String, Throwable) - Constructor for exception org.jboss.aerogear.simplepush.server.datastore.ChannelNotFoundException
 
config() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Returns the configuration for this SimplePush server.

D

DataStore - Interface in org.jboss.aerogear.simplepush.server.datastore
Handles the storing of channels for a SimplePush Server implementation.
DEFAULT_ENDPOINT_URL_PREFIX - Static variable in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
The default prefix for the the notification endpoint url.
DefaultChannel - Class in org.jboss.aerogear.simplepush.server
 
DefaultChannel(String, String, String) - Constructor for class org.jboss.aerogear.simplepush.server.DefaultChannel
 
DefaultChannel(String, String, long, String) - Constructor for class org.jboss.aerogear.simplepush.server.DefaultChannel
 

E

endpointHost() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
The externally available host that this server is reachable by.
endpointPort() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
The externally available port that this server is reachable by.
endpointPrefix() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
Returns the endpoint url prefix for this SimplePush server.
endpointUrl() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
Returns the notification endpoint url prefix for this SimplePush server.
equals(Object) - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 

G

getChannel(String) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Returns the Channel for the passed-in channelId.
getChannelId() - Method in interface org.jboss.aerogear.simplepush.server.Channel
Returns the channelId for this channel.
getChannelId() - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 
getChannelIds(String) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Returns registered channel ids for a certain UserAgent Identifier (uaid)
getEndpointToken() - Method in interface org.jboss.aerogear.simplepush.server.Channel
Returns the endpoint token for this channel.
getEndpointToken() - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 
getPrivateKeySalt() - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Returns the server's private key salt.
getUAID() - Method in interface org.jboss.aerogear.simplepush.server.Channel
A unique identifier for a UserAgent created by the SimplePush Server.
getUAID() - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 
getUnacknowledged(String) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Returns the Acks that have been sent to a UserAgent as notifications.
getUnacknowledged(String) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Returns all the un-acknowledged notifications for a specific UserAgent.
getVersion() - Method in interface org.jboss.aerogear.simplepush.server.Channel
Returns the version for this channel.
getVersion() - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 

H

handleAcknowledgement(AckMessage, String) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Handles the 'ack' message in the SimplePush protocol which is acknowledge a notification.
handleHandshake(HelloMessage) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Handles the handshake ('hello') message in the SimplePush protocol.
handleNotification(String, String) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Handles the notification for a single channel
handleRegister(RegisterMessage, String) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Handles the 'register' message in the SimplePush protocol which is used to register a channel.
handleUnregister(UnregisterMessage, String) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Handles the 'unregister' message in the SimplePush protocol which is used to register a channel.
hashCode() - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 
host() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
The host that this server will bind to.

N

Notification - Class in org.jboss.aerogear.simplepush.server
Notification is data container for notification information to be sent to a UserAgent.
Notification(String, Ack) - Constructor for class org.jboss.aerogear.simplepush.server.Notification
 
notifierMaxThreads() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
Returns the maxium number of threads that will be used for handling notifications.

O

org.jboss.aerogear.simplepush.server - package org.jboss.aerogear.simplepush.server
 
org.jboss.aerogear.simplepush.server.datastore - package org.jboss.aerogear.simplepush.server.datastore
 

P

password() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
The password for the private key.
port() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
The port that this server will bind to.

R

removeAcknowledged(String, Set<Ack>) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Removes the Acks from storage which should be done when a UserAgent has acknowledged notifications.
removeAllChannels(String) - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServer
Removes all the channels associated with the UserAgent.
removeChannels(String) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Removes all channels for a certain UserAgent Identifier (uaid).
removeChannels(Set<String>) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Removes all channels matching the set passed in.

S

saveChannel(Channel) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Saves the channel to the underlying storage system.
savePrivateKeySalt(byte[]) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Saves the server's private key salt.
saveUnacknowledged(String, long) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
 
SimplePushServer - Interface in org.jboss.aerogear.simplepush.server
A Java implementation of a SimplePush Server.
SimplePushServerConfig - Interface in org.jboss.aerogear.simplepush.server
Configuration settings for SimplePush server

T

toString() - Method in class org.jboss.aerogear.simplepush.server.DefaultChannel
 

U

uaid() - Method in class org.jboss.aerogear.simplepush.server.Notification
 
updateVersion(String, long) - Method in interface org.jboss.aerogear.simplepush.server.datastore.DataStore
Updates the version for a channel (identified by the endpointToken)
useEndpointTls() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
Determins whether transport layer security is in use.
userAgentReaperTimeout() - Method in interface org.jboss.aerogear.simplepush.server.SimplePushServerConfig
Returns the UserAgent reaper time out.

V

VersionException - Exception in org.jboss.aerogear.simplepush.server.datastore
 
VersionException() - Constructor for exception org.jboss.aerogear.simplepush.server.datastore.VersionException
 
VersionException(String, Throwable) - Constructor for exception org.jboss.aerogear.simplepush.server.datastore.VersionException
 
VersionException(String) - Constructor for exception org.jboss.aerogear.simplepush.server.datastore.VersionException
 
VersionException(Throwable) - Constructor for exception org.jboss.aerogear.simplepush.server.datastore.VersionException
 
A C D E G H N O P R S T U V 
AeroGear SimplePush Server API 0.12.1

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