Package org.jboss.resteasy.plugins.server.netty

Class NettyJaxrsServer

java.lang.Object
org.jboss.resteasy.plugins.server.netty.NettyJaxrsServer
All Implemented Interfaces:
EmbeddedJaxrsServer<NettyJaxrsServer>, EmbeddedServer
Direct Known Subclasses:
CdiNettyJaxrsServer
@Deprecated(forRemoval=true, since="6.2.13.Final") public class NettyJaxrsServer extends Object implements EmbeddedJaxrsServer<NettyJaxrsServer>
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
An HTTP server that sends back the content of the received HTTP request in a pretty plaintext form.
Version:
$Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
Author:
The Netty Project, Andy Taylor (andy.taylor@jboss.org), Trustin Lee, Norman Maurer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected io.netty.bootstrap.ServerBootstrap
    bootstrap
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected int
    configuredPort
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected ResteasyDeployment
    deployment
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected SecurityDomain
    domain
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    hostname
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    root
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected int
    runtimePort
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    NettyJaxrsServer()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected RequestDispatcher
    createRequestDispatcher()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    deploy()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    ResteasyDeployment
    getDeployment()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the deployment being used for the server.
    String
    getHostname()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getIdleTimeout()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getPort()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    SniConfiguration
    getSniConfiguration()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setBacklog(int backlog)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setChannelHandlers(List<io.netty.channel.ChannelHandler> channelHandlers)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add additional ChannelHandlers to the ServerBootstrap.
    NettyJaxrsServer
    setChannelOptions(Map<io.netty.channel.ChannelOption,Object> channelOptions)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add Netty ChannelOptions to the ServerBootstrap.
    NettyJaxrsServer
    setChildChannelOptions(Map<io.netty.channel.ChannelOption,Object> channelOptions)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add child options to the ServerBootstrap.
    NettyJaxrsServer
    setDeployment(ResteasyDeployment deployment)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setExecutorThreadCount(int executorThreadCount)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the number of threads to use for the EventExecutor.
    NettyJaxrsServer
    setHostname(String hostname)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setHttpChannelHandlers(List<io.netty.channel.ChannelHandler> httpChannelHandlers)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add additional ChannelHandlers to the ServerBootstrap.
    NettyJaxrsServer
    setIdleTimeout(int idleTimeoutSeconds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the idle timeout.
    NettyJaxrsServer
    setIoWorkerCount(int ioWorkerCount)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Specify the worker count to use.
    NettyJaxrsServer
    setMaxChunkSize(int maxChunkSize)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setMaxHeaderSize(int maxHeaderSize)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setMaxInitialLineLength(int maxInitialLineLength)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setMaxRequestSize(int maxRequestSize)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the max.
    NettyJaxrsServer
    setPort(int port)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setRootResourcePath(String rootResourcePath)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setSecurityDomain(SecurityDomain sc)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setSniConfiguration(SniConfiguration sniConfiguration)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    setSSLContext(SSLContext sslContext)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NettyJaxrsServer
    start()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    start(jakarta.ws.rs.SeBootstrap.Configuration configuration)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Starts the server synchronously.
    void
    stop()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Stops the server.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • bootstrap

      protected io.netty.bootstrap.ServerBootstrap bootstrap
      Deprecated, for removal: This API element is subject to removal in a future version.

    • hostname

      protected String hostname
      Deprecated, for removal: This API element is subject to removal in a future version.

    • configuredPort

      protected int configuredPort
      Deprecated, for removal: This API element is subject to removal in a future version.

    • runtimePort

      protected int runtimePort
      Deprecated, for removal: This API element is subject to removal in a future version.

    • deployment

      protected ResteasyDeployment deployment
      Deprecated, for removal: This API element is subject to removal in a future version.

    • root

      protected String root
      Deprecated, for removal: This API element is subject to removal in a future version.

    • domain

      protected SecurityDomain domain
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • NettyJaxrsServer

      public NettyJaxrsServer()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • deploy

      public NettyJaxrsServer deploy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      deploy in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • start

      public NettyJaxrsServer start()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      start in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • start

      public void start(jakarta.ws.rs.SeBootstrap.Configuration configuration)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: EmbeddedServer
      Starts the server synchronously.
      Specified by:
      start in interface EmbeddedJaxrsServer<NettyJaxrsServer>
      Specified by:
      start in interface EmbeddedServer
      Parameters:
      configuration - the configuration used to configure the server

    • stop

      public void stop()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: EmbeddedServer
      Stops the server.
      Specified by:
      stop in interface EmbeddedServer

    • getDeployment

      public ResteasyDeployment getDeployment()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: EmbeddedServer
      Returns the deployment being used for the server.
      Specified by:
      getDeployment in interface EmbeddedServer
      Returns:
      the deployment

    • setDeployment

      public NettyJaxrsServer setDeployment(ResteasyDeployment deployment)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setDeployment in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • setPort

      public NettyJaxrsServer setPort(int port)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setPort in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • getPort

      public int getPort()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setHostname

      public NettyJaxrsServer setHostname(String hostname)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setHostname in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • getHostname

      public String getHostname()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRootResourcePath

      public NettyJaxrsServer setRootResourcePath(String rootResourcePath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setRootResourcePath in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • setSecurityDomain

      public NettyJaxrsServer setSecurityDomain(SecurityDomain sc)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setSecurityDomain in interface EmbeddedJaxrsServer<NettyJaxrsServer>

    • setSSLContext

      public NettyJaxrsServer setSSLContext(SSLContext sslContext)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setSniConfiguration

      public NettyJaxrsServer setSniConfiguration(SniConfiguration sniConfiguration)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSniConfiguration

      public SniConfiguration getSniConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setIoWorkerCount

      public NettyJaxrsServer setIoWorkerCount(int ioWorkerCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specify the worker count to use. For more information about this please see the javadocs of EventLoopGroup
      Parameters:
      ioWorkerCount - worker count

    • setExecutorThreadCount

      public NettyJaxrsServer setExecutorThreadCount(int executorThreadCount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the number of threads to use for the EventExecutor. For more information please see the javadocs of EventExecutor. If you want to disable the use of the EventExecutor specify a value <= 0. This should only be done if you are 100% sure that you don't have any blocking code in there.
      Parameters:
      executorThreadCount - thread count

    • setMaxRequestSize

      public NettyJaxrsServer setMaxRequestSize(int maxRequestSize)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the max. request size in bytes. If this size is exceed we will send a "413 Request Entity Too Large" to the client.
      Parameters:
      maxRequestSize - the max request size. This is 10mb by default.

    • setMaxInitialLineLength

      public NettyJaxrsServer setMaxInitialLineLength(int maxInitialLineLength)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMaxHeaderSize

      public NettyJaxrsServer setMaxHeaderSize(int maxHeaderSize)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setMaxChunkSize

      public NettyJaxrsServer setMaxChunkSize(int maxChunkSize)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setBacklog

      public NettyJaxrsServer setBacklog(int backlog)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getIdleTimeout

      public int getIdleTimeout()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setIdleTimeout

      public NettyJaxrsServer setIdleTimeout(int idleTimeoutSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the idle timeout. Set this value to turn on idle connection cleanup. If there is no traffic within idleTimeoutSeconds, it'll close connection.
      Parameters:
      idleTimeoutSeconds - - How many seconds to cleanup client connection. default value -1 meaning no idle timeout.

    • setChannelHandlers

      public NettyJaxrsServer setChannelHandlers(List<io.netty.channel.ChannelHandler> channelHandlers)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add additional ChannelHandlers to the ServerBootstrap.

      The additional channel handlers are being added before the HTTP handling.

      Parameters:
      channelHandlers - the additional ChannelHandlers.

    • setHttpChannelHandlers

      public NettyJaxrsServer setHttpChannelHandlers(List<io.netty.channel.ChannelHandler> httpChannelHandlers)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add additional ChannelHandlers to the ServerBootstrap.

      The additional channel handlers are being added after the HTTP handling.

      Parameters:
      httpChannelHandlers - the additional ChannelHandlers.

    • setChannelOptions

      public NettyJaxrsServer setChannelOptions(Map<io.netty.channel.ChannelOption,Object> channelOptions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add Netty ChannelOptions to the ServerBootstrap.
      Parameters:
      channelOptions - the additional ChannelOptions.
      See Also:
      • AbstractBootstrap.option(io.netty.channel.ChannelOption, Object)

    • setChildChannelOptions

      public NettyJaxrsServer setChildChannelOptions(Map<io.netty.channel.ChannelOption,Object> channelOptions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add child options to the ServerBootstrap.
      Parameters:
      channelOptions - the additional child ChannelOptions.
      See Also:
      • ServerBootstrap.childOption(io.netty.channel.ChannelOption, Object)

    • createRequestDispatcher

      protected RequestDispatcher createRequestDispatcher()
      Deprecated, for removal: This API element is subject to removal in a future version.