com.google.api.gax.httpjson.HttpJsonClientInterceptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gax-httpjson Show documentation

Google Api eXtensions for Java

There is a newer version: 2.58.0

/*
 * Copyright 2022 Google LLC
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google LLC nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.google.api.gax.httpjson;

/**
 * Interface for intercepting outgoing calls before they are dispatched by a {@link
 * HttpJsonChannel}.
 *
 * The interceptor may be called for multiple {@link HttpJsonClientCall calls} by one or more
 * threads without completing the previous ones first. The implementations must be thread-safe.
 */
public interface HttpJsonClientInterceptor {
  /**
   * Intercept {@link HttpJsonClientCall} creation by the {@code next} {@link HttpJsonChannel}.
   *
   * @param method the remote method to be called
   * @param callOptions the runtime options to be applied to this call
   * @param next the channel which is being intercepted
   * @return the call object for the remote operation, never {@code null}
   */
   HttpJsonClientCall interceptCall(
      ApiMethodDescriptor method,
      HttpJsonCallOptions callOptions,
      HttpJsonChannel next);
}