org.apache.sling.engine
Interface RequestLog

public interface RequestLog

The RequestLog interface defines the API to be implemented by providers of destinations for request log information. To be able to any request log service writing to output type RequestLog Service the respective services must be registered with the OSGi service registry.

Field Summary

static java.lang.String

REQUEST_LOG_NAME The name of the service property which is compared to the name of the RequestLog service to be used to write the log messages (value is "requestlog.name").

Method Summary

void	close() Closes this request log.
void	write(java.lang.String message) Writes the given message to the output destination.

Field Detail

REQUEST_LOG_NAME

static final java.lang.String REQUEST_LOG_NAME

The name of the service property which is compared to the name of the RequestLog service to be used to write the log messages (value is "requestlog.name").

See Also:

Constant Field Values

Method Detail

write

void write(java.lang.String message)

Writes the given message to the output destination. For example a file based implementation might write the message into a log file while an implementation supporting Unix syslogd might send the message to a syslogd server.

Parameters:

message - The message to be logged.

close

void close()

Closes this request log. This method is called by the request logging infrastructure, when this instance is not used anymore. Hence, this method allows for any cleanup work to be done.