com.google.api.client.googleapis.subscriptions

Class SubscriptionHeaders

java.lang.Object

com.google.api.client.googleapis.subscriptions.SubscriptionHeaders

public final class SubscriptionHeaders
extends Object

Headers for subscribe request and response.

Since:

1.14

Author:

Matthias Linder (mlinder)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_TOKEN Name of header for the client token (an opaque string) provided by the client in the subscribe request and returned in the subscribe response.
static String	SUBSCRIBE Name of header for the notifications delivery method in the subscribe request.
static String	SUBSCRIPTION_EXPIRES Name of header for the HTTP Date indicating the time at which the subscription will expire returned in the subscribe response or if not returned for an infinite TTL.
static String	SUBSCRIPTION_ID Name of header for the subscription UUID provided by the client in the subscribe request and returned in the subscribe response.
static String	TOPIC_ID Name of header for the opaque ID for the subscribed resource that is stable across API versions returned in the subscribe response.
static String	TOPIC_URI Name of header for the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version returned in the subscribe response.

Method Summary

Methods

Modifier and Type	Method and Description
static String	getClientToken(com.google.api.client.http.HttpHeaders headers) Returns the client token (an opaque string) provided by the client in the subscribe request and returned in the subscribe response or null for none.
static String	getSubscribe(com.google.api.client.http.HttpHeaders headers) Returns the notifications delivery method in the subscribe request or null for none.
static String	getSubscriptionExpires(com.google.api.client.http.HttpHeaders headers) Returns the HTTP Date indicating the time at which the subscription will expire returned in the subscribe response or null for an infinite TTL.
static String	getSubscriptionId(com.google.api.client.http.HttpHeaders headers) Returns the subscription UUID provided by the client in the subscribe request and returned in the subscribe response or null for none.
static String	getTopicId(com.google.api.client.http.HttpHeaders headers) Returns the opaque ID for the subscribed resource that is stable across API versions returned in the subscribe response or null for none.
static String	getTopicUri(com.google.api.client.http.HttpHeaders headers) Returns the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version returned in the subscribe response or null for none.
static void	setClientToken(com.google.api.client.http.HttpHeaders headers, String clienToken) Sets the client token (an opaque string) provided by the client in the subscribe request and returned in the subscribe response or null for none.
static void	setSubscribe(com.google.api.client.http.HttpHeaders headers, String subscribe) Sets the notifications delivery method in the subscribe request or null for none.
static void	setSubscriptionExpires(com.google.api.client.http.HttpHeaders headers, String subscriptionExpires) Sets the HTTP Date indicating the time at which the subscription will expire returned in the subscribe response or null for an infinite TTL.
static void	setSubscriptionId(com.google.api.client.http.HttpHeaders headers, String subscriptionId) Sets the subscription UUID provided by the client in the subscribe request and returned in the subscribe response or null for none.
static void	setTopicId(com.google.api.client.http.HttpHeaders headers, String topicId) Sets the opaque ID for the subscribed resource that is stable across API versions returned in the subscribe response or null for none.
static void	setTopicUri(com.google.api.client.http.HttpHeaders headers, String topicUri) Sets the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version returned in the subscribe response or null for none.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_TOKEN

public static final String CLIENT_TOKEN

Name of header for the client token (an opaque string) provided by the client in the subscribe request and returned in the subscribe response.

See Also:

Constant Field Values

SUBSCRIBE

public static final String SUBSCRIBE

Name of header for the notifications delivery method in the subscribe request.

See Also:

Constant Field Values

SUBSCRIPTION_EXPIRES

public static final String SUBSCRIPTION_EXPIRES

Name of header for the HTTP Date indicating the time at which the subscription will expire returned in the subscribe response or if not returned for an infinite TTL.

See Also:

Constant Field Values

SUBSCRIPTION_ID

public static final String SUBSCRIPTION_ID

Name of header for the subscription UUID provided by the client in the subscribe request and returned in the subscribe response.

See Also:

Constant Field Values

TOPIC_ID

public static final String TOPIC_ID

Name of header for the opaque ID for the subscribed resource that is stable across API versions returned in the subscribe response.

See Also:

Constant Field Values

TOPIC_URI

public static final String TOPIC_URI

Name of header for the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version returned in the subscribe response.

See Also:

Constant Field Values

Method Detail

getClientToken

public static String getClientToken(com.google.api.client.http.HttpHeaders headers)

Returns the client token (an opaque string) provided by the client in the subscribe request and returned in the subscribe response or null for none.

setClientToken

public static void setClientToken(com.google.api.client.http.HttpHeaders headers,
                  String clienToken)

Sets the client token (an opaque string) provided by the client in the subscribe request and returned in the subscribe response or null for none.

getSubscribe

public static String getSubscribe(com.google.api.client.http.HttpHeaders headers)

Returns the notifications delivery method in the subscribe request or null for none.

Parameters:

headers - HTTP headers

setSubscribe

public static void setSubscribe(com.google.api.client.http.HttpHeaders headers,
                String subscribe)

Sets the notifications delivery method in the subscribe request or null for none.

getSubscriptionExpires

public static String getSubscriptionExpires(com.google.api.client.http.HttpHeaders headers)

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

setSubscriptionExpires

public static void setSubscriptionExpires(com.google.api.client.http.HttpHeaders headers,
                          String subscriptionExpires)

Sets the HTTP Date indicating the time at which the subscription will expire returned in the subscribe response or null for an infinite TTL.

getSubscriptionId

public static String getSubscriptionId(com.google.api.client.http.HttpHeaders headers)

Returns the subscription UUID provided by the client in the subscribe request and returned in the subscribe response or null for none.

setSubscriptionId

public static void setSubscriptionId(com.google.api.client.http.HttpHeaders headers,
                     String subscriptionId)

Sets the subscription UUID provided by the client in the subscribe request and returned in the subscribe response or null for none.

getTopicId

public static String getTopicId(com.google.api.client.http.HttpHeaders headers)

Returns the opaque ID for the subscribed resource that is stable across API versions returned in the subscribe response or null for none.

setTopicId

public static void setTopicId(com.google.api.client.http.HttpHeaders headers,
              String topicId)

Sets the opaque ID for the subscribed resource that is stable across API versions returned in the subscribe response or null for none.

getTopicUri

public static String getTopicUri(com.google.api.client.http.HttpHeaders headers)

Returns the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version returned in the subscribe response or null for none.

setTopicUri

public static void setTopicUri(com.google.api.client.http.HttpHeaders headers,
               String topicUri)

Sets the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version returned in the subscribe response or null for none.