Package com.github.toolarium.jwebserver.config

Class WebServerConfiguration

java.lang.Object

com.github.toolarium.jwebserver.config.WebServerConfiguration

All Implemented Interfaces:

IWebServerConfiguration

public class WebServerConfiguration
extends Object
implements IWebServerConfiguration

Define the webserver configuration

Constructor Summary

Constructors

Constructor	Description
WebServerConfiguration()	Constructor for WebServerConfiguration
WebServerConfiguration(IWebServerConfiguration webServerConfiguration)	Constructor for WebServerConfiguration

Method Summary

Modifier and Type	Method	Description
String	getAccessLogFilePattern()	The access log file pattern, e.g.
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.
String	getBasicAuthentication()	Get the basic authentication: user:password
String	getHealthPath()	Get the health path
String	getHostname()	Get the hostname
int	getIoThreads()	Get the number of I/O threads
Integer	getPort()	Get the port
ProxyServerConfiguration	getProxyServerConfiguration()	Get the proxy server configuration
String	getResourcePath()	Get the resource path
ResourceServerConfiguration	getResourceServerConfiguration()	Get the resource server configuration
Integer	getSecurePort()	Get the secure port
SSLServerConfiguration	getSSLServerConfiguration()	Get the ssl server configuration
VerboseLevel	getVerboseLevel()	Get the verbose level
String	getWebserverName()	Get the webserver name
int	getWorkerThreads()	Get the number of working threads
boolean	hasBasicAuthentication()	Define if the resource has basic authentication
boolean	hasHealthCheck()	Define if the server support health
boolean	isProxyServer()	True if it is a proxy server
WebServerConfiguration	readProperties()	Read the configuration from the classpath
WebServerConfiguration	setAccessLogFilePattern(String accessLogFilePattern)	Set the access log file pattern
WebServerConfiguration	setAccessLogFormatString(String accessLogFormatString)	Set the access log format string
WebServerConfiguration	setBasicAuthentication(String basicAuthentication)	Define if basic authentication is enabled
WebServerConfiguration	setHealthPath(String healthPath)	Set the health path
WebServerConfiguration	setHostname(String hostname)	Set the host name
WebServerConfiguration	setIoThreads(Integer ioThreads)	Set the I/O threads
WebServerConfiguration	setPort(Integer port)	Set the port
WebServerConfiguration	setResourcePath(String resourcePath)	Set the resource path
WebServerConfiguration	setSecurePort(Integer securePort)	Set the secure port
WebServerConfiguration	setVerboseLevel(VerboseLevel verboseLevel)	Set the verbose level
WebServerConfiguration	setWebserverName(String webserverName)	Set the webserver name
WebServerConfiguration	setWorkerThreads(Integer workerThreads)	Set the worker threads
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

WebServerConfiguration

public WebServerConfiguration()

Constructor for WebServerConfiguration

WebServerConfiguration

public WebServerConfiguration(IWebServerConfiguration webServerConfiguration)

Constructor for WebServerConfiguration

Parameters:

webServerConfiguration - the web server configuration

Method Details

getWebserverName

public String getWebserverName()

Description copied from interface: IWebServerConfiguration

Get the webserver name

Specified by:

getWebserverName in interface IWebServerConfiguration

Returns:

the webserver name

See Also:

• IWebServerConfiguration.getWebserverName()

setWebserverName

public WebServerConfiguration setWebserverName(String webserverName)

Set the webserver name

Parameters:

webserverName - the webserve name

Returns:

the WebServerConfiguration

getHostname

public String getHostname()

Description copied from interface: IWebServerConfiguration

Get the hostname

Specified by:

getHostname in interface IWebServerConfiguration

Returns:

the hostname

See Also:

• IWebServerConfiguration.getHostname()

setHostname

public WebServerConfiguration setHostname(String hostname)

Set the host name

Parameters:

hostname - the hostname

Returns:

the WebServerConfiguration

getPort

public Integer getPort()

Description copied from interface: IWebServerConfiguration

Get the port

Specified by:

getPort in interface IWebServerConfiguration

Returns:

the port

See Also:

• IWebServerConfiguration.getPort()

setPort

public WebServerConfiguration setPort(Integer port)

Set the port

Parameters:

port - the port

Returns:

the WebServerConfiguration

getSecurePort

public Integer getSecurePort()

Description copied from interface: IWebServerConfiguration

Get the secure port

Specified by:

getSecurePort in interface IWebServerConfiguration

Returns:

the secure port

See Also:

• IWebServerConfiguration.getSecurePort()

setSecurePort

public WebServerConfiguration setSecurePort(Integer securePort)

Set the secure port

Parameters:

securePort - the secure port

Returns:

the WebServerConfiguration

getVerboseLevel

public VerboseLevel getVerboseLevel()

Description copied from interface: IWebServerConfiguration

Get the verbose level

Specified by:

getVerboseLevel in interface IWebServerConfiguration

Returns:

the verbose level

See Also:

• IWebServerConfiguration.getVerboseLevel()

setVerboseLevel

public WebServerConfiguration setVerboseLevel(VerboseLevel verboseLevel)

Set the verbose level

Parameters:

verboseLevel - the verbose level

Returns:

the WebServerConfiguration

getAccessLogFormatString

public String getAccessLogFormatString()

Description copied from interface: IWebServerConfiguration

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

Specified by:

getAccessLogFormatString in interface IWebServerConfiguration

Returns:

the accesslog format string

See Also:

• IWebServerConfiguration.getAccessLogFormatString()

setAccessLogFormatString

public WebServerConfiguration setAccessLogFormatString(String accessLogFormatString)

Set the access log format string

Parameters:

accessLogFormatString - the access log format string

Returns:

the WebServerConfiguration

getAccessLogFilePattern

public String getAccessLogFilePattern()

Description copied from interface: IWebServerConfiguration

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

Specified by:

getAccessLogFilePattern in interface IWebServerConfiguration

Returns:

the access log file pattern

See Also:

• IWebServerConfiguration.getAccessLogFilePattern()

setAccessLogFilePattern

public WebServerConfiguration setAccessLogFilePattern(String accessLogFilePattern)

Set the access log file pattern

Parameters:

accessLogFilePattern - the access log file pattern

Returns:

the WebServerConfiguration

hasBasicAuthentication

public boolean hasBasicAuthentication()

Description copied from interface: IWebServerConfiguration

Define if the resource has basic authentication

Specified by:

hasBasicAuthentication in interface IWebServerConfiguration

Returns:

true if it is enabled

See Also:

• IWebServerConfiguration.hasBasicAuthentication()

getBasicAuthentication

public String getBasicAuthentication()

Description copied from interface: IWebServerConfiguration

Get the basic authentication: user:password

Specified by:

getBasicAuthentication in interface IWebServerConfiguration

Returns:

the basic authentication

See Also:

• IWebServerConfiguration.getBasicAuthentication()

setBasicAuthentication

public WebServerConfiguration setBasicAuthentication(String basicAuthentication)

Define if basic authentication is enabled

Parameters:

basicAuthentication - true if basic authentication is enabled

Returns:

the WebServerConfiguration

hasHealthCheck

public boolean hasHealthCheck()

Description copied from interface: IWebServerConfiguration

Define if the server support health

Specified by:

hasHealthCheck in interface IWebServerConfiguration

Returns:

true if it is enabled

See Also:

• IWebServerConfiguration.hasHealthCheck()

getHealthPath

public String getHealthPath()

Description copied from interface: IWebServerConfiguration

Get the health path

Specified by:

getHealthPath in interface IWebServerConfiguration

Returns:

the health path

See Also:

• IWebServerConfiguration.getHealthPath()

setHealthPath

public WebServerConfiguration setHealthPath(String healthPath)

Set the health path

Parameters:

healthPath - the resource path

Returns:

the WebServerConfiguration

getIoThreads

public int getIoThreads()

Description copied from interface: IWebServerConfiguration

Get the number of I/O threads

Specified by:

getIoThreads in interface IWebServerConfiguration

Returns:

the number of I/O threads

See Also:

• IWebServerConfiguration.getIoThreads()

setIoThreads

public WebServerConfiguration setIoThreads(Integer ioThreads)

Set the I/O threads

Parameters:

ioThreads - the io threads

Returns:

the WebServerConfiguration

getWorkerThreads

public int getWorkerThreads()

Description copied from interface: IWebServerConfiguration

Get the number of working threads

Specified by:

getWorkerThreads in interface IWebServerConfiguration

Returns:

the number of working threads

See Also:

• IWebServerConfiguration.getWorkerThreads()

setWorkerThreads

public WebServerConfiguration setWorkerThreads(Integer workerThreads)

Set the worker threads

Parameters:

workerThreads - the worker threads

Returns:

the WebServerConfiguration

getResourcePath

public String getResourcePath()

Description copied from interface: IWebServerConfiguration

Get the resource path

Specified by:

getResourcePath in interface IWebServerConfiguration

Returns:

the resource path

See Also:

• IWebServerConfiguration.getResourcePath()

setResourcePath

public WebServerConfiguration setResourcePath(String resourcePath)

Set the resource path

Parameters:

resourcePath - the resource path

Returns:

the ResourceServerConfiguration

getSSLServerConfiguration

public SSLServerConfiguration getSSLServerConfiguration()

Description copied from interface: IWebServerConfiguration

Get the ssl server configuration

Specified by:

getSSLServerConfiguration in interface IWebServerConfiguration

Returns:

the ssl server configuration

See Also:

• IWebServerConfiguration.getSSLServerConfiguration()

getResourceServerConfiguration

public ResourceServerConfiguration getResourceServerConfiguration()

Description copied from interface: IWebServerConfiguration

Get the resource server configuration

Specified by:

getResourceServerConfiguration in interface IWebServerConfiguration

Returns:

the resource server configuration

See Also:

• IWebServerConfiguration.getResourceServerConfiguration()

getProxyServerConfiguration

public ProxyServerConfiguration getProxyServerConfiguration()

Description copied from interface: IWebServerConfiguration

Get the proxy server configuration

Specified by:

getProxyServerConfiguration in interface IWebServerConfiguration

Returns:

the proxy server configuration

See Also:

• IWebServerConfiguration.getProxyServerConfiguration()

isProxyServer

public boolean isProxyServer()

Description copied from interface: IWebServerConfiguration

True if it is a proxy server

Specified by:

isProxyServer in interface IWebServerConfiguration

Returns:

true if it is a proxy server

See Also:

• IWebServerConfiguration.isProxyServer()

readProperties

public WebServerConfiguration readProperties()

Read the configuration from the classpath

Returns:

the WebServerConfiguration

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()