org.jboss.aerogear.webpush

Interface WebPushServer

public interface WebPushServer

A Java implementation of WebPush Server.

Method Summary

Modifier and Type	Method and Description
WebPushServerConfig	config() Returns the configuration for this WebPush server.
Optional<String>	getMessage(String endpoint) Handles the retrieval of a subscriptions's message.
void	monitor(String registrationId, String endpoint) Handles device monitorURI requests which are a signal to the server to begin delivering push notification/messages to the client.
Optional<Subscription>	newSubscription(String registrationId) Handles the creation of new subscriptions for a registration.
Registration	register() Registers a device with this server as per
Optional<Registration>	registration(String id) Returns the Registration for the specified id.
void	removeSubscription(Subscription subscription) Removes the specified subscription.
void	setMessage(String endpoint, Optional<String> content) Set the notifcation/message for a subscription.
Optional<Subscription>	subscription(String endpoint) Retrieves a subscriptions.

Method Detail

register

Registration register()

Registers a device with this server as per Section 4 of the specification.

This establishes a shared session between the device and the server. A new registration does not have any subscriptions associated with it.

Returns:

Registration the response for this registration

registration

Optional<Registration> registration(String id)

Returns the Registration for the specified id.

Parameters:

id - the registration identifier.

Returns:

Optional Registration with the registration or Optional.empty

newSubscription

Optional<Subscription> newSubscription(String registrationId)

Handles the creation of new subscriptions for a registration.

Parameters:

registrationId - the registration id that this new subscription belongs to

subscription

Optional<Subscription> subscription(String endpoint)

Retrieves a subscriptions.

Parameters:

endpoint - the endpoint to retrieve

Returns:

Optional an Optional Subscription

removeSubscription

void removeSubscription(Subscription subscription)

Removes the specified subscription.

Parameters:

subscription - the subscription to be removed

getMessage

Optional<String> getMessage(String endpoint)

Handles the retrieval of a subscriptions's message. This enables clients to query the server for the latest notification/message.

Parameters:

endpoint - the endpoint for the subscriptoin

Returns:

{code String} the latest notification/message for the specified subscription

setMessage

void setMessage(String endpoint,
                Optional<String> content)

Set the notifcation/message for a subscription.

Parameters:

endpoint - that identifies the subscription.

content - the new content.

monitor

void monitor(String registrationId,
             String endpoint)

Handles device monitorURI requests which are a signal to the server to begin delivering push notification/messages to the client.

Parameters:

registrationId - the id of the registration.

endpoint - the endpoint

config

WebPushServerConfig config()

Returns the configuration for this WebPush server.

Returns:

WebPushServerConfig this servers configuration.