com.google.api.client.googleapis.services

Class CommonGoogleClientRequestInitializer

java.lang.Object

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

All Implemented Interfaces:

GoogleClientRequestInitializer

Direct Known Subclasses:

CommonGoogleJsonClientRequestInitializer, CommonGoogleProtoClientRequestInitializer

public class CommonGoogleClientRequestInitializer
extends Object
implements GoogleClientRequestInitializer

Google common 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 =
        CommonGoogleClientRequestInitializer.newBuilder()
              .setKey(KEY)
              .build();
 

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

 public static final GoogleClientRequestInitializer INITIALIZER =
 CommonGoogleClientRequestInitializer.newBuilder()
 .setKey(KEY)
 .setUserIp(USER_IP)
 .build();
 

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

 public static class MyRequestInitializer extends CommonGoogleClientRequestInitializer {

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

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

 public static class MyRequestInitializer2 extends CommonGoogleClientRequestInitializer {

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

   {@literal @}Override
   public void initialize
       (AbstractGoogleClientRequest{@literal <}?{@literal >} request) throws IOException {
     super.initialize(request); // must be called to set the key and userIp parameters
     // insert some additional logic
   }
 }
 

Subclasses should be thread-safe.

Since:

1.12

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CommonGoogleClientRequestInitializer() Deprecated. Please use the builder interface
protected	CommonGoogleClientRequestInitializer(CommonGoogleClientRequestInitializer.Builder builder)
	CommonGoogleClientRequestInitializer(String key) Deprecated. Please use the builder interface
	CommonGoogleClientRequestInitializer(String key, String userIp) Deprecated. Please use the builder interface

Method Summary

Modifier and Type	Method and Description
String	getKey() Returns the API key or null to leave it unchanged.
String	getRequestReason() Returns the request reason or null to leave it unchanged.
String	getUserAgent() Returns the user agent or null to leave it unchanged.
String	getUserIp() Returns the user IP or null to leave it unchanged.
String	getUserProject() Returns the user project or null.
void	initialize(AbstractGoogleClientRequest<?> request) Subclasses should call super implementation in order to set the key and userIp.
static CommonGoogleClientRequestInitializer.Builder	newBuilder() Returns new builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonGoogleClientRequestInitializer

@Deprecated
public CommonGoogleClientRequestInitializer()

Deprecated. Please use the builder interface

CommonGoogleClientRequestInitializer

@Deprecated
public CommonGoogleClientRequestInitializer(String key)

Deprecated. Please use the builder interface

Parameters:

key - API key or null to leave it unchanged

CommonGoogleClientRequestInitializer

@Deprecated
public CommonGoogleClientRequestInitializer(String key,
                                                        String userIp)

Deprecated. Please use the builder interface

Parameters:

key - API key or null to leave it unchanged

userIp - user IP or null to leave it unchanged

CommonGoogleClientRequestInitializer

protected CommonGoogleClientRequestInitializer(CommonGoogleClientRequestInitializer.Builder builder)

Method Detail

newBuilder

public static CommonGoogleClientRequestInitializer.Builder newBuilder()

Returns new builder.

Since:

1.30

initialize

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

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

Specified by:

initialize in interface GoogleClientRequestInitializer

Throws:

IOException - I/O exception

getKey

public final String getKey()

Returns the API key or null to leave it unchanged.

getUserIp

public final String getUserIp()

Returns the user IP or null to leave it unchanged.

getUserAgent

public final String getUserAgent()

Returns the user agent or null to leave it unchanged.

getRequestReason

public final String getRequestReason()

Returns the request reason or null to leave it unchanged.

getUserProject

public final String getUserProject()

Returns the user project or null.