Package org.omegazero.proxy.config

Class HTTPEngineConfig

java.lang.Object
org.omegazero.common.config.ConfigObject
org.omegazero.proxy.config.HTTPEngineConfig
All Implemented Interfaces:
Serializable
public class HTTPEngineConfig extends org.omegazero.common.config.ConfigObject
Contains configuration variables for HTTPEngines.
Since:
3.3.1
See Also:

  • Field Summary

    Fields inherited from class org.omegazero.common.config.ConfigObject

    data

  • Constructor Summary

    Constructors
    Constructor
    Description
    HTTPEngineConfig(Map<String,Object> data)
     
    HTTPEngineConfig(org.omegazero.common.config.ConfigObject co)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaxHeaderSize()
    Returns the maximum size of a HTTP message header (the start line and all headers) in bytes.
    int
    getMaxStreamsPerServer()
    Returns the maximum number of concurrent active requests (streams) to an UpstreamServer for a single client.
    int
    getRequestTimeout()
    Returns the maximum time in milliseconds to wait for a request to finish before responding with status 408.
    int
    getResponseTimeout()
    Returns the maximum time in milliseconds to wait for a response from an upstream server before responding with status 504.
    int
    getUpstreamConnectionTimeout()
    Returns the maximum time in milliseconds to wait until a connection to an upstream server is established before the connection attempt should be cancelled and an error be reported.
    boolean
    isDisableDefaultRequestLog()
    Returns whether the default request log messages should be disabled.
    boolean
    isEnableHeaders()
    Returns whether a set of default headers should be added to proxied HTTP messages.

    Methods inherited from class org.omegazero.common.config.ConfigObject

    clone, containsKey, containsValue, copyData, entrySet, equals, get, getArray, getBoolean, getDouble, getFloat, getInt, getLong, getObject, getString, hashCode, isEmpty, keySet, merge, optArray, optBoolean, optDouble, optFloat, optInt, optLong, optObject, optString, populateConfigurationOptions, size, toString, values

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • HTTPEngineConfig

      public HTTPEngineConfig(org.omegazero.common.config.ConfigObject co)

    • HTTPEngineConfig

      public HTTPEngineConfig(Map<String,Object> data)

  • Method Details

    • isDisableDefaultRequestLog

      public boolean isDisableDefaultRequestLog()
      Returns whether the default request log messages should be disabled.
      Returns:
      true to disable the default request log messages

    • getUpstreamConnectionTimeout

      public int getUpstreamConnectionTimeout()
      Returns the maximum time in milliseconds to wait until a connection to an upstream server is established before the connection attempt should be cancelled and an error be reported.
      Returns:
      The upstream connection timeout

    • isEnableHeaders

      public boolean isEnableHeaders()
      Returns whether a set of default headers should be added to proxied HTTP messages.
      Returns:
      true to add default HTTP headers

    • getMaxHeaderSize

      public int getMaxHeaderSize()
      Returns the maximum size of a HTTP message header (the start line and all headers) in bytes.
      Returns:
      The maximum HTTP message size

    • getRequestTimeout

      public int getRequestTimeout()
      Returns the maximum time in milliseconds to wait for a request to finish before responding with status 408.
      Returns:
      The request timeout

    • getResponseTimeout

      public int getResponseTimeout()
      Returns the maximum time in milliseconds to wait for a response from an upstream server before responding with status 504.
      Returns:
      The response timeout

    • getMaxStreamsPerServer

      public int getMaxStreamsPerServer()
      Returns the maximum number of concurrent active requests (streams) to an UpstreamServer for a single client.
      Returns:
      The maximum number of streams
      Since:
      3.10.1