com.google.api.client.googleapis

Class GoogleHeaders

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.http.HttpHeaders

com.google.api.client.googleapis.GoogleHeaders

All Implemented Interfaces:

Cloneable, Map<String,Object>

Deprecated.

(scheduled to be removed in 1.14) Use HttpHeaders

@Deprecated
public class GoogleHeaders
extends com.google.api.client.http.HttpHeaders

HTTP headers for Google API's.

Implementation is not thread-safe.

Since:

1.0

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.api.client.util.escape.PercentEscaper	SLUG_ESCAPER Deprecated. Escaper for the slug header.

Constructor Summary

Constructors

Constructor and Description
GoogleHeaders() Deprecated. Creates an empty GoogleHeaders object.
GoogleHeaders(com.google.api.client.http.HttpHeaders headers) Deprecated. Creates a GoogleHeaders object using the headers present in the specified HttpHeaders.

Method Summary

Methods

Modifier and Type	Method and Description
String	getGDataClient() Deprecated. Returns the "X-GData-Client" header.
String	getGDataKey() Deprecated. Returns the "X-GData-Key" header, which must be of the form "key=[developerId]" .
String	getGDataVersion() Deprecated. Returns the "GData-Version" header.
static String	getGoogleLoginValue(String authToken) Deprecated. (scheduled to be removed in 1.14) Use ClientLogin.getAuthorizationHeaderValue
String	getMethodOverride() Deprecated. Returns the "X-HTTP-Method-Override" header.
String	getSlug() Deprecated. Returns the escaped "Slug" header value, which must be escaped using SLUG_ESCAPER.
Long	getUploadContentLength() Deprecated. Returns the "X-Upload-Content-Length" header or null for none.
String	getUploadContentType() Deprecated. Returns the "X-Upload-Content-Type" header or null for none.
void	setApplicationName(String applicationName) Deprecated. Sets the "User-Agent" header of the form "[company-id]-[app-name]/[app-version]", for example "Google-Sample/1.0".
void	setDeveloperId(String developerId) Deprecated. Sets the gdataKey header using the given developer ID.
void	setGDataClient(String gdataClient) Deprecated. Sets the "X-GData-Client" header.
void	setGDataKey(String gdataKey) Deprecated. Sets the "X-GData-Key" header, which must be of the form "key=[developerId]".
void	setGDataVersion(String gdataVersion) Deprecated. Sets the "GData-Version" header.
void	setGoogleLogin(String authToken) Deprecated. Sets the Google Login "Authorization" header for the given authentication token.
void	setMethodOverride(String methodOverride) Deprecated. Sets the "X-HTTP-Method-Override" header.
void	setSlug(String slug) Deprecated. Sets the escaped "Slug" header value, which must be escaped using SLUG_ESCAPER.
void	setSlugFromFileName(String fileName) Deprecated. Sets the "Slug" header for the given file name, properly escaping the header value.
void	setUploadContentLength(long uploadContentLength) Deprecated.
void	setUploadContentLength(Long uploadContentLength) Deprecated. Sets the "X-Upload-Content-Length" header or null for none.
void	setUploadContentType(String uploadContentType) Deprecated. Sets the "X-Upload-Content-Type" header or null for none.

Methods inherited from class com.google.api.client.http.HttpHeaders

clone, fromHttpHeaders, fromHttpResponse, getAccept, getAcceptEncoding, getAuthenticate, getAuthorization, getAuthorizationAsList, getCacheControl, getContentEncoding, getContentLength, getContentMD5, getContentRange, getContentType, getCookie, getDate, getETag, getExpires, getFirstHeaderStringValue, getHeaderStringValues, getIfMatch, getIfModifiedSince, getIfNoneMatch, getIfUnmodifiedSince, getLastModified, getLocation, getMimeVersion, getRange, getRetryAfter, getUserAgent, serializeHeadersForMultipartRequests, set, setAccept, setAcceptEncoding, setAuthenticate, setAuthorization, setAuthorization, setBasicAuthentication, setCacheControl, setContentEncoding, setContentLength, setContentMD5, setContentRange, setContentType, setCookie, setDate, setETag, setExpires, setIfMatch, setIfModifiedSince, setIfNoneMatch, setIfUnmodifiedSince, setLastModified, setLocation, setMimeVersion, setRange, setRetryAfter, setUserAgent

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Field Detail

SLUG_ESCAPER

public static final com.google.api.client.util.escape.PercentEscaper SLUG_ESCAPER

Deprecated.

Escaper for the slug header.

Constructor Detail

GoogleHeaders

public GoogleHeaders()

Deprecated.

Creates an empty GoogleHeaders object.

GoogleHeaders

public GoogleHeaders(com.google.api.client.http.HttpHeaders headers)

Deprecated.

Creates a GoogleHeaders object using the headers present in the specified HttpHeaders.

Parameters:

headers - HTTP headers object including set headers

Since:

1.11

Method Detail

setSlugFromFileName

public void setSlugFromFileName(String fileName)

Deprecated.

Sets the "Slug" header for the given file name, properly escaping the header value. See The Slug Header.

setApplicationName

public void setApplicationName(String applicationName)

Deprecated.

Sets the "User-Agent" header of the form "[company-id]-[app-name]/[app-version]", for example "Google-Sample/1.0".

setDeveloperId

public void setDeveloperId(String developerId)

Deprecated.

Sets the gdataKey header using the given developer ID.

setGoogleLogin

public void setGoogleLogin(String authToken)

Deprecated.

Sets the Google Login "Authorization" header for the given authentication token.

getUploadContentLength

public final Long getUploadContentLength()

Deprecated.

Returns the "X-Upload-Content-Length" header or null for none.

Upgrade warning: this method now returns a Long. In prior version 1.11 it returned a long.

Since:

1.7

setUploadContentLength

public final void setUploadContentLength(Long uploadContentLength)

Deprecated.

Sets the "X-Upload-Content-Length" header or null for none.

Since:

1.12

setUploadContentLength

@Deprecated
public final void setUploadContentLength(long uploadContentLength)

Deprecated.

Sets the "X-Upload-Content-Length" header.

Since:

1.7

getUploadContentType

public final String getUploadContentType()

Deprecated.

Returns the "X-Upload-Content-Type" header or null for none.

Since:

1.7

setUploadContentType

public final void setUploadContentType(String uploadContentType)

Deprecated.

Sets the "X-Upload-Content-Type" header or null for none.

Since:

1.7

getGoogleLoginValue

@Deprecated
public static String getGoogleLoginValue(String authToken)

Deprecated. (scheduled to be removed in 1.14) Use ClientLogin.getAuthorizationHeaderValue

Returns Google Login "Authorization" header value based on the given authentication token.

getGDataVersion

public final String getGDataVersion()

Deprecated.

Returns the "GData-Version" header.

Since:

1.8

setGDataVersion

public final void setGDataVersion(String gdataVersion)

Deprecated.

Sets the "GData-Version" header.

Since:

1.8

getSlug

public final String getSlug()

Deprecated.

Returns the escaped "Slug" header value, which must be escaped using SLUG_ESCAPER.

Since:

1.8

setSlug

public final void setSlug(String slug)

Deprecated.

Sets the escaped "Slug" header value, which must be escaped using SLUG_ESCAPER.

Since:

1.8

getGDataClient

public final String getGDataClient()

Deprecated.

Returns the "X-GData-Client" header.

Since:

1.8

setGDataClient

public final void setGDataClient(String gdataClient)

Deprecated.

Sets the "X-GData-Client" header.

Since:

1.8

getGDataKey

public final String getGDataKey()

Deprecated.

Returns the "X-GData-Key" header, which must be of the form "key=[developerId]" .

Since:

1.8

setGDataKey

public final void setGDataKey(String gdataKey)

Deprecated.

Sets the "X-GData-Key" header, which must be of the form "key=[developerId]".

Since:

1.8

getMethodOverride

public final String getMethodOverride()

Deprecated.

Returns the "X-HTTP-Method-Override" header.

Since:

1.8

setMethodOverride

public final void setMethodOverride(String methodOverride)

Deprecated.

Sets the "X-HTTP-Method-Override" header.

Since:

1.8