com.google.api.services.classroom

Class ClassroomRequestInitializer

java.lang.Object

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

com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

com.google.api.services.classroom.ClassroomRequestInitializer

All Implemented Interfaces:

GoogleClientRequestInitializer

public class ClassroomRequestInitializer
extends CommonGoogleJsonClientRequestInitializer

Classroom 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 ClassroomRequestInitializer(KEY);
 

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

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

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

  public static class MyRequestInitializer extends ClassroomRequestInitializer {

     @Override
    public void initializeClassroomRequest(ClassroomRequest <? > 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 ClassroomRequestInitializer {

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

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

Subclasses should be thread-safe.

Since:

1.12

Nested Class Summary

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

CommonGoogleJsonClientRequestInitializer.Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	initializeClassroomRequest(ClassroomRequest<?> request) Initializes Classroom 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, 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

ClassroomRequestInitializer

public ClassroomRequestInitializer()

ClassroomRequestInitializer

public ClassroomRequestInitializer(String key)

Parameters:

key - API key or null to leave it unchanged

ClassroomRequestInitializer

public ClassroomRequestInitializer(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

initializeJsonRequest

public final void initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
                                 throws IOException

Overrides:

initializeJsonRequest in class CommonGoogleJsonClientRequestInitializer

Throws:

IOException

initializeClassroomRequest

protected void initializeClassroomRequest(ClassroomRequest<?> request)
                                   throws IOException

Initializes Classroom request.

Default implementation does nothing. Called from initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest).

Throws:

IOException - I/O exception