com.google.api.client.googleapis.subscriptions

Class Subscription

java.lang.Object

com.google.api.client.googleapis.subscriptions.Subscription

All Implemented Interfaces:

Serializable

public final class Subscription
extends Object
implements Serializable

Client subscription information after the subscription has been created.

Should be stored in a SubscriptionStore. Implementation is thread safe.

Since:

1.14

Author:

Matthias Linder (mlinder)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Subscription(NotificationCallback handler, String clientToken, String subscriptionId) Constructor to be called before making the subscribe request.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getClientToken() Returns the Opaque string provided by the client or null for none.
NotificationCallback	getNotificationCallback() Returns the notification callback called when a notification is received for this subscription.
String	getSubscriptionExpires() Returns the HTTP Date indicating the time at which the subscription will expire or null for an infinite TTL.
String	getSubscriptionId() Returns the subscription UUID.
String	getTopicId() Returns the opaque ID for the subscribed resource that is stable across API versions.
int	hashCode()
Subscription	processResponse(String subscriptionExpires, String topicId) Process subscribe response.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Subscription

public Subscription(NotificationCallback handler,
            String clientToken,
            String subscriptionId)

Constructor to be called before making the subscribe request.

Parameters:

handler - notification handler called when a notification is received for this subscription

clientToken - opaque string provided by the client or null for none

subscriptionId - subscription UUID

Method Detail

processResponse

public Subscription processResponse(String subscriptionExpires,
                           String topicId)

Process subscribe response.

Parameters:

subscriptionExpires - HTTP Date indicating the time at which the subscription will expire or null for an infinite TTL

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

getNotificationCallback

public NotificationCallback getNotificationCallback()

Returns the notification callback called when a notification is received for this subscription.

getClientToken

public String getClientToken()

Returns the Opaque string provided by the client or null for none.

getSubscriptionExpires

public String getSubscriptionExpires()

Returns the HTTP Date indicating the time at which the subscription will expire or null for an infinite TTL.

getSubscriptionId

public String getSubscriptionId()

Returns the subscription UUID.

getTopicId

public String getTopicId()

Returns the opaque ID for the subscribed resource that is stable across API versions.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object