Package com.github.toolarium.jwebserver.config

Interface IWebServerConfiguration

  • All Known Implementing Classes:
    WebServerConfiguration
    public interface IWebServerConfiguration
    Defines the webserver configuration interface

    • Method Detail

      • getWebserverName

        java.lang.String getWebserverName()
        Get the webserver name
        Returns:
        the webserver name

      • getHostname

        java.lang.String getHostname()
        Get the hostname
        Returns:
        the hostname

      • getPort

        java.lang.Integer getPort()
        Get the port
        Returns:
        the port

      • getSecurePort

        java.lang.Integer getSecurePort()
        Get the secure port
        Returns:
        the secure port

      • getVerboseLevel

        VerboseLevel getVerboseLevel()
        Get the verbose level
        Returns:
        the verbose level

      • getAccessLogFormatString

        java.lang.String getAccessLogFormatString()
        Get access log format string:

        • %a - Remote IP address
        • %A - Local IP address
        • %b - Bytes sent, excluding HTTP headers, or '-' if no bytes were sent
        • %B - Bytes sent, excluding HTTP headers
        • %h - Remote host name
        • %H - Request protocol
        • %l - Remote logical username from identd (always returns '-')
        • %m - Request method
        • %o - Obfuscated remote IP address (IPv4: last byte removed, IPv6: cut off after second colon, ie. '1.2.3.' or 'fe08:44:')
        • %p - Local port
        • %q - Query string (excluding the '?' character)
        • %r - First line of the request
        • %s - HTTP status code of the response
        • %t - Date and time, in Common Log Format format
        • %u - Remote user that was authenticated
        • %U - Requested URL path
        • %v - Local server name
        • %D - Time taken to process the request, in millis
        • %T - Time taken to process the request, in seconds
        • %I - current Request thread name (can compare later with stacktraces)

        In addition, the caller can specify one of the following aliases for commonly utilized patterns:

        • common - %h %l %u %t "%r" %s %b
        • combined - %h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"
        • commonobf - %o %l %u %t "%r" %s %b
        • combinedobf - %o %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"

        There is also support to write information from the cookie, incoming header, or the session
        It is modeled after the apache syntax:

        • %{i,xxx} for incoming headers
        • %{o,xxx} for outgoing response headers
        • %{c,xxx} for a specific cookie
        • %{r,xxx} xxx is an attribute in the ServletRequest
        • %{s,xxx} xxx is an attribute in the HttpSession

        Returns:
        the accesslog format string

      • getAccessLogFilePattern

        java.lang.String getAccessLogFilePattern()
        The access log file pattern, e.g. "access-%d{yyyy-MM-dd}.log.gz"

        For more information, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#TimeBasedRollingPolicy

        Returns:
        the access log file pattern

      • hasBasicAuthentication

        boolean hasBasicAuthentication()
        Define if the resource has basic authentication
        Returns:
        true if it is enabled

      • getBasicAuthentication

        java.lang.String getBasicAuthentication()
        Get the basic authentication: user:password
        Returns:
        the basic authentication

      • hasHealthCheck

        boolean hasHealthCheck()
        Define if the server support health
        Returns:
        true if it is enabled

      • getHealthPath

        java.lang.String getHealthPath()
        Get the health path
        Returns:
        the health path

      • getIoThreads

        int getIoThreads()
        Get the number of I/O threads
        Returns:
        the number of I/O threads

      • getWorkerThreads

        int getWorkerThreads()
        Get the number of working threads
        Returns:
        the number of working threads

      • getResourcePath

        java.lang.String getResourcePath()
        Get the resource path
        Returns:
        the resource path

      • getSSLServerConfiguration

        SSLServerConfiguration getSSLServerConfiguration()
        Get the ssl server configuration
        Returns:
        the ssl server configuration

      • getResourceServerConfiguration

        ResourceServerConfiguration getResourceServerConfiguration()
        Get the resource server configuration
        Returns:
        the resource server configuration

      • getProxyServerConfiguration

        ProxyServerConfiguration getProxyServerConfiguration()
        Get the proxy server configuration
        Returns:
        the proxy server configuration

      • isProxyServer

        boolean isProxyServer()
        True if it is a proxy server
        Returns:
        true if it is a proxy server