com.ibm.mobilefirstplatform.serversdk.java.push

Class PushNotifications

java.lang.Object

com.ibm.mobilefirstplatform.serversdk.java.push.PushNotifications

public class PushNotifications
extends Object

This class is used to send notifications from a Java server to mobile devices using the Push Notification service.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	accessToken
protected static long	apiKeyExpireyTime
protected static String	apiKeyIdIs
static String	FRANKFURT_REGION
static String	JP_TOK
static Logger	logger
static String	overrideServerHost Overrides default server host with the provided host.
protected static String	pushMessageEndpointURL
protected static String	secret
static String	SYDNEY_REGION
static String	UK_REGION
static String	US_EAST_REGION
static String	US_SOUTH_REGION

Constructor Summary

Constructors

Constructor and Description
PushNotifications()

Method Summary

Modifier and Type	Method and Description
protected static org.apache.http.client.methods.HttpPost	createBulkPushPostRequest(List<org.json.JSONObject> messageJson)
protected static org.apache.http.client.methods.HttpPost	createPushPostRequest(org.json.JSONObject notification)
protected static void	executePushPostRequest(org.apache.http.client.methods.HttpPost pushPost, org.apache.http.impl.client.CloseableHttpClient httpClient, PushNotificationsResponseListener listener)
protected static String	getApplicationIdFromVCAP()
static org.apache.http.client.methods.CloseableHttpResponse	getAuthToken()
protected static String	getEnvironmentVariable(String name)
protected static String	getPushApiKeyFromVCAP()
protected static String	getPushSecretFromVCAP()
static void	init(String ibmCloudRegion) If your application server is running on IBM Cloud, and your push notification service is bound to your application, you can use this method for initialization which will get the credentials from IBM Cloud's environment variables.
static void	init(String tenantId, String pushSecret, String ibmCloudRegion) Specify the credentials and IBM Cloud region for your push notification service.
static void	initWithApiKey(String tenantId, String apiKeyId, String ibmCloudRegionn)
static void	send(Notification notification, PushNotificationsResponseListener listener) Send the given push notification, as configured, to devices using the Push Notification service.
static void	sendBulk(Notification[] notifications, PushNotificationsResponseListener listener)
protected static void	sendResponseToListener(org.apache.http.client.methods.CloseableHttpResponse response, PushNotificationsResponseListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

US_SOUTH_REGION

public static final String US_SOUTH_REGION

See Also:

Constant Field Values

UK_REGION

public static final String UK_REGION

See Also:

Constant Field Values

SYDNEY_REGION

public static final String SYDNEY_REGION

See Also:

Constant Field Values

FRANKFURT_REGION

public static final String FRANKFURT_REGION

See Also:

Constant Field Values

US_EAST_REGION

public static final String US_EAST_REGION

See Also:

Constant Field Values

JP_TOK

public static final String JP_TOK

See Also:

Constant Field Values

logger

public static final Logger logger

secret

protected static String secret

apiKeyIdIs

protected static String apiKeyIdIs

apiKeyExpireyTime

protected static long apiKeyExpireyTime

accessToken

protected static String accessToken

pushMessageEndpointURL

protected static String pushMessageEndpointURL

overrideServerHost

public static String overrideServerHost

Overrides default server host with the provided host. It overrideServerHost can be used for dedicated service and overrides default host with dedicated service host.

Constructor Detail

PushNotifications

public PushNotifications()

Method Detail

init

public static void init(String tenantId,
                        String pushSecret,
                        String ibmCloudRegion)

Specify the credentials and IBM Cloud region for your push notification service. Also if you are using dedicated service, use overrideServerHost.

Parameters:

tenantId - The tenant ID for the IBM Cloud application that the Push Notifications service is bound to.

pushSecret - The credential required for Push Notifications service authorization.

ibmCloudRegion - The IBM Cloud region where the Push Notifications service is hosted. For example, US_SOUTH_REGION.

init

public static void init(String ibmCloudRegion)

If your application server is running on IBM Cloud, and your push notification service is bound to your application, you can use this method for initialization which will get the credentials from IBM Cloud's environment variables.

Parameters:

ibmCloudRegion - The IBM Cloud region where the Push Notifications service is hosted. For example, US_SOUTH_REGION.

Throws:

IllegalArgumentException - If either the push application ID or the secret is not found in the environment variables.

initWithApiKey

public static void initWithApiKey(String tenantId,
                                  String apiKeyId,
                                  String ibmCloudRegionn)

getAuthToken

public static org.apache.http.client.methods.CloseableHttpResponse getAuthToken()

getApplicationIdFromVCAP

protected static String getApplicationIdFromVCAP()

getEnvironmentVariable

protected static String getEnvironmentVariable(String name)

getPushSecretFromVCAP

protected static String getPushSecretFromVCAP()

getPushApiKeyFromVCAP

protected static String getPushApiKeyFromVCAP()

send

public static void send(Notification notification,
                        PushNotificationsResponseListener listener)

Send the given push notification, as configured, to devices using the Push Notification service.

Parameters:

notification - The push notification to be sent.

listener - Optional PushNotificationsResponseListener to listen to the result of this operation.

sendBulk

public static void sendBulk(Notification[] notifications,
                            PushNotificationsResponseListener listener)

createPushPostRequest

protected static org.apache.http.client.methods.HttpPost createPushPostRequest(org.json.JSONObject notification)

createBulkPushPostRequest

protected static org.apache.http.client.methods.HttpPost createBulkPushPostRequest(List<org.json.JSONObject> messageJson)

executePushPostRequest

protected static void executePushPostRequest(org.apache.http.client.methods.HttpPost pushPost,
                                             org.apache.http.impl.client.CloseableHttpClient httpClient,
                                             PushNotificationsResponseListener listener)

sendResponseToListener

protected static void sendResponseToListener(org.apache.http.client.methods.CloseableHttpResponse response,
                                             PushNotificationsResponseListener listener)
                                      throws IOException

Throws:

IOException