lholmquist / keynotepushserver

AeroGear PushEE

AeroGear's Connectivity Server (Java EE poc)

Some guidance

Deploying the server to JBoss AS using the jboss-as-maven-plugin:

mvn package jboss-as:deploy

Register Push App

Register a PushApplication, like Mobile HR:

curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"name" : "MyApp", "description" :  "awesome app" }' http://localhost:8080/ag-push/rest/applications

The response returns an ID for the Push App....

iOS Variant

Add an iOS variant (e.g. HR for iOS):

curl -i -H "Accept: application/json" -H "Content-type: multipart/form-data" 

  -F "certificate=@/Users/matzew/Desktop/MyCert.p12"
  -F "passphrase=TopSecret"

  -X POST http://localhost:8080/ag-push/rest/applications/{PUSH_ID}/iOS

NOTE: The above is a multipart/form-data, since it is required to upload the "Apple Push certificate"!

The response returns an ID for the iOS variant....

Android Variant

Add an android variant (e.g. HR for Android):

curl -v -H "Accept: application/json" -H "Content-type: application/json"
  -X POST
  -d '{"googleKey" : "IDDASDASDSA"}'
  
  http://localhost:8080/ag-push/rest/applications/{PUSH_ID}/android 

The response returns an ID for the Android variant....

SimplePush Variant

Add an android variant (e.g. HR for Android):

curl -v -H "Accept: application/json" -H "Content-type: application/json"
  -X POST
  -d '{"pushNetworkURL" : "http://localhost:7777/endpoint/"}'

  http://localhost:8080/ag-push/rest/applications/{PUSH_ID}/simplePush 

The response returns an ID for the SimplePush variant....

Registration of an installation, on a device (iOS)

Client-side example for how to register an installation:

- (void)application:(UIApplication*)application
  didRegisterForRemoteNotificationsWithDeviceToken:(NSData*)deviceToken
{
    NSString *tokenStr = [deviceToken description];
    NSString *pushToken = [[[tokenStr
      stringByReplacingOccurrencesOfString:@"<" withString:@""]
      stringByReplacingOccurrencesOfString:@">" withString:@""]
      stringByReplacingOccurrencesOfString:@" " withString:@""];

  // TODO: use https
    AFHTTPClient *client =
    [[AFHTTPClient alloc] initWithBaseURL:
         [NSURL URLWithString:@"http://192.168.0.114:8080/ag-push/"]];
    client.parameterEncoding = AFJSONParameterEncoding;

    // set the AG headers....
    [client setDefaultHeader:@"ag-push-app" 
     value:@"SOME ID..."];
    [client setDefaultHeader:@"ag-mobile-app"
	   value:@"SOME OTHER ID..."];



    [client postPath:@"/registry/device"
	  parameters:
       @{
          @"deviceToken": pushToken,
          @"deviceType": @"iPhone", 
          @"mobileOperatingSystem": @"iOS", 
          @"osVersion": @"6.1.3"
        }
	  success:^(AFHTTPRequestOperation *operation, id responseObject) {
        NSLog(@"\nSUCCESS....\n");
    } failure:^(AFHTTPRequestOperation *operation, NSError *error) {
        NSLog(@"%@", error);
    }];
}

No real client SDK, YET!!!!

Registration of an installation, for an Android device:

CURL example for how to register an installation:

curl -v -H "Accept: application/json" -H "Content-type: application/json" 
   -H "ag-mobile-app: {id}"
   -X POST
   -d '{
      "deviceToken" : "someTokenString", 
      "deviceType" : "ANDROID", 
      "mobileOperatingSystem" : "android", 
      "osVersion" : "4.0.1"
    }'

http://localhost:8080/ag-push/rest/registry/device 

Registration of an installation, for a SimplePush client:

CURL example for how to register a connected SimplePush client:

curl -v -H "Accept: application/json" -H "Content-type: application/json"
    -H "ag-mobile-app: {VARIAN_ID}"
    -X POST
    -d '{
       "category" : "broadcast",
       "deviceToken" : "4a81527d-6967-40bb-ac56-755e8cbfb579"
     }'
http://localhost:8080/ag-push/rest/registry/device 

The category matches the (logical) name of the channel; The deviceToken matches the channelID from the SimplePushServer.

Sender

Send broadcast push message to ALL mobile apps of a certain Push APP......:

curl -v -H "Accept: application/json" -H "Content-type: application/json" 
   -X POST

   -d '{"key":"blah", "alert":"HELLO!"}'
   
http://localhost:8080/ag-push/rest/sender/broadcast/{id} 

Sender (Simple Push)

Broadcast Send

The is a (convenience) broadcast channel (for SimplePush). All clients that decided to register with that channel, can receive a message (version), when issuing the following REQUEST:

curl -v -H "Accept: application/json" -H "Content-type: application/json"
    -X POST
    -d '{"version":"1909"}'
http://localhost:8080/ag-push/rest/sender/simplePush/broadcast/{SimplePushVariantID}

Selected Send

To send a message (version) notification to a selected list of Channels, issue the following command:

curl -v -H "Accept: application/json" -H "Content-type: application/json"
    -X POST 
	-d '{
		  "channelIDs":["someID", "moreID...."],
		  "version":"1909"
	    }'
http://localhost:8080/ag-push/rest/sender/simplePush/selected/{SimplePushVariantID} 

NOTE: Using one channelID is desired to notify exactly one connected client/channel.

More details

Concepts and ideas are also being developed...:

See: https://gist.github.com/matzew/69d33a18d4fac9fdedd4

REST APIs

• Registry: https://gist.github.com/matzew/2da6fc349a4aaf629bce
• Sender: https://gist.github.com/matzew/b21c1404cc093825f0fb