Calendar API v3 (revision 30)



com.google.api.services.calendar
Class CalendarRequestInitializer

java.lang.Object
  extended by com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer
      extended by com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
          extended by com.google.api.services.calendar.CalendarRequestInitializer
All Implemented Interfaces:
GoogleClientRequestInitializer

public class CalendarRequestInitializer
extends CommonGoogleJsonClientRequestInitializer

Calendar request initializer 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 CalendarRequestInitializer(KEY);
 

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

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

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

  public static class MyRequestInitializer extends CalendarRequestInitializer {

    @Override
    public void initializeCalendarRequest(CalendarRequest<?> 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 CalendarRequestInitializer {

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

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

Subclasses should be thread-safe.

Since:
1.12

Constructor Summary
CalendarRequestInitializer()
           
CalendarRequestInitializer(java.lang.String key)
           
CalendarRequestInitializer(java.lang.String key, java.lang.String userIp)
           
 
Method Summary
protected  void initializeCalendarRequest(CalendarRequest<?> request)
          Initializes Calendar request.
 void initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
           
 
Methods inherited from class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
initialize
 
Methods inherited from class com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer
getKey, getUserIp
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalendarRequestInitializer

public CalendarRequestInitializer()

CalendarRequestInitializer

public CalendarRequestInitializer(java.lang.String key)
Parameters:
key - API key or null to leave it unchanged

CalendarRequestInitializer

public CalendarRequestInitializer(java.lang.String key,
                                  java.lang.String userIp)
Parameters:
key - API key or null to leave it unchanged
userIp - user IP or null to leave it unchanged
Method Detail

initializeJsonRequest

public final void initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
                                 throws java.io.IOException
Overrides:
initializeJsonRequest in class CommonGoogleJsonClientRequestInitializer
Throws:
java.io.IOException

initializeCalendarRequest

protected void initializeCalendarRequest(CalendarRequest<?> request)
                                  throws java.io.IOException
Initializes Calendar request.

Default implementation does nothing. Called from initializeJsonRequest(AbstractGoogleJsonClientRequest).

Throws:
java.io.IOException - I/O exception