Package org.vrspace.server.api

Class WebPush

java.lang.Object

org.vrspace.server.api.ApiBase

org.vrspace.server.api.ClientControllerBase

org.vrspace.server.api.WebPush

@ConditionalOnProperty("webpush.publicKey")
@RestController
@RequestMapping("/vrspace/api/webpush")
public class WebPush
extends ClientControllerBase

Keeps track of clients WebPush subscription data. User must be authorized and connected to manage subscriptions. User can have multiple subscriptions, assuming access from multiple devices. Subscribed users may get notifications while offline, e.g. with new group messages.

Author:

joe

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Fields inherited from class org.vrspace.server.api.ApiBase

API_ROOT

Constructor Summary

Constructors

Constructor	Description
WebPush()

Method Summary

Modifier and Type	Method	Description
String	getKey()	Returns public VAPID key required to create WebPush subscription.
void	subscribe(WebPushSubscription info, jakarta.servlet.http.HttpSession session)	Subscribe to webpush: this notifies the server that the browser has created a webpush subscription.
void	unsubscribe(WebPushSubscription info, jakarta.servlet.http.HttpSession session)	Removes subscription information from the server, when browser unsubscribes.

Methods inherited from class org.vrspace.server.api.ClientControllerBase

findClient, findClient, getAuthorisedClient, getAuthorisedClient, isAuthenticated

Methods inherited from class org.vrspace.server.api.ApiBase

currentUserName, isAuthenticated

Methods inherited from class java.lang.Object

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

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

Constructor Details

WebPush

public WebPush()

Method Details

subscribe

@PostMapping("/subscribe")
public void subscribe(@RequestBody
 WebPushSubscription info,
 jakarta.servlet.http.HttpSession session)

Subscribe to webpush: this notifies the server that the browser has created a webpush subscription. Requires authorization.

Parameters:

info - Subscription data.

unsubscribe

@PostMapping("/unsubscribe")
public void unsubscribe(@RequestBody
 WebPushSubscription info,
 jakarta.servlet.http.HttpSession session)

Removes subscription information from the server, when browser unsubscribes. Requires authorization.

Parameters:

info -

session -

getKey

@GetMapping("/publicKey")
public String getKey()

Returns public VAPID key required to create WebPush subscription.

Returns:

Base64 encoded key