org.glassfish.grizzly.http.server.accesslog

Class AccessLogBuilder

java.lang.Object

org.glassfish.grizzly.http.server.accesslog.AccessLogBuilder

public class AccessLogBuilder
extends Object

A simple builder to configure access logging for Grizzly.

If the format is left unspecified, the default Apache combined format will be used.

If the time zone is left unspecified, the default time zone will be used.

Author:

Pier Fumagalli, USRZ.com

Constructor Summary

Constructors

Constructor and Description
AccessLogBuilder(File file) Create a new AccessLogBuilder writing logs to the specified file.
AccessLogBuilder(String file) Create a new AccessLogBuilder writing logs to the specified file.

Method Summary

Modifier and Type	Method and Description
AccessLogProbe	build() Build an AccessLogProbe instance which can be injected into an HttpServer's monitoring configuration to provide access logging.
AccessLogBuilder	format(AccessLogFormat format) Set the AccessLogFormat instance that will be used by the access logs configured by this instance.
AccessLogBuilder	format(String format) Set the format as a String compatible with the default Apache access log format that will be used by the access logs configured by this instance.
ServerConfiguration	instrument(ServerConfiguration serverConfiguration) Build an AccessLogProbe instance and directly instrument it in an HttpServer's monitoring configuration to provide access logging.
AccessLogBuilder	rotatedDaily() Set up automatic log-file rotation, on a daily basis.
AccessLogBuilder	rotatedHourly() Set up automatic log-file rotation, on a hourly basis.
AccessLogBuilder	rotationPattern(String rotationPattern) Set up automatic log-file rotation based on a specified SimpleDateFormat pattern.
AccessLogBuilder	statusThreshold(int statusThreshold) Set the minimum response status that will trigger an entry in an access log configured by this instance.
AccessLogBuilder	synchronous(boolean synchronous) Specify whether access log entries should be written synchronously or not.
AccessLogBuilder	timeZone(String timeZone) Set the time zone that will be used to represent dates.
AccessLogBuilder	timeZone(TimeZone timeZone) Set the time zone that will be used to represent dates.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessLogBuilder

public AccessLogBuilder(String file)

Create a new AccessLogBuilder writing logs to the specified file.

Parameters:

file - The location of the access log file.

AccessLogBuilder

public AccessLogBuilder(File file)

Create a new AccessLogBuilder writing logs to the specified file.

Parameters:

file - The location of the access log file.

Method Detail

build

public AccessLogProbe build()

Build an AccessLogProbe instance which can be injected into an HttpServer's monitoring configuration to provide access logging.

instrument

public ServerConfiguration instrument(ServerConfiguration serverConfiguration)

Build an AccessLogProbe instance and directly instrument it in an HttpServer's monitoring configuration to provide access logging.

Parameters:

serverConfiguration - The ServerConfiguration to instrument.

format

public AccessLogBuilder format(AccessLogFormat format)

Set the AccessLogFormat instance that will be used by the access logs configured by this instance.

format

public AccessLogBuilder format(String format)

Set the format as a String compatible with the default Apache access log format that will be used by the access logs configured by this instance.

timeZone

public AccessLogBuilder timeZone(TimeZone timeZone)

Set the time zone that will be used to represent dates.

timeZone

public AccessLogBuilder timeZone(String timeZone)

Set the time zone that will be used to represent dates.

The time zone will be looked up by time zone identifier, and if this is invalid or unrecognized, it will default to GMT.

statusThreshold

public AccessLogBuilder statusThreshold(int statusThreshold)

Set the minimum response status that will trigger an entry in an access log configured by this instance.

For example a threshold of 500 will only generate log entries for requests that terminated in error.

rotatedHourly

public AccessLogBuilder rotatedHourly()

Set up automatic log-file rotation, on a hourly basis.

For example, if the file name specified at construction was access.log, files will be archived on a hourly basis with names like access-yyyyMMDDhh.log.

rotatedDaily

public AccessLogBuilder rotatedDaily()

Set up automatic log-file rotation, on a daily basis.

For example, if the file name specified at construction was access.log, files will be archived on a daily basis with names like access-yyyyMMDD.log.

rotationPattern

public AccessLogBuilder rotationPattern(String rotationPattern)

Set up automatic log-file rotation based on a specified SimpleDateFormat pattern.

For example, if the file name specified at construction was access.log and the rotation pattern specified here is EEE (day name in week), files will be archived on a daily basis with names like access-Mon.log, access-Tue.log, ...

synchronous

public AccessLogBuilder synchronous(boolean synchronous)

Specify whether access log entries should be written synchronously or not.

If false (the default) a QueueingAppender will be used to enqueue entries and append to the final appenders when possible.