WebServer (SIRIUS web 19.0-rc8 API)

java.lang.Object
- sirius.web.http.WebServer

All Implemented Interfaces:

sirius.kernel.di.std.Priorized, sirius.kernel.health.metrics.MetricProvider, sirius.kernel.Killable, sirius.kernel.Startable, sirius.kernel.Stoppable
```
public class WebServer
extends Object
implements sirius.kernel.Startable, sirius.kernel.Stoppable, sirius.kernel.Killable, sirius.kernel.health.metrics.MetricProvider
```
Responsible for setting up and starting netty as HTTP server.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebServer.BandwidthUpdater` Updates the measured bandwidth of all open http(s) connections.
`static class`	`WebServer.MicrotimingMode` Determines how the web server should participate in the microtiming framework.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static long`	`blocks`
`protected static long`	`bytesIn`
`protected static long`	`bytesOut`
`protected static long`	`chunks`
`protected static long`	`clientErrors`
`protected static long`	`connections`
`protected static long`	`idleTimeouts`
`protected static long`	`keepalives`
`static int`	`LIFECYCLE_PRIORITY` Determines the priority of the start of the web server.
`static sirius.kernel.health.Log`	`LOG` Used to log all web / http relevant messages
`protected static long`	`messagesIn`
`protected static long`	`messagesOut`
`protected static WebServer.MicrotimingMode`	`microtimingMode`
`protected static Map<sirius.web.http.WebServerHandler,sirius.web.http.WebServerHandler>`	`openConnections`
`protected static long`	`requests`
`protected static sirius.kernel.health.Average`	`responseTime`
`protected static long`	`serverErrors`
`protected static sirius.kernel.health.Average`	`timeToFirstByte`
`protected static long`	`websockets`

Fields inherited from interface sirius.kernel.di.std.Priorized
DEFAULT_PRIORITY

Constructor Summary

Constructors
Constructor and Description

WebServer()

Constructors
Constructor and Description
`WebServer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`addOpenConnection(sirius.web.http.WebServerHandler webServerHandler)`
`void`	`awaitTermination()`
`void`	`gather(sirius.kernel.health.metrics.MetricsCollector collector)`
`static double`	`getAvgResponseTime()` Returns the average response time of the last requests.
`static double`	`getAvgTimeToFirstByte()` Returns the average time required to generate a response.
`static long`	`getBlockedConnections()` Returns the total number of connections blocked so far
`static long`	`getBytesIn()` Returns the total bytes received so far
`static long`	`getBytesOut()` Returns the total bytes sent so far
`static long`	`getChunks()` Returns the total number of HTTP chunks received
`static long`	`getClientErrors()` Returns the number of HTTP responses with an 4xx status code.
`static long`	`getConnections()` Returns the total number of connections opened so far
`protected static HttpDataFactory`	`getHttpDataFactory()` Returns the data factory used to handle file uploads and posts.
`static long`	`getIdleTimeouts()` Returns the number of idle connections killed
`protected static IPRange.RangeSet`	`getIPFilter()` Returns an ip filter which determines which IPs may connect to the web server.
`static long`	`getKeepalives()` Returns the number of keepalives supported
`protected static long`	`getMaxTimeToFirstByte()` Returns the maximal tolerated time it takes to create a response (send the first byte).
`protected static long`	`getMaxUploadSize()` Returns the maximal upload size in bytes
`static long`	`getMessagesIn()` Returns the total messages (packets) sent so far
`static long`	`getMessagesOut()` Returns the total messages (packets) received so far
`static WebServer.MicrotimingMode`	`getMicrotimingMode()` Returns the `WebServer.MicrotimingMode` used by the web server
`protected static long`	`getMinUploadFreespace()` Returns the minimal value of free disk space accepted until an upload is aborted.
`static long`	`getNumberOfOpenConnections()` Returns the number of currently open connection
`static long`	`getNumberOfWebsockets()` Returns the number of currently open websockets
`static Collection<ActiveHTTPConnection>`	`getOpenConnections()` Returns all currently open connections of the HTTP server.
`static int`	`getPort()` Returns the port used by the web server
`int`	`getPriority()`
`protected static IPRange.RangeSet`	`getProxyIPs()` Returns all proxy IPs as `IPRange.RangeSet`
`static long`	`getRequests()` Returns the total number of HTTP requests received by the web server
`static long`	`getServerErrors()` Returns the number of HTTP responses with an 5xx status code.
`protected static IPRange.RangeSet`	`getTrustedRanges()` Returns all trusted IPs as `IPRange.RangeSet`
`protected static void`	`removeOpenConnection(sirius.web.http.WebServerHandler webServerHandler)`
`static void`	`setMicrotimingMode(WebServer.MicrotimingMode microtimingMode)` Changes the microtiming mode.
`void`	`started()`
`void`	`stopped()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LIFECYCLE_PRIORITY
```
public static final int LIFECYCLE_PRIORITY
```
    Determines the priority of the start of the web server. This is exposed as public so that other life cycles can determine their own priority on this.
    
    See Also:
    
    Constant Field Values
  - LOG
```
public static final sirius.kernel.health.Log LOG
```
    Used to log all web / http relevant messages
  - bytesIn
```
protected static volatile long bytesIn
```
  - bytesOut
```
protected static volatile long bytesOut
```
  - messagesIn
```
protected static volatile long messagesIn
```
  - messagesOut
```
protected static volatile long messagesOut
```
  - connections
```
protected static volatile long connections
```
  - blocks
```
protected static volatile long blocks
```
  - requests
```
protected static volatile long requests
```
  - chunks
```
protected static volatile long chunks
```
  - keepalives
```
protected static volatile long keepalives
```
  - idleTimeouts
```
protected static volatile long idleTimeouts
```
  - clientErrors
```
protected static volatile long clientErrors
```
  - serverErrors
```
protected static volatile long serverErrors
```
  - websockets
```
protected static volatile long websockets
```
  - openConnections
```
protected static Map<sirius.web.http.WebServerHandler,sirius.web.http.WebServerHandler> openConnections
```
  - responseTime
```
protected static sirius.kernel.health.Average responseTime
```
  - timeToFirstByte
```
protected static sirius.kernel.health.Average timeToFirstByte
```
  - microtimingMode
```
protected static volatile WebServer.MicrotimingMode microtimingMode
```
- Constructor Detail
  - WebServer
```
public WebServer()
```
- Method Detail
  - getPort
```
public static int getPort()
```
    Returns the port used by the web server
    
    Returns:
    
    the port served by the HTTP server
  - getIPFilter
```
protected static IPRange.RangeSet getIPFilter()
```
    Returns an ip filter which determines which IPs may connect to the web server.
    
    Returns:
    
    a range set describing all accepted ranges
  - getTrustedRanges
```
protected static IPRange.RangeSet getTrustedRanges()
```
    Returns all trusted IPs as IPRange.RangeSet
    
    Returns:
    
    a range set describing all trusted ranges
  - getProxyIPs
```
protected static IPRange.RangeSet getProxyIPs()
```
    Returns all proxy IPs as IPRange.RangeSet
    
    Returns:
    
    a range set describing all proxy ranges. This is probably just a single IP addressed, however, using IPRange.RangeSet permit to name several, even sub nets. If a request comes from a proxy IP its X-Forwarded-For header is checked for the original IP.
  - getMinUploadFreespace
```
protected static long getMinUploadFreespace()
```
    Returns the minimal value of free disk space accepted until an upload is aborted.
    
    Returns:
    
    the minimal allowed free disk space in bytes
  - getMaxUploadSize
```
protected static long getMaxUploadSize()
```
    Returns the maximal upload size in bytes
    
    Returns:
    
    the max size of uploaded files
  - getMaxTimeToFirstByte
```
protected static long getMaxTimeToFirstByte()
```
    Returns the maximal tolerated time it takes to create a response (send the first byte).
    
    Returns:
    
    the maximal time to first byte in millis
  - getHttpDataFactory
```
protected static HttpDataFactory getHttpDataFactory()
```
    Returns the data factory used to handle file uploads and posts.
    
    Returns:
    
    the data factory used for processing POST and PUT requests.
  - getPriority
```
public int getPriority()
```
    Specified by:
    
    getPriority in interface sirius.kernel.di.std.Priorized
    
    Specified by:
    
    getPriority in interface sirius.kernel.Killable
    
    Specified by:
    
    getPriority in interface sirius.kernel.Startable
    
    Specified by:
    
    getPriority in interface sirius.kernel.Stoppable
  - started
```
public void started()
```
    Specified by:
    
    started in interface sirius.kernel.Startable
  - stopped
```
public void stopped()
```
    Specified by:
    
    stopped in interface sirius.kernel.Stoppable
  - awaitTermination
```
public void awaitTermination()
```
    Specified by:
    
    awaitTermination in interface sirius.kernel.Killable
  - getBytesIn
```
public static long getBytesIn()
```
    Returns the total bytes received so far
    
    Returns:
    
    the total bytes received via the http port
  - getBytesOut
```
public static long getBytesOut()
```
    Returns the total bytes sent so far
    
    Returns:
    
    the total bytes sent via the http port
  - getMessagesIn
```
public static long getMessagesIn()
```
    Returns the total messages (packets) sent so far
    
    Returns:
    
    the total messages sent via the http port
  - getMessagesOut
```
public static long getMessagesOut()
```
    Returns the total messages (packets) received so far
    
    Returns:
    
    the total messages received via the http port
  - getConnections
```
public static long getConnections()
```
    Returns the total number of connections opened so far
    
    Returns:
    
    the total number of connections opened on the http port
  - getBlockedConnections
```
public static long getBlockedConnections()
```
    Returns the total number of connections blocked so far
    
    Returns:
    
    the total number of connections blocked via a firewall rule on the http port
  - getNumberOfOpenConnections
```
public static long getNumberOfOpenConnections()
```
    Returns the number of currently open connection
    
    Returns:
    
    the number of open connections on the http port
  - getNumberOfWebsockets
```
public static long getNumberOfWebsockets()
```
    Returns the number of currently open websockets
    
    Returns:
    
    the number of currently open websockets
  - getRequests
```
public static long getRequests()
```
    Returns the total number of HTTP requests received by the web server
    
    Returns:
    
    the total number of requests received
  - getChunks
```
public static long getChunks()
```
    Returns the total number of HTTP chunks received
    
    Returns:
    
    the total number of chunks received
  - getKeepalives
```
public static long getKeepalives()
```
    Returns the number of keepalives supported
    
    Returns:
    
    the number of connections not closed in order to keep them alive.
  - getIdleTimeouts
```
public static long getIdleTimeouts()
```
    Returns the number of idle connections killed
    
    Returns:
    
    the number of connections closed because they were found to be idle.
  - getClientErrors
```
public static long getClientErrors()
```
    Returns the number of HTTP responses with an 4xx status code.
    
    Returns:
    
    the number of HTTP responses with an 4xx status code.
  - getServerErrors
```
public static long getServerErrors()
```
    Returns the number of HTTP responses with an 5xx status code.
    
    Returns:
    
    the number of HTTP responses with an 5xx status code.
  - getAvgResponseTime
```
public static double getAvgResponseTime()
```
    Returns the average response time of the last requests.
    
    Returns:
    
    the average response time of the last requests in milliseconds.
  - getAvgTimeToFirstByte
```
public static double getAvgTimeToFirstByte()
```
    Returns the average time required to generate a response.
    
    Returns:
    
    the average time to first byte of the last requests in milliseconds.
  - gather
```
public void gather(sirius.kernel.health.metrics.MetricsCollector collector)
```
    Specified by:
    
    gather in interface sirius.kernel.health.metrics.MetricProvider
  - addOpenConnection
```
protected static void addOpenConnection(sirius.web.http.WebServerHandler webServerHandler)
```
  - removeOpenConnection
```
protected static void removeOpenConnection(sirius.web.http.WebServerHandler webServerHandler)
```
  - getOpenConnections
```
public static Collection<ActiveHTTPConnection> getOpenConnections()
```
    Returns all currently open connections of the HTTP server.
    
    Returns:
    
    a list of all currently open connections
  - getMicrotimingMode
```
public static WebServer.MicrotimingMode getMicrotimingMode()
```
    Returns the WebServer.MicrotimingMode used by the web server
    
    Returns:
    
    the current mode of interaction with the microtiming framework
    
    See Also:
    
    Microtiming
  - setMicrotimingMode
```
public static void setMicrotimingMode(WebServer.MicrotimingMode microtimingMode)
```
    Changes the microtiming mode.
    Note that the microtiming framework still has to be enabled to generate any output.
    
    Parameters:
    
    microtimingMode - the new microtiming mode to use.

Class WebServer

Nested Class Summary

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LIFECYCLE_PRIORITY

LOG

bytesIn

bytesOut

messagesIn

messagesOut

connections

blocks

requests

chunks

keepalives

idleTimeouts

clientErrors

serverErrors

websockets

openConnections

responseTime

timeToFirstByte

microtimingMode

Constructor Detail

WebServer

Method Detail

getPort

getIPFilter

getTrustedRanges

getProxyIPs

getMinUploadFreespace

getMaxUploadSize

getMaxTimeToFirstByte

getHttpDataFactory

getPriority

started

stopped

awaitTermination

getBytesIn

getBytesOut

getMessagesIn

getMessagesOut

getConnections

getBlockedConnections

getNumberOfOpenConnections

getNumberOfWebsockets

getRequests

getChunks

getKeepalives

getIdleTimeouts

getClientErrors

getServerErrors

getAvgResponseTime

getAvgTimeToFirstByte

gather

addOpenConnection

removeOpenConnection

getOpenConnections

getMicrotimingMode

setMicrotimingMode