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 push notifications from a Java server to mobile devices using the Push Notification service in IBM® Bluemix.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	logger
protected static String	pushMessageEndpointURL
protected static String	secret
static String	SYDNEY_REGION
static String	UK_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	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()
protected static String	getEnvironmentVariable(String name)
protected static String	getPushSecretFromVCAP()
static void	init(String bluemixRegion) If your application server is running on Bluemix, and your push notification service is bound to your application, you can use this method for initialization which will get the credentials from Bluemix's environment variables.
static void	init(String tenantId, String pushSecret, String bluemixRegion) Specify the credentials and Bluemix region for your push notification service.
static void	send(org.json.JSONObject notification, PushNotificationsResponseListener listener) Send the given push notification, as configured, to devices using the Push Notification service.
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

logger

public static final Logger logger

secret

protected static String secret

pushMessageEndpointURL

protected static String pushMessageEndpointURL

Constructor Detail

PushNotifications

public PushNotifications()

Method Detail

init

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

Specify the credentials and Bluemix region for your push notification service.

Parameters:

tenantId - the tenant ID for the Bluemix application that the Push Notifications service is bound to

pushSecret - the credential required for Push Notifications service authorization

bluemixRegion - the Bluemix region where the Push Notifications service is hosted, such as US_SOUTH_REGION

init

public static void init(String bluemixRegion)

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

Parameters:

bluemixRegion - the Bluemix region where the Push Notifications service is hosted, such as US_SOUTH_REGION

Throws:

IllegalArgumentException - if either the push application ID or the secret are not found in the environment variables

getApplicationIdFromVCAP

protected static String getApplicationIdFromVCAP()

getEnvironmentVariable

protected static String getEnvironmentVariable(String name)

getPushSecretFromVCAP

protected static String getPushSecretFromVCAP()

send

public static void send(org.json.JSONObject 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 - an optional PushNotificationsResponseListener to listen to the result of this operation

createPushPostRequest

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

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