Permalink
..
Failed to load latest commit information.
css Applying quickstart changes to kborchers' branch, to keep the history… Aug 2, 2013
js Updates and using latest AG.js Jun 17, 2015
LICENSE Adding the lovely Apache 2.0 license Aug 2, 2013
README.md Update readme and Application Code to use new JS Lib Aug 1, 2014
index.html

README.md

aerogear-simplepush-quickstart

An introduction to SimplePush and what AeroGear offers around SimplePush!

What is SimplePush?

SimplePush is a specification from Mozilla that describes a JavaScript API and a protocol which allows backend/application developers to send notification messages to their web applications. Originally SimplePush was introduced for Firefox OS but there are plans to establish the API on the desktop and mobile browsers as well.

Firefox OS v1.1 uses SimplePush as its Push Notification technology. Firefox OS Push Notifications are designed for one thing – waking up apps. They do not deal with data, desktop notifications and other features, since there are other Web APIs that provide them. From the very beginning SimplePush was designed to explicitly not carry any payload. Instead a version number is sent to the client. Based on that version number the client can perfom an action, e.g. refresh a view of data.

Mozilla published a very detailed article that explains the API in depth.

AeroGear and SimplePush

The AeroGear project offers two components around Mozilla's SimplePush:

  • a polyfill JavaScript client library
  • a Server implementation of the protocol

Inside of the SimplePush Protocol it is specified that the connection between the clients (e.g. a Firefox OS device or a Firefox browser) and the server needs to be established over a (secure) WebSocket connection.

Since the AeroGear polyfill library supports other browsers that may lack WebSocket support or are using an older version of the standard, a transparent fallback strategy has been implemented. The SockJS protocol is supported on both sides: the JavaScript library and the server implementation.

AeroGear's SimplePush Server

The AeroGear SimplePush Server is written in Java and based on the Netty Framework. The server supports three different runtime platforms for your deployment:

  • standalone java process (used in this quickstart)
  • vert.x - A server plugin for the vert.x platform
  • WildFly/AS7 - A module to embed the server within WildFly/AS7

AeroGear.js

The polyfill nature of the SimplePush support in AeroGear.js makes it easy to run SimplePush in any browser, there is no limitation to Firefox OS or the Firefox browsers.

Getting started!

Building the AeroGear SimplePush Server

First, clone the AeroGear SimplePush Server git repository and build the source code:

git clone git@github.com:aerogear/aerogear-simplepush-server.git
cd aerogear-simplepush-server
mvn install -DskipTests=true

Now perform a cd server-netty and execute the following command to start the server on your machine:

mvn exec:java -Dexec.args="-host=localhost -port=7777 -tls=false -ack_interval=10000 -useragent_reaper_timeout=60000 -token_key=yourRandomToken"

This starts an unsecured instance of the AeroGear SimplePush Server on localhost using port 7777.

NOTE: The server uses an in-memory database for this demo. None of the SimplePush channels are persisted by the server. A restart of the server means that the previous registered channels are gone.

JavaScript client

Simply open the index.html file in a browser of your choice. This will establish a (SockJS) connection to the SimplePush server and, once established, it will request a subscription to a mail endpoint on the SimplePush server. When ever the SimplePush server receives a notification, it will send it to the client, using the same SockJS connection.

More details on the JavaScript code are covered below....

Send a message

Now that we have a connected client it is time to send a message to the client. If the above connection was successful, the browser should have logged a

Mail pushEndpoint URL: {pushEndpoint}

message.

For sending a notification to the client, copy the above URL and add it the the cURL command below:

curl -i --header "Content-Type:application/x-www-form-urlencoded" -X PUT -d "version=2" {pushEndpoint}

This sends a HTTP PUT request to the SimplePush server and the server will deliver the message to the connected client.

Congratulations! You have received your first notification using AeroGear's SimplePush offerings!

NOTE: If you want to send another push notification to that endpoint, make sure you are increasing the version number (e.g. version=3 or version=4 in this case)! Using the same version for that given endpoint does not cause a push notification to be sent to the client.

Details: The JavaScript client

Now after a successful test, let's have a look at the JavaScript that is involved. Open the js/simplepush.js file in a text editor or IDE of your choice.

Near the bottom of the JavaScript file the connection to the SimplePush server is established:

SPClient = AeroGear.SimplePushClient({
    simplePushServerURL: "http://localhost:7777/simplepush",
    onConnect: spConnect,
    onClose: spClose
});

In our polyfill library the AeroGear SimplePushClient takes a few arguments:

  • simplePushServerURL - the URL of the SimplePush Server
  • onConnect - a callback being invoked after the connection has been established
  • onClose - a callback being invoked if the connection has been closed or interrupted.

Note: This behavior is slightly different from the native environment in Firefox OS, since the device there is reponsible for maintaining one peristent connection to the actual Push Network (aka the SimplePush server). The code below matches the SimplePush API from Mozilla.

Inside of the spConnect callback function we use the PushManager object (navigator.push) to request a notification endpoint from the SimplePush server:

// use 'PushManager' to request a new
// PushServer URL endpoint for 'mail' notifications:
mailRequest = navigator.push.register();

If the request was successful, the onsuccess function of the request object is invoked to perform some code which handles the successful 'registration':

// the request returns 'successfully':
mailRequest.onsuccess = function( event ) {
    ...
    appendTextArea("Mail pushEndpoint URL: \n" + mailEndpoint);
    ...
}

When the client registers for the SimplePush channel, a pushEndpoint is passed along. This URL is used for sending notifications to this client, as shown above. Note: The registered channels are stored in your browser's localStorage.

Next we need to setup a message handler:

// set the notification handler:
navigator.setMessageHandler( "push", function( message ) {
    // we got message for our 'mail' endpoint ?
    if ( message.pushEndpoint === mailEndpoint ) {
        // let's react on that mail....
        appendTextArea("Mail Notification - " + message.version);
    }
});

The notification handler receives any push message/event. Inside of the attached function, we perform some application specific JavaScript code. First we check if the pushEndpoint of the received message matches the pushEndpoint of our notification endpoint. If that is the case, we log the current version of the new data.

Note: As said above, in SimplePush no payload is being sent to the client. In this quickstart nothing special is done. In a real web application it would be reasonable to perform a HTTP GET based on a received version update, to display the latest data.

Have fun!