com.google.api.client.googleapis.services.protobuf

Class CommonGoogleProtoClientRequestInitializer

java.lang.Object

com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

com.google.api.client.googleapis.services.protobuf.CommonGoogleProtoClientRequestInitializer

All Implemented Interfaces:

GoogleClientRequestInitializer

@Beta
public class CommonGoogleProtoClientRequestInitializer
extends CommonGoogleClientRequestInitializer

Beta
Google protocol buffer client request initializer implementation for setting properties like key and userIp.

The simplest usage is to use it to set the key parameter:

  public static final GoogleClientRequestInitializer KEY_INITIALIZER =
      new CommonGoogleProtoClientRequestInitializer(KEY);
 

There is also a constructor to set both the key and userIp parameters:

  public static final GoogleClientRequestInitializer INITIALIZER =
      new CommonGoogleProtoClientRequestInitializer(KEY, USER_IP);
 

If you want to implement custom logic, extend it like this:

  public static class MyRequestInitializer extends CommonGoogleProtoClientRequestInitializer {

     @Override
    public void initialize(AbstractGoogleProtoClientRequest <? > request)
        throws IOException {
      // custom logic
    }
  }
 

Finally, to set the key and userIp parameters and insert custom logic, extend it like this:

  public static class MyKeyRequestInitializer extends CommonGoogleProtoClientRequestInitializer {

    public MyKeyRequestInitializer() {
      super(KEY, USER_IP);
    }

     @Override
    public void initializeProtoRequest(
        AbstractGoogleProtoClientRequest <? > request) throws IOException {
      // custom logic
    }
  }
 

Subclasses should be thread-safe.

Since:

1.16

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

CommonGoogleClientRequestInitializer.Builder

Constructor Summary

Constructors

Constructor and Description
CommonGoogleProtoClientRequestInitializer()
CommonGoogleProtoClientRequestInitializer(String key)
CommonGoogleProtoClientRequestInitializer(String key, String userIp)

Method Summary

Modifier and Type	Method and Description
void	initialize(AbstractGoogleClientRequest<?> request) Subclasses should call super implementation in order to set the key and userIp.
protected void	initializeProtoRequest(AbstractGoogleProtoClientRequest<?> request) Initializes a Google protocol buffer client request.

Methods inherited from class com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

getKey, getRequestReason, getUserAgent, getUserIp, getUserProject, newBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonGoogleProtoClientRequestInitializer

public CommonGoogleProtoClientRequestInitializer()

CommonGoogleProtoClientRequestInitializer

public CommonGoogleProtoClientRequestInitializer(String key)

Parameters:

key - API key or null to leave it unchanged

CommonGoogleProtoClientRequestInitializer

public CommonGoogleProtoClientRequestInitializer(String key,
                                                 String userIp)

Parameters:

key - API key or null to leave it unchanged

userIp - user IP or null to leave it unchanged

Method Detail

initialize

public final void initialize(AbstractGoogleClientRequest<?> request)
                      throws IOException

Description copied from class: CommonGoogleClientRequestInitializer

Subclasses should call super implementation in order to set the key and userIp.

Specified by:

initialize in interface GoogleClientRequestInitializer

Overrides:

initialize in class CommonGoogleClientRequestInitializer

Throws:

IOException - I/O exception

initializeProtoRequest

protected void initializeProtoRequest(AbstractGoogleProtoClientRequest<?> request)
                               throws IOException

Initializes a Google protocol buffer client request.

Default implementation does nothing. Called from initialize(AbstractGoogleClientRequest).

Throws:

IOException - I/O exception