com.google.api.client.googleapis.subscriptions

Class UnparsedNotification

java.lang.Object

com.google.api.client.googleapis.subscriptions.Notification

com.google.api.client.googleapis.subscriptions.UnparsedNotification

@Beta
public final class UnparsedNotification
extends Notification

Beta
A notification whose content has not been parsed yet.

Thread-safe implementation.

Example usage:

    void handleNotification(Subscription subscription, UnparsedNotification notification)
        throws IOException {
      BufferedReader reader = new BufferedReader(new InputStreamReader(notification.getContent()));
      System.out.println(reader.readLine());
      reader.close();
    }
 

Since:

1.14

Author:

Matthias Linder (mlinder)

Constructor Summary

Constructors

Constructor and Description
UnparsedNotification(String subscriptionId, String topicId, String topicURI, String clientToken, long messageNumber, String eventType, String changeType, String contentType, InputStream unparsedStream) Creates a Notification whose content has not yet been read and parsed.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deliverNotification(SubscriptionStore subscriptionStore) Handles a newly received notification, and delegates it to the registered handler.
InputStream	getContent() Returns the content stream of this notification.
String	getContentType() Returns the Content-Type of the Content of this notification.

Methods inherited from class com.google.api.client.googleapis.subscriptions.Notification

getChangeType, getClientToken, getEventType, getMessageNumber, getSubscriptionId, getTopicId, getTopicURI

Methods inherited from class java.lang.Object

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

Constructor Detail

UnparsedNotification

public UnparsedNotification(String subscriptionId,
                    String topicId,
                    String topicURI,
                    String clientToken,
                    long messageNumber,
                    String eventType,
                    String changeType,
                    String contentType,
                    InputStream unparsedStream)

Creates a Notification whose content has not yet been read and parsed.

Parameters:

subscriptionId - subscription UUID

topicId - opaque ID for the subscribed resource that is stable across API versions

topicURI - opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version

clientToken - client token (an opaque string) or null for none

messageNumber - message number (a monotonically increasing value starting with 1)

eventType - event type (see EventTypes)

changeType - type of change performed on the resource or null for none

unparsedStream - Unparsed content in form of a InputStream. Caller has the responsibility of closing the stream.

Method Detail

getContentType

public final String getContentType()

Returns the Content-Type of the Content of this notification.

getContent

public final InputStream getContent()

Returns the content stream of this notification.

deliverNotification

public boolean deliverNotification(SubscriptionStore subscriptionStore)
                            throws IOException

Handles a newly received notification, and delegates it to the registered handler.

Parameters:

subscriptionStore - subscription store

Returns:

true if the notification was delivered successfully, or false if this notification could not be delivered and the subscription should be cancelled.

Throws:

IllegalArgumentException - if there is a client-token mismatch

IOException