swim.io.http.HttpSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swim-io-http Show documentation
Uploads all artifacts belonging to configuration ':swim-io-http:archives'
There is a newer version: 3.10.0
// Copyright 2015-2019 SWIM.AI inc.
//
// 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 swim.io.http;

import swim.codec.Debug;
import swim.codec.Format;
import swim.codec.Output;
import swim.io.SocketSettings;
import swim.io.TcpSettings;
import swim.io.TlsSettings;
import swim.structure.Form;
import swim.structure.Item;
import swim.structure.Kind;
import swim.structure.Record;
import swim.structure.Value;
import swim.util.Murmur3;

/**
 * HTTP configuration parameters.
 */
public class HttpSettings implements Debug {
  protected final SocketSettings socketSettings;
  protected final int maxMessageSize;

  public HttpSettings(SocketSettings socketSettings, int maxMessageSize) {
    this.socketSettings = socketSettings;
    this.maxMessageSize = maxMessageSize;
  }

  /**
   * Returns the socket configuration.
   */
  public final SocketSettings socketSettings() {
    return this.socketSettings;
  }

  /**
   * Returns a copy of these {@code HttpSettings} configured with the given
   * {@code socketSettings}.
   */
  public HttpSettings socketSettings(SocketSettings socketSettings) {
    return copy(socketSettings, this.maxMessageSize);
  }

  /**
   * Returns the TCP socket configuration.
   */
  public final TcpSettings tcpSettings() {
    return this.socketSettings.tcpSettings();
  }

  /**
   * Returns a copy of these {@code HttpSettings} configured with the given
   * {@code tcpSettings}.
   */
  public HttpSettings tcpSettings(TcpSettings tcpSettings) {
    return socketSettings(this.socketSettings.tcpSettings(tcpSettings));
  }

  /**
   * Returns the TLS socket configuration.
   */
  public final TlsSettings tlsSettings() {
    return this.socketSettings.tlsSettings();
  }

  /**
   * Returns a copy of these {@code HttpSettings} configured with the given
   * {@code tlsSettings}.
   */
  public HttpSettings tlsSettings(TlsSettings tlsSettings) {
    return socketSettings(this.socketSettings.tlsSettings(tlsSettings));
  }

  /**
   * Returns the maximum size in bytes on the wire of an HTTP request or
   * response message + entity.
   */
  public int maxMessageSize() {
    return this.maxMessageSize;
  }

  /**
   * Returns a copy of these {@code HttpSettings} configured with the given
   * {@code maxMessageSize} limit on HTTP message + entity sizes.
   */
  public HttpSettings maxMessageSize(int maxMessageSize) {
    return copy(this.socketSettings, maxMessageSize);
  }

  /**
   * Returns a new {@code HttpSettings} instance with the given options.
   * Subclasses may override this method to ensure the proper class is
   * instantiated when updating settings.
   */
  protected HttpSettings copy(SocketSettings socketSettings, int maxMessageSize) {
    return new HttpSettings(socketSettings, maxMessageSize);
  }

  /**
   * Returns a structural {@code Value} representing these {@code HttpSettings}.
   */
  public Value toValue() {
    return form().mold(this).toValue();
  }

  /**
   * Returns {@code true} if these {@code HttpSettings} can possibly equal some
   * {@code other} object.
   */
  public boolean canEqual(Object other) {
    return other instanceof HttpSettings;
  }

  @Override
  public boolean equals(Object other) {
    if (this == other) {
      return true;
    } else if (other instanceof HttpSettings) {
      final HttpSettings that = (HttpSettings) other;
      return that.canEqual(this) && this.socketSettings.equals(that.socketSettings)
          && this.maxMessageSize == that.maxMessageSize;
    }
    return false;
  }

  @Override
  public int hashCode() {
    if (hashSeed == 0) {
      hashSeed = Murmur3.seed(HttpSettings.class);
    }
    return Murmur3.mash(Murmur3.mix(Murmur3.mix(hashSeed,
        this.socketSettings.hashCode()), this.maxMessageSize));
  }

  @Override
  public void debug(Output output) {
    output = output.write("HttpSettings").write('.').write("standard").write('(').write(')')
        .write('.').write("socketSettings").write('(').debug(this.socketSettings).write(')')
        .write('.').write("maxMessageSize").write('(').debug(this.maxMessageSize).write(')');
  }

  @Override
  public String toString() {
    return Format.debug(this);
  }

  private static int hashSeed;

  private static HttpSettings standard;

  private static Form form;

  /**
   * Returns the default {@code HttpSettings} instance.
   */
  public static HttpSettings standard() {
    if (standard == null) {
      int maxMessageSize;
      try {
        maxMessageSize = Integer.parseInt(System.getProperty("swim.http.max.message.size"));
      } catch (NumberFormatException error) {
        maxMessageSize = 16 * 1024 * 1024;
      }

      standard = new HttpSettings(SocketSettings.standard(), maxMessageSize);
    }
    return standard;
  }

  public static HttpSettings from(SocketSettings socketSettings) {
    return standard().socketSettings(socketSettings);
  }

  /**
   * Returns the structural {@code Form} of {@code HttpSettings}.
   */
  @Kind
  public static Form form() {
    if (form == null) {
      form = new HttpSettingsForm();
    }
    return form;
  }
}

final class HttpSettingsForm extends Form {
  @Override
  public HttpSettings unit() {
    return HttpSettings.standard();
  }

  @Override
  public Class type() {
    return HttpSettings.class;
  }

  @Override
  public Item mold(HttpSettings settings) {
    if (settings != null) {
      final HttpSettings standard = HttpSettings.standard();
      final Record http = Record.create(2).attr("http");
      if (settings.maxMessageSize != standard.maxMessageSize) {
        http.slot("maxMessageSize", settings.maxMessageSize);
      }
      return Record.of(http).concat(SocketSettings.form().mold(settings.socketSettings));
    } else {
      return Item.extant();
    }
  }

  @Override
  public HttpSettings cast(Item item) {
    final Value value = item.toValue();
    final HttpSettings standard = HttpSettings.standard();
    int maxMessageSize = standard.maxMessageSize;
    for (Item member : value) {
      if (member.getAttr("http").isDefined()) {
        maxMessageSize = member.get("maxMessageSize").intValue(maxMessageSize);
      }
    }
    final SocketSettings socketSettings = SocketSettings.form().cast(item);
    return new HttpSettings(socketSettings, maxMessageSize);
  }
}