org.jboss.aerogear.unifiedpush.rest.sender

Class PushNotificationSenderEndpoint

java.lang.Object

org.jboss.aerogear.unifiedpush.rest.sender.PushNotificationSenderEndpoint

public class PushNotificationSenderEndpoint
extends Object

Constructor Summary

Constructors

Constructor and Description
PushNotificationSenderEndpoint()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	send(InternalUnifiedPushMessage message, javax.servlet.http.HttpServletRequest request) RESTful API for sending Push Notifications.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushNotificationSenderEndpoint

public PushNotificationSenderEndpoint()

Method Detail

send

public javax.ws.rs.core.Response send(InternalUnifiedPushMessage message,
                                      @Context
                                      javax.servlet.http.HttpServletRequest request)

RESTful API for sending Push Notifications. The Endpoint is protected using HTTP Basic (credentials PushApplicationID:masterSecret).

Messages are submitted as flexible JSON maps. Below is a simple example:

 curl -u "PushApplicationID:MasterSecret"
   -v -H "Accept: application/json" -H "Content-type: application/json"
   -X POST
   -d '{
     "message": {
      "alert": "HELLO!",
      "sound": "default",
      "user-data": {
          "key": "value",
      }
   }'
   https://SERVER:PORT/CONTEXT/rest/sender
 

Details about the Message Format can be found HERE!

Request Header aerogear-sender uses to identify the used client. If the header is not present, the standard "user-agent" header is used.

Parameters:

message - message to send

request - the request

Returns:

empty JSON body

Status codes:

202 Indicates the Job has been accepted and is being process by the AeroGear UnifiedPush Server, 401 The request requires authentication

Response headers:

WWW-Authenticate Basic realm="AeroGear UnifiedPush Server" (only for 401 response)