org.jboss.aerogear.unifiedpush.rest.registry.applications

Class PushApplicationEndpoint

java.lang.Object

org.jboss.aerogear.unifiedpush.rest.AbstractBaseEndpoint

org.jboss.aerogear.unifiedpush.rest.registry.applications.PushApplicationEndpoint

public class PushApplicationEndpoint
extends AbstractBaseEndpoint

Field Summary

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

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
	PushApplicationEndpoint()
protected	PushApplicationEndpoint(javax.validation.Validator validator, SearchManager searchManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	countInstallations(String pushApplicationID) Count Push Applications
javax.ws.rs.core.Response	deletePushApplication(String pushApplicationID) Delete Push Application
javax.ws.rs.core.Response	findById(String pushApplicationID, boolean includeDeviceCount, boolean includeActivity) Get Push Application.
javax.ws.rs.core.Response	listAllPushApplications(Integer page, Integer pageSize, boolean includeDeviceCount, boolean includeActivity) List Push Applications
javax.ws.rs.core.Response	registerPushApplication(org.jboss.aerogear.unifiedpush.api.PushApplication pushApp) Create Push Application
javax.ws.rs.core.Response	resetMasterSecret(String pushApplicationID) Reset MasterSecret for Push Application
javax.ws.rs.core.Response	updatePushApplication(String pushApplicationID, org.jboss.aerogear.unifiedpush.api.PushApplication updatedPushApp) Update Push Application

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

Constructor Detail

PushApplicationEndpoint

public PushApplicationEndpoint()

PushApplicationEndpoint

protected PushApplicationEndpoint(javax.validation.Validator validator,
                                  SearchManager searchManager)

Method Detail

registerPushApplication

public javax.ws.rs.core.Response registerPushApplication(org.jboss.aerogear.unifiedpush.api.PushApplication pushApp)

Create Push Application

Parameters:

pushApp - new PushApplication

Returns:

created PushApplication

Status codes:

201 The PushApplication Variant created successfully, 400 The format of the client request was incorrect, 409 The PushApplication already exists

listAllPushApplications

public javax.ws.rs.core.Response listAllPushApplications(Integer page,
                                                         Integer pageSize,
                                                         boolean includeDeviceCount,
                                                         boolean includeActivity)

List Push Applications

Parameters:

page - page number

pageSize - number of items per page

includeDeviceCount - put device count into response headers, default false

includeActivity - put activity into response headers, default false

Returns:

list of PushApplications

Response headers:

total Total count of items, activity_app_{pushApplicationID} Count number of messages for Push Application, activity_variant_{variantID} Count number of messages for Variant, deviceCount_app_{pushApplicationID} Count number of devices for Push Application, deviceCount_variant_{variantID} Count number of devices for Variant

findById

public javax.ws.rs.core.Response findById(String pushApplicationID,
                                          boolean includeDeviceCount,
                                          boolean includeActivity)

Get Push Application.

Parameters:

pushApplicationID - id of PushApplication

includeDeviceCount - boolean param to put device count into response headers, default false

includeActivity - boolean param to put activity into response headers, default false

Returns:

requested PushApplication

Status codes:

404 The requested PushApplication resource does not exist

Response headers:

activity_app_{pushApplicationID} Count number of messages for Push Application, activity_variant_{variantID} Count number of messages for Variant, deviceCount_app_{pushApplicationID} Count number of devices for Push Application, deviceCount_variant_{variantID} Count number of devices for Variant

updatePushApplication

public javax.ws.rs.core.Response updatePushApplication(String pushApplicationID,
                                                       org.jboss.aerogear.unifiedpush.api.PushApplication updatedPushApp)

Update Push Application

Parameters:

pushApplicationID - id of PushApplication

updatedPushApp - new info of PushApplication

Returns:

updated PushApplication

Status codes:

204 The PushApplication updated successfully, 400 The format of the client request was incorrect, 404 The requested PushApplication resource does not exist

resetMasterSecret

public javax.ws.rs.core.Response resetMasterSecret(String pushApplicationID)

Reset MasterSecret for Push Application

Parameters:

pushApplicationID - id of PushApplication

Returns:

updated PushApplication

Status codes:

200 The MasterSecret for Push Application reset successfully, 404 The requested PushApplication resource does not exist

deletePushApplication

public javax.ws.rs.core.Response deletePushApplication(String pushApplicationID)

Delete Push Application

Parameters:

pushApplicationID - id of PushApplication

Returns:

no content

Status codes:

204 The PushApplication successfully deleted, 404 The requested PushApplication resource does not exist

countInstallations

public javax.ws.rs.core.Response countInstallations(String pushApplicationID)

Count Push Applications

Parameters:

pushApplicationID - id of PushApplication

Returns:

count number for each VariantType