io.knotx.server.configuration

Class AccessLogOptions

java.lang.Object

io.knotx.server.configuration.AccessLogOptions

public class AccessLogOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
AccessLogOptions() Default constructor
AccessLogOptions(AccessLogOptions other) Copy constructor
AccessLogOptions(io.vertx.core.json.JsonObject json) Create an settings from JSON

Method Summary

Modifier and Type	Method and Description
io.vertx.ext.web.handler.LoggerFormat	getFormat()
boolean	isEnabled()
boolean	isImmediate()
AccessLogOptions	setEnabled(boolean enabled) Sets if logging access to the Knot.x HTTP server is enabled or not.
AccessLogOptions	setFormat(io.vertx.ext.web.handler.LoggerFormat format) Set format of access log.
AccessLogOptions	setImmediate(boolean immediate) Configure when to collect access log.
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessLogOptions

public AccessLogOptions()

Default constructor

AccessLogOptions

public AccessLogOptions(AccessLogOptions other)

Copy constructor

Parameters:

other - the instance to copy

AccessLogOptions

public AccessLogOptions(io.vertx.core.json.JsonObject json)

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

isEnabled

public boolean isEnabled()

Returns:

is access log is enabled

setEnabled

public AccessLogOptions setEnabled(boolean enabled)

Sets if logging access to the Knot.x HTTP server is enabled or not. Default is enabled ('true')

Parameters:

enabled - true if logging access log is enabled

Returns:

reference to this, so the API can be used fluently

isImmediate

public boolean isImmediate()

Returns:

is access log is collected after request arrives (true), or after sending response (false)

setImmediate

public AccessLogOptions setImmediate(boolean immediate)

Configure when to collect access log. True if after request arrives, false after sending response.

Parameters:

immediate - log access after request arrives (true), or after response sent (false)

Returns:

reference to this, so the API can be used fluently

getFormat

public io.vertx.ext.web.handler.LoggerFormat getFormat()

Returns:

format of the access log

setFormat

public AccessLogOptions setFormat(io.vertx.ext.web.handler.LoggerFormat format)

Set format of access log. Default is LoggerFormat.DEFAULT. Available values are:

• DEFAULT remote-client - - [timestamp] "method uri version" status content-length "referrer" "user-agent
• SHORT remote-client - method uri version status content-length duration ms
• TINY method uri status - content-length duration

Parameters:

format - format of the access log

Returns:

reference to this, so the API can be used fluently