Module io.helidon.webserver
Package io.helidon.webserver.spi

Interface UpgradeCodecProvider

All Known Implementing Classes:
Http2UpgradeCodecProvider, WebsocketUpgradeCodecProvider
@Deprecated(since="3.0.0") public interface UpgradeCodecProvider
Deprecated.
Specific internal spi for Helidon 3.x, going to be changed for version 4
Service providing HTTP upgrade codec for Helidon webserver.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    UpgradeCodecProvider.RoutedUpgrade
    Deprecated.
    internal SPI for Helidon 3.x protocol upgrade handling

  • Method Summary

    Modifier and Type
    Method
    Description
    CharSequence
    clearTextProtocol()
    Deprecated.
    Name of the protocol expected in Upgrade header during HTTP upgrade request for using decoder provided by this supplier.
    default Optional<ChannelHandler>
    priorKnowledgeDecoder(io.netty.handler.codec.http.HttpServerCodec sourceCodec, io.netty.handler.codec.http.HttpServerUpgradeHandler wrappedUpgradeHandler, int maxContentLength)
    Deprecated.
    Used as a wrapper for actual upgrade handler, if available.
    default Optional<UpgradeCodecProvider.RoutedUpgrade>
    routedUpgrade(Router router, io.netty.handler.codec.http.HttpRequest request)
    Deprecated.
    Prepare a routed protocol upgrade.
    Optional<String>
    tlsProtocol()
    Deprecated.
    Name of the protocol expected by ALPN negotiation for using this protocol, prior-knowledge decoder is expected to be used.
    io.netty.handler.codec.http.HttpServerUpgradeHandler.UpgradeCodec
    upgradeCodec(io.netty.handler.codec.http.HttpServerCodec sourceCodec, Router router, int maxContentLength)
    Deprecated.
    Codec used by the HttpServerUpgradeHandler when clearTextProtocol() matches.

  • Method Details

    • clearTextProtocol

      CharSequence clearTextProtocol()
      Deprecated.
      Name of the protocol expected in Upgrade header during HTTP upgrade request for using decoder provided by this supplier.
      Returns:
      protocol name

    • tlsProtocol

      Optional<String> tlsProtocol()
      Deprecated.
      Name of the protocol expected by ALPN negotiation for using this protocol, prior-knowledge decoder is expected to be used.
      Returns:
      name of the protocol supported by ALPN or empty optional

    • upgradeCodec

      io.netty.handler.codec.http.HttpServerUpgradeHandler.UpgradeCodec upgradeCodec(io.netty.handler.codec.http.HttpServerCodec sourceCodec, Router router, int maxContentLength)
      Deprecated.
      Codec used by the HttpServerUpgradeHandler when clearTextProtocol() matches.
      Parameters:
      sourceCodec - For replacing HttpResponseEncoder and HttpRequestDecoder when using HttpServerUpgradeHandler
      router - set of all configured routings
      maxContentLength - maximum length of the content of an upgrade request
      Returns:
      upgrade codec

    • routedUpgrade

      default Optional<UpgradeCodecProvider.RoutedUpgrade> routedUpgrade(Router router, io.netty.handler.codec.http.HttpRequest request)
      Deprecated.
      Prepare a routed protocol upgrade.
      Parameters:
      router - router with configured routings
      request - upgrade request
      Returns:
      routed upgrade, or empty optional to continue as ordinary HTTP

    • priorKnowledgeDecoder

      default Optional<ChannelHandler> priorKnowledgeDecoder(io.netty.handler.codec.http.HttpServerCodec sourceCodec, io.netty.handler.codec.http.HttpServerUpgradeHandler wrappedUpgradeHandler, int maxContentLength)
      Deprecated.
      Used as a wrapper for actual upgrade handler, if available. Provides prior-knowledge capability in case other side decides to skip HTTP upgrade.
      Parameters:
      sourceCodec - For replacing HttpResponseEncoder and HttpRequestDecoder when using HttpServerUpgradeHandler
      wrappedUpgradeHandler - Actual upgrade handler used when prior-knowledge doesn't kick in
      maxContentLength - maximum length of the content of an upgrade request
      Returns:
      prior-knowledge decoder or empty optional