Package org.microproxy

Enum Class FlowRecord.Kind

java.lang.Object
java.lang.Enum<FlowRecord.Kind>
org.microproxy.FlowRecord.Kind
All Implemented Interfaces:
Serializable, Comparable<FlowRecord.Kind>, Constable
Enclosing class:
FlowRecord
public static enum FlowRecord.Kind extends Enum<FlowRecord.Kind>
What kind of exchange or flow a record is about; %MP_FLOW% renders its label().

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    HTTP1
    An HTTP/1.x exchange (h1).
    HTTP2
    An HTTP/2 stream's exchange (h2).
    HTTP3
    An HTTP/3 stream's exchange (h3).
    QUIC
    A QUIC flow intercepted stream by stream (quic).
    QUIC_RELAY
    A transparent QUIC flow whose datagrams were relayed untouched, or dropped (quic_relay).
    SOCKS
    A SOCKS client's tunnel (socks).
    TCP
    A raw TCP tunnel passed through the TCP hooks (tcp).
    TUNNEL
    A CONNECT tunnel, over HTTP/1, HTTP/2 or HTTP/3, or a transparent TLS connection (tunnel).
    UDP
    A CONNECT-UDP (MASQUE) flow (udp).
    WEBSOCKET
    A WebSocket session, from its opening handshake to its close (websocket).

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isHttp()
    Returns whether this is an HTTP exchange rather than a tunnel or flow.
    String
    label()
    Returns the short name an access log shows, such as h2 or tunnel.
    static FlowRecord.Kind
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FlowRecord.Kind[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • HTTP1

      public static final FlowRecord.Kind HTTP1
      An HTTP/1.x exchange (h1).

    • HTTP2

      public static final FlowRecord.Kind HTTP2
      An HTTP/2 stream's exchange (h2).

    • HTTP3

      public static final FlowRecord.Kind HTTP3
      An HTTP/3 stream's exchange (h3).

    • TUNNEL

      public static final FlowRecord.Kind TUNNEL
      A CONNECT tunnel, over HTTP/1, HTTP/2 or HTTP/3, or a transparent TLS connection (tunnel).

    • SOCKS

      public static final FlowRecord.Kind SOCKS
      A SOCKS client's tunnel (socks).

    • WEBSOCKET

      public static final FlowRecord.Kind WEBSOCKET
      A WebSocket session, from its opening handshake to its close (websocket).

    • TCP

      public static final FlowRecord.Kind TCP
      A raw TCP tunnel passed through the TCP hooks (tcp).

    • UDP

      public static final FlowRecord.Kind UDP
      A CONNECT-UDP (MASQUE) flow (udp).

    • QUIC

      public static final FlowRecord.Kind QUIC
      A QUIC flow intercepted stream by stream (quic).

    • QUIC_RELAY

      public static final FlowRecord.Kind QUIC_RELAY
      A transparent QUIC flow whose datagrams were relayed untouched, or dropped (quic_relay).

  • Method Details

    • values

      public static FlowRecord.Kind[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FlowRecord.Kind valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • label

      public String label()
      Returns the short name an access log shows, such as h2 or tunnel.
      Returns:
      the short name an access log shows, such as h2 or tunnel

    • isHttp

      public boolean isHttp()
      Returns whether this is an HTTP exchange rather than a tunnel or flow.
      Returns:
      whether this is an HTTP exchange rather than a tunnel or flow