com.google.api.client.googleapis.services.GoogleClientRequestInitializer.java Source code

Introduction

Here is the source code for com.google.api.client.googleapis.services.GoogleClientRequestInitializer.java

Source

/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.client.googleapis.services;

import java.io.IOException;

/**
 * Google client request initializer.
 *
 * <p>
 * For example, this might be used to set a key URL query parameter on all requests:
 * </p>
 *
 * <pre>
  public class KeyRequestInitializer implements GoogleClientRequestInitializer {
public void initialize(GoogleClientRequest<?> request) {
  request.put("key", KEY);
}
  }
 * </pre>
 *
 * <p>
 * Implementations should be thread-safe.
 * </p>
 *
 * @since 1.12
 * @author Yaniv Inbar
 */
public interface GoogleClientRequestInitializer {

    /** Initializes a Google client request. */
    void initialize(AbstractGoogleClientRequest<?> request) throws IOException;
}