io.grpc.xds.HttpConnectionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-xds Show documentation
gRPC: XDS plugin
The newest version!
/*
 * Copyright 2021 The gRPC Authors
 *
 * 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 io.grpc.xds;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import io.grpc.xds.Filter.NamedFilterConfig;
import java.util.List;
import javax.annotation.Nullable;

/**
 * HttpConnectionManager is a network filter for proxying HTTP requests.
 */
@AutoValue
abstract class HttpConnectionManager {
  // Total number of nanoseconds to keep alive an HTTP request/response stream.
  abstract long httpMaxStreamDurationNano();

  // Name of the route configuration to be used for RDS resource discovery.
  @Nullable
  abstract String rdsName();

  // List of virtual hosts that make up the route table.
  @Nullable
  abstract ImmutableList virtualHosts();

  // List of http filter configs. Null if HttpFilter support is not enabled.
  @Nullable
  abstract ImmutableList httpFilterConfigs();

  static HttpConnectionManager forRdsName(long httpMaxStreamDurationNano, String rdsName,
      @Nullable List httpFilterConfigs) {
    checkNotNull(rdsName, "rdsName");
    return create(httpMaxStreamDurationNano, rdsName, null, httpFilterConfigs);
  }

  static HttpConnectionManager forVirtualHosts(long httpMaxStreamDurationNano,
      List virtualHosts, @Nullable List httpFilterConfigs) {
    checkNotNull(virtualHosts, "virtualHosts");
    return create(httpMaxStreamDurationNano, null, virtualHosts,
        httpFilterConfigs);
  }

  private static HttpConnectionManager create(long httpMaxStreamDurationNano,
      @Nullable String rdsName, @Nullable List virtualHosts,
      @Nullable List httpFilterConfigs) {
    return new AutoValue_HttpConnectionManager(
        httpMaxStreamDurationNano, rdsName,
        virtualHosts == null ? null : ImmutableList.copyOf(virtualHosts),
        httpFilterConfigs == null ? null : ImmutableList.copyOf(httpFilterConfigs));
  }
}