io.getlime.push.client

Class PushServerClient

java.lang.Object

io.getlime.push.client.PushServerClient

public class PushServerClient
extends Object

Simple class for interacting with the push server.

Author:

Petr Dvorak, petr@lime-company.eu

Constructor Summary

Constructors

Constructor and Description
PushServerClient() Default constructor.
PushServerClient(String serviceBaseUrl) Constructor with a push server base URL.

Method Summary

Modifier and Type	Method and Description
boolean	registerDevice(Long appId, String token, MobilePlatform platform) Register anonymous device to the push server.
boolean	registerDevice(Long appId, String token, MobilePlatform platform, String activationId) Register device associated with activation ID to the push server.
io.getlime.core.rest.model.base.response.ObjectResponse<PushSendResult>	sendNotification(Long appId, PushMessage pushMessage) Send a single push message to application with given ID.
io.getlime.core.rest.model.base.response.ObjectResponse<PushSendResult>	sendNotificationBatch(Long appId, List<PushMessage> batch) Send a push message batch to application with given ID.
void	setServiceBaseUrl(String serviceBaseUrl) Set the service base URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushServerClient

public PushServerClient()

Default constructor.

PushServerClient

public PushServerClient(String serviceBaseUrl)

Constructor with a push server base URL.

Parameters:

serviceBaseUrl - URL pointing to the running push server instance, for example "http://localhost:8080/powerauth-push-server".

Method Detail

setServiceBaseUrl

public void setServiceBaseUrl(String serviceBaseUrl)

Set the service base URL.

Parameters:

serviceBaseUrl - Base URL.

registerDevice

public boolean registerDevice(Long appId,
                              String token,
                              MobilePlatform platform)
                       throws PushServerClientException

Register anonymous device to the push server.

Parameters:

appId - PowerAuth 2.0 application app ID.

token - Token received from the push service provider (APNs, FCM).

platform - Mobile platform (iOS, Android).

Returns:

True if device registration was successful, false otherwise.

Throws:

PushServerClientException

registerDevice

public boolean registerDevice(Long appId,
                              String token,
                              MobilePlatform platform,
                              String activationId)
                       throws PushServerClientException

Register device associated with activation ID to the push server.

Parameters:

appId - PowerAuth 2.0 application app ID.

token - Token received from the push service provider (APNs, FCM).

platform - Mobile platform (iOS, Android).

activationId - PowerAuth 2.0 activation ID.

Returns:

True if device registration was successful, false otherwise.

Throws:

PushServerClientException

sendNotification

public io.getlime.core.rest.model.base.response.ObjectResponse<PushSendResult> sendNotification(Long appId,
                                                                                                PushMessage pushMessage)
                                                                                         throws PushServerClientException

Send a single push message to application with given ID.

Parameters:

appId - PowerAuth 2.0 application app ID.

pushMessage - Push message to be sent.

Returns:

SendMessageResponse in case everything went OK, ErrorResponse in case of an error.

Throws:

PushServerClientException

sendNotificationBatch

public io.getlime.core.rest.model.base.response.ObjectResponse<PushSendResult> sendNotificationBatch(Long appId,
                                                                                                     List<PushMessage> batch)
                                                                                              throws PushServerClientException

Send a push message batch to application with given ID.

Parameters:

appId - PowerAuth 2.0 application app ID.

batch - Push message batch to be sent.

Returns:

SendMessageResponse in case everything went OK, ErrorResponse in case of an error.

Throws:

PushServerClientException