Topic Based Messaging

/**
 * Request that ADM registers your security profile with TopicBasedMessaging.
 */
public void tbmRegistration(String clientSecret, String accessToken) throws Exception
{
    // JSON payload representation of the message.
    JSONObject payload = new JSONObject();

    // Add clientSecret value which is used to create the accessToken provided in the header.
    payload.put("clientSecret", clientSecret);


    // Convert the message from a JSON object to a string.
    String payloadString = payload.toString();

    // Establish the base URL.
    String admUrlTemplate = "https://api.amazon.com/v1/messaging/topic/registrations";

    URL admUrl = new URL(admUrlTemplate);

    // Generate the HTTPS connection for the POST request. You cannot make a connection
    // over HTTP.
    HttpsURLConnection conn = (HttpsURLConnection) admUrl.openConnection();
    conn.setRequestMethod("POST");
    conn.setDoOutput(true);

    // Set the content type and accept headers.
    conn.setRequestProperty("content-type", "application/json");
    conn.setRequestProperty("accept", "application/json");
    
    // Add the authorization token as a header.
    conn.setRequestProperty("Authorization", "Bearer " + accessToken);

    // Obtain the output stream for the connection and write the message payload to it.
    OutputStream os = conn.getOutputStream();
    os.write(payloadString.getBytes(), 0, payloadString.getBytes().length);
    os.flush();
    conn.connect();

    // Obtain the response code from the connection.
    int responseCode = conn.getResponseCode();

    // Check if we received a failure response, and if so, get the reason for the failure.
    if( responseCode != 200)
    {
        if( responseCode == 401 )
        {
            // If a 401 response code was received, the access token has expired. The token should be refreshed
            // and this request can be retried.
        }

        String errorContent = parseResponse(conn.getErrorStream());
        throw new RuntimeException(String.format("ERROR: The request to register the security profile with TBM has failed with a " +
                                         "%d response code, with the following message: %s",
                                         responseCode, errorContent));
    }
    else
    {
        // The request was successful. The response contains the security profile which is registered to TopicBasedMessaging.
        String responseContent = parseResponse(conn.getInputStream());
        JSONObject parsedObject = new JSONObject(responseContent);

        String message = parsedObject.getString("message");
        
        // You can extract the security profile from the message to verify if it's the same as the one used to
        // create the accessToken used in the request header.
        
    }

}

private String parseResponse(InputStream in) throws Exception
{
    // Read from the input stream and convert into a String.
    InputStreamReader inputStream = new InputStreamReader(in);
    BufferedReader buff = new BufferedReader(inputStream);

    StringBuilder sb = new StringBuilder();
    String line = buff.readLine();
    while(line != null)
   {
      sb.append(line);
      line = buff.readLine();
    }

    return sb.toString();
}

final ADM adm = new ADM(this);
// subscribeToTopic() is asynchronous; your app will be notified via
// onSubscribe() callback if subscribeToTopic() succeeds.
// onSubscribeError() callback if subscribeToTopic() fails.
adm.subscribeToTopic("weather");

final ADM adm = new ADM(this);
// unsubscribeFromTopic() is asynchronous; your app will be notified via
// onUnsubscribe() callback if unsubscribeFromTopic() succeeds.
// onUnsubscribeError() callback if unsubscribeFromTopic() fails.
adm.unsubscribeFromTopic("weather");

try {
    Log.d(TAG, "subscribeToTopic: Trying to subscribe to topic: " + topic);
    adm.subscribeToTopic(topic);
} catch (Error e) {
    Log.d(TAG, "subscribeToTopic: Error Caught and Error Message is " + e.getMessage());
}

public class MyADMMessageHandler extends ADMMessageHandlerJobBase{
    @Override
    protected void onSubscribe(final Context context, final String topic) {
        // Write your logic here for successful subcription like
        // notifying customer
        // sending the details to your server
    }

    @Override
    protected void onSubscribeError(final Context context, final String topic, final String errorId) {
        // Write your logic here for subscription error based on error Id
    }

    @Override
    protected void onUnsubscribe(final Context context, final String topic) {
        // Write your logic here for successful unsubscription like
        // notifying customer
        // sending the details to your server
    }

    @Override
    protected void onUnsubscribeError(final Context context, final String topic, final String errorId) {
        // Write your logic here for unsubscription error based on error Id
    }

}

/**
 * Request that ADM delivers your message to a specific instances of your app which are subscribed to the given topic.
 */
public void sendMessageToTopic(String topic, String accessToken) throws Exception
{
    // JSON payload representation of the message.
    JSONObject payload = new JSONObject();

    // Define the key/value pairs for your data message content and add them to the
    // message payload.
    JSONObject data = new JSONObject();
    data.put("firstKey", "firstValue");
    data.put("secondKey", "secondValue");
    payload.put("data", data);
    
    // Define the key/value pairs for your notification message content and add them to the
    // message payload.
    // Notification message only accepts a pre-defined key-value pairs.
    // The key-value pairs supported by ADM notifications can be found from the documentation
    // (https://developer.amazon.com/docs/adm/message-types.html#notification).
    JSONObject notification = new JSONObject();
    notification.put("title", "ADM Message Notification");
    notification.put("body", "We have a new offer for you!");
    payload.put("notification", notification);

    // Add a consolidation key. If multiple messages are pending delivery for a particular
    // app instance with the same consolidation key, ADM will attempt to delivery the most
    // recently added item.
    payload.put("consolidationKey", "ADM_Enqueue_Sample");

    // Add an expires-after value to the message of 1 day. If the targeted app instance does not
    // come online within the expires-after window, the message will not be delivered.
    payload.put("expiresAfter", 86400);

    // Add priority to the message. The value of priority determines whether the message will be
    // delivered when the device is in doze/idle mode.
    payload.put("priority", "high");
    
    // Add a topic to the message body, using which the message is to be delivered to the app instances.
    payload.put("topic", topic);


    // Convert the message from a JSON object to a string.
    String payloadString = payload.toString();

    // Establish the base URL
    String admUrlTemplate = "https://api.amazon.com/v1/messaging/topic/messages";

    URL admUrl = new URL(admUrlTemplate);

    // Generate the HTTPS connection for the POST request. You cannot make a connection
    // over HTTP.
    HttpsURLConnection conn = (HttpsURLConnection) admUrl.openConnection();
    conn.setRequestMethod("POST");
    conn.setDoOutput(true);

    // Set the content type and accept headers.
    conn.setRequestProperty("content-type", "application/json");
    conn.setRequestProperty("accept", "application/json");
    conn.setRequestProperty("X-Amzn-Type-Version", "com.amazon.device.messaging.ADMMessage@1.0");
    conn.setRequestProperty("X-Amzn-Accept-Type", "com.amazon.device.messaging.ADMSendResult@1.0");

    // Add the authorization token as a header.
    conn.setRequestProperty("Authorization", "Bearer " + accessToken);

    // Obtain the output stream for the connection and write the message payload to it.
    OutputStream os = conn.getOutputStream();
    os.write(payloadString.getBytes(), 0, payloadString.getBytes().length);
    os.flush();
    conn.connect();

    // Obtain the response code from the connection.
    int responseCode = conn.getResponseCode();

    // Check if we received a failure response, and if so, get the reason for the failure.
    if( responseCode != 200)
    {
        if( responseCode == 401 )
        {
            // If a 401 response code was received, the access token has expired. The token should be refreshed
            // and this request can be retried.
        }

        String errorContent = parseResponse(conn.getErrorStream());
        throw new RuntimeException(String.format("ERROR: The send message to the topic %s request failed with a " +
                                         "%d response code, with the following message: %s",
                                         topic, responseCode, errorContent));
    }
    else
    {
        // The request was successful. The response contains the messageId 
        // which is associated with the message sent and the topic to which it is sent to.

        String responseContent = parseResponse(conn.getInputStream());
        JSONObject parsedObject = new JSONObject(responseContent);

        String messageId = parsedObject.getString("messageId");
        // The messageId can be communicated with ADM to troubleshoot the issues in case the message is
        // not delivered to any of the app instances.
}

private String parseResponse(InputStream in) throws Exception
{
    // Read from the input stream and convert into a String.
    InputStreamReader inputStream = new InputStreamReader(in);
    BufferedReader buff = new BufferedReader(inputStream);

    StringBuilder sb = new StringBuilder();
    String line = buff.readLine();
    while(line != null)
   {
      sb.append(line);
      line = buff.readLine();
    }

    return sb.toString();
}