org.jboss.aerogear.unifiedpush.rest.registry.installations

Class InstallationRegistrationEndpoint

java.lang.Object

org.jboss.aerogear.unifiedpush.rest.AbstractBaseEndpoint

org.jboss.aerogear.unifiedpush.rest.registry.installations.InstallationRegistrationEndpoint

public class InstallationRegistrationEndpoint
extends AbstractBaseEndpoint

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
InstallationRegistrationEndpoint()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	crossOriginForInstallations(javax.ws.rs.core.HttpHeaders headers) Cross Origin for Installations
javax.ws.rs.core.Response	crossOriginForInstallations(javax.ws.rs.core.HttpHeaders headers, String token) Cross Origin for Installations
javax.ws.rs.core.Response	importDevice(ImporterForm form, javax.servlet.http.HttpServletRequest request) API for uploading JSON file to allow massive device registration (aka import).
javax.ws.rs.core.Response	increasePushMessageReadCounter(String pushMessageId, javax.servlet.http.HttpServletRequest request) RESTful API for Push Notification metrics registration.
javax.ws.rs.core.Response	registerInstallation(String oldToken, org.jboss.aerogear.unifiedpush.api.Installation entity, javax.servlet.http.HttpServletRequest request) RESTful API for Device registration.
javax.ws.rs.core.Response	unregisterInstallations(String token, javax.servlet.http.HttpServletRequest request) RESTful API for Device unregistration.

Methods inherited from class org.jboss.aerogear.unifiedpush.rest.AbstractBaseEndpoint

createBadRequestResponse, getSearch, validateModelClass

Methods inherited from class java.lang.Object

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

Field Detail

mapper

public static final com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

InstallationRegistrationEndpoint

public InstallationRegistrationEndpoint()

Method Detail

crossOriginForInstallations

public javax.ws.rs.core.Response crossOriginForInstallations(@Context
                                                             javax.ws.rs.core.HttpHeaders headers,
                                                             String token)

Cross Origin for Installations

Parameters:

headers - "Origin" header

token - token

Returns:

"Access-Control-Allow-Origin" header for your response

Status codes:

200 Successful response for your request

Response headers:

Access-Control-Allow-Origin With host in your "Origin" header, Access-Control-Allow-Methods POST, DELETE, Access-Control-Allow-Headers accept, origin, content-type, authorization, Access-Control-Allow-Credentials true, Access-Control-Max-Age 604800

crossOriginForInstallations

public javax.ws.rs.core.Response crossOriginForInstallations(@Context
                                                             javax.ws.rs.core.HttpHeaders headers)

Cross Origin for Installations

Parameters:

headers - "Origin" header

Returns:

"Access-Control-Allow-Origin" header for your response

Status codes:

200 Successful response for your request

Response headers:

Access-Control-Allow-Origin With host in your "Origin" header, Access-Control-Allow-Methods POST, DELETE, Access-Control-Allow-Headers accept, origin, content-type, authorization, Access-Control-Allow-Credentials true, Access-Control-Max-Age 604800

registerInstallation

public javax.ws.rs.core.Response registerInstallation(@HeaderParam(value="x-ag-old-token")
                                                      String oldToken,
                                                      org.jboss.aerogear.unifiedpush.api.Installation entity,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request)

RESTful API for Device registration. The Endpoint is protected using HTTP Basic (credentials VariantID:secret).

 curl -u "variantID:secret"
   -v -H "Accept: application/json" -H "Content-type: application/json" -H "aerogear-push-id: someid"
   -X POST
   -d '{
     "deviceToken" : "someTokenString",
     "deviceType" : "iPad",
     "operatingSystem" : "iOS",
     "osVersion" : "6.1.2",
     "alias" : "someUsername or email adress...",
     "categories" : ["football", "sport"]
   }'
   https://SERVER:PORT/context/rest/registry/device
 

Details about JSON format can be found HERE!

Parameters:

oldToken - The previously registered deviceToken or an empty String. Provided by the header x-ag-old-token.

entity - Installation for Device registration

request - the request object

Returns:

registered Installation

Status codes:

200 Successful storage of the device metadata, 400 The format of the client request was incorrect (e.g. missing required values), 401 The request requires authentication

Request headers:

x-ag-old-token the old push service dependant token (ie InstanceID in FCM). If present these tokens will be forcefully unregistered before the new token is registered.

Response headers:

Access-Control-Allow-Origin With host in your "Origin" header, Access-Control-Allow-Credentials true, WWW-Authenticate Basic realm="AeroGear UnifiedPush Server" (only for 401 response)

increasePushMessageReadCounter

public javax.ws.rs.core.Response increasePushMessageReadCounter(String pushMessageId,
                                                                @Context
                                                                javax.servlet.http.HttpServletRequest request)

RESTful API for Push Notification metrics registration. The Endpoint is protected using HTTP Basic (credentials VariantID:secret).

 curl -u "variantID:secret"
   -v -H "Accept: application/json" -H "Content-type: application/json" -H "aerogear-push-id: someid"
   -X PUT
   https://SERVER:PORT/context/rest/registry/device/pushMessage/{pushMessageId}
 

Parameters:

pushMessageId - push message identifier

request - the request

Returns:

empty JSON body

Status codes:

200 Successful storage of the device metadata, 401 The request requires authentication

Response headers:

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

unregisterInstallations

public javax.ws.rs.core.Response unregisterInstallations(String token,
                                                         @Context
                                                         javax.servlet.http.HttpServletRequest request)

RESTful API for Device unregistration. The Endpoint is protected using HTTP Basic (credentials VariantID:secret).

 curl -u "variantID:secret"
   -v -H "Accept: application/json" -H "Content-type: application/json"
   -X DELETE
   https://SERVER:PORT/context/rest/registry/device/{token}
 

Parameters:

token - device token

request - the request

Returns:

empty json

Status codes:

204 Successful unregistration, 401 The request requires authentication, 404 The requested device metadata does not exist

Response headers:

Access-Control-Allow-Origin With host in your "Origin" header, Access-Control-Allow-Credentials true, WWW-Authenticate Basic realm="AeroGear UnifiedPush Server" (only for 401 response)

importDevice

public javax.ws.rs.core.Response importDevice(ImporterForm form,
                                              @Context
                                              javax.servlet.http.HttpServletRequest request)

API for uploading JSON file to allow massive device registration (aka import). The Endpoint is protected using HTTP Basic (credentials VariantID:secret).

 curl -u "variantID:secret"
   -v -H "Accept: application/json" -H "Content-type: multipart/form-data"
   -F "file=@/path/to/my-devices-for-import.json"
   -X POST
   https://SERVER:PORT/context/rest/registry/device/importer
 

The format of the JSON file is an array, containing several objects that follow the same syntax used on the /rest/registry/device endpoint.

Here is an example:

 [
   {
     "deviceToken" : "someTokenString",
     "deviceType" : "iPad",
     "operatingSystem" : "iOS",
     "osVersion" : "6.1.2",
     "alias" : "someUsername or email adress...",
     "categories" : ["football", "sport"]
   },
   {
     "deviceToken" : "someOtherTokenString",
     ...
   },
   ...
 ]
 

Parameters:

form - JSON file to import

request - the request

Returns:

empty JSON body

Status codes:

200 Successful submission of import job, 400 The format of the client request was incorrect, 401 The request requires authentication

Response headers:

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