com.google.api.client.googleapis

Class MethodOverride

java.lang.Object

com.google.api.client.googleapis.MethodOverride

All Implemented Interfaces:

HttpExecuteInterceptor, HttpRequestInitializer

public final class MethodOverride
extends Object
implements HttpExecuteInterceptor, HttpRequestInitializer

Thread-safe HTTP request execute interceptor for Google API's that wraps HTTP requests inside of a POST request and uses HEADER header to specify the actual HTTP method.

Use this for example for an HTTP transport that doesn't support PATCH like NetHttpTransport or UrlFetchTransport. By default, only the methods not supported by the transport will be overridden. When running behind a firewall that does not support certain verbs like PATCH, use the MethodOverride.Builder.setOverrideAllMethods(boolean) constructor instead to specify to override all methods. POST is never overridden.

This class also allows GET requests with a long URL (> 2048 chars) to be instead sent using method override as a POST request.

Sample usage, taking advantage that this class implements HttpRequestInitializer:

 public static HttpRequestFactory createRequestFactory(HttpTransport transport) {
   return transport.createRequestFactory(new MethodOverride());
 }
 

If you have a custom request initializer, take a look at the sample usage for HttpExecuteInterceptor, which this class also implements.

Since:

1.4

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MethodOverride.Builder Builder for MethodOverride.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER Name of the method override header.

Constructor Summary

Constructors

Constructor and Description
MethodOverride() Only overrides HTTP methods that the HTTP transport does not support.

Method Summary

Modifier and Type	Method and Description
void	initialize(HttpRequest request)
void	intercept(HttpRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

public static final String HEADER

Name of the method override header.

Since:

1.13

See Also:

Constant Field Values

Constructor Detail

MethodOverride

public MethodOverride()

Only overrides HTTP methods that the HTTP transport does not support.

Method Detail

initialize

public void initialize(HttpRequest request)

Specified by:

initialize in interface HttpRequestInitializer

intercept

public void intercept(HttpRequest request)
               throws IOException

Specified by:

intercept in interface HttpExecuteInterceptor

Throws:

IOException