com.google.api.client.googleapis.subscriptions

Class TypedNotificationCallback<T>

java.lang.Object

com.google.api.client.googleapis.subscriptions.TypedNotificationCallback<T>

Type Parameters:

T - Type of the data contained within a notification

All Implemented Interfaces:

NotificationCallback, Serializable

Direct Known Subclasses:

JsonNotificationCallback

public abstract class TypedNotificationCallback<T>
extends Object
implements NotificationCallback

Callback which is used to receive typed Notifications after subscribing to a topic.

Must not be implemented in form of an anonymous class as this will break serialization.

Implementation should be thread-safe.

State will only be persisted once when a subscription is created. All state changes occurring during the .handleNotification(..) call will be lost.

Example usage:

    class MyTypedNotificationCallback extends TypedNotificationCallback<ItemList> {
      void handleNotification(
          Subscription subscription, TypedNotification<ItemList> notification) {
        for (Item item in notification.getContent().getItems()) {
          System.out.println(item.getId());
        }
      }
    }

    ObjectParser getParser(UnparsedNotification notification) {
      return new JacksonFactory().createJsonObjectParser();
    }

    ...

    service.items.list("someID").subscribe(new MyTypedNotificationCallback()).execute()
 

Since:

1.14

Author:

Matthias Linder (mlinder)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypedNotificationCallback()

Method Summary

Methods

Modifier and Type	Method and Description
Class<T>	getDataClass() Returns the data type which this handler can parse or Void.class if no data type is expected.
protected abstract com.google.api.client.util.ObjectParser	getParser(UnparsedNotification notification) Returns an ObjectParser which can be used to parse this notification.
protected abstract void	handleNotification(StoredSubscription subscription, TypedNotification<T> notification) Handles a received push notification.
void	handleNotification(StoredSubscription subscription, UnparsedNotification notification) Handles a received push notification.
TypedNotificationCallback<T>	setDataType(Class<T> dataClass) Sets the data type which this handler can parse or Void.class if no data type is expected.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedNotificationCallback

public TypedNotificationCallback()

Method Detail

getDataClass

public final Class<T> getDataClass()

Returns the data type which this handler can parse or Void.class if no data type is expected.

setDataType

public TypedNotificationCallback<T> setDataType(Class<T> dataClass)

Sets the data type which this handler can parse or Void.class if no data type is expected.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

handleNotification

protected abstract void handleNotification(StoredSubscription subscription,
                      TypedNotification<T> notification)
                                    throws IOException

Handles a received push notification.

Parameters:

subscription - Subscription to which this notification belongs

notification - Typed notification which was delivered to this application

Throws:

IOException

getParser

protected abstract com.google.api.client.util.ObjectParser getParser(UnparsedNotification notification)
                                                              throws IOException

Returns an ObjectParser which can be used to parse this notification.

Parameters:

notification - Notification which should be parsable by the returned parser

Throws:

IOException

handleNotification

public void handleNotification(StoredSubscription subscription,
                      UnparsedNotification notification)
                        throws IOException

Description copied from interface: NotificationCallback

Handles a received push notification.

Specified by:

handleNotification in interface NotificationCallback

Parameters:

subscription - Subscription to which this notification belongs

notification - Notification which was delivered to this application

Throws:

IOException