package ch.qos.logback.access.jetty;
import java.io.File;
import java.util.HashMap;
import java.util.Iterator;
import org.mortbay.jetty.Request;
import org.mortbay.jetty.RequestLog;
import org.mortbay.jetty.Response;
import ch.qos.logback.access.joran.JoranConfigurator;
import ch.qos.logback.access.spi.AccessEvent;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.ContextBase;
import ch.qos.logback.core.CoreGlobal;
import ch.qos.logback.core.filter.Filter;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.spi.AppenderAttachable;
import ch.qos.logback.core.spi.AppenderAttachableImpl;
import ch.qos.logback.core.spi.FilterAttachable;
import ch.qos.logback.core.spi.FilterAttachableImpl;
import ch.qos.logback.core.spi.FilterReply;
import ch.qos.logback.core.status.ErrorStatus;
import ch.qos.logback.core.status.InfoStatus;
import ch.qos.logback.core.status.WarnStatus;
import ch.qos.logback.core.util.StatusPrinter;
/**
* This class is logback's implementation of jetty's RequestLog interface.
* <p>
* It can be seen as logback classic's LoggerContext. Appenders can be attached
* directly to RequestLogImpl and RequestLogImpl uses the same StatusManager as
* LoggerContext does. It also provides containers for properties.
* <p>
* To configure jetty in order to use RequestLogImpl, the following lines must
* be added to the jetty configuration file, namely <em>etc/jetty.xml</em>:
*
* <pre>
* <Ref id="requestLog">
* <Set name="requestLog">
* <New id="requestLogImpl" class="ch.qos.logback.access.jetty.RequestLogImpl"></New>
* </Set>
* </Ref>
* </pre>
*
* By default, RequestLogImpl looks for a logback configuration file called
* logback-access.xml, in the same folder where jetty.xml is located, that is
* <em>etc/logback-access.xml</em>. The logback-access.xml file is slightly
* different than the usual logback classic configuration file. Most of it is
* the same: Appenders and Layouts are declared the exact same way. However,
* loggers elements are not allowed.
* <p>
* It is possible to put the logback configuration file anywhere, as long as
* it's path is specified. Here is another example, with a path to the
* logback-access.xml file.
*
* <pre>
* <Ref id="requestLog">
* <Set name="requestLog">
* <New id="requestLogImpl" class="ch.qos.logback.access.jetty.RequestLogImpl"></New>
* <Set name="fileName">path/to/logback.xml</Set>
* </Set>
* </Ref>
* </pre>
*
* <p>
* Here is a sample logback-access.xml file that can be used right away:
*
* <pre>
* <configuration>
* <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
* <layout class="ch.qos.logback.access.PatternLayout">
* <param name="Pattern" value="%date %server %remoteIP %clientHost %user %requestURL" />
* </layout>
* </appender>
*
* <appender-ref ref="STDOUT" />
* </configuration>
* </pre>
*
* <p>
* Another configuration file, using SMTPAppender, could be:
*
* <pre>
* <configuration>
* <appender name="SMTP" class="ch.qos.logback.access.net.SMTPAppender">
* <layout class="ch.qos.logback.access.PatternLayout">
* <param name="pattern" value="%remoteIP [%date] %requestURL %statusCode %bytesSent" />
* </layout>
* <param name="From" value="sender@domaine.org" />
* <param name="SMTPHost" value="mail.domain.org" />
* <param name="Subject" value="Last Event: %statusCode %requestURL" />
* <param name="To" value="server_admin@domain.org" />
* </appender>
* <appender-ref ref="SMTP" />
* </configuration>
* </pre>
*
* <p>
* A special, module-specific implementation of PatternLayout was implemented to
* allow http-specific patterns to be used. The
* {@link ch.qos.logback.access.PatternLayout} provides a way to format the
* logging output that is just as easy and flexible as the usual PatternLayout.
* For more information about the general use of a PatternLayout, please refer
* to logback classic's {@link ch.qos.logback.classic.PatternLayout}. For
* information about logback access' specific PatternLayout, please refer to
* it's javadoc.
*
* @author Ceki Gülcü
* @author Sébastien Pennec
*/
public class RequestLogImpl extends ContextBase implements RequestLog,
AppenderAttachable, FilterAttachable {
public final static String DEFAULT_CONFIG_FILE = "etc" + File.separatorChar
+ "logback-access.xml";
AppenderAttachableImpl aai = new AppenderAttachableImpl();
FilterAttachableImpl fai = new FilterAttachableImpl();
String filename;
public RequestLogImpl() {
putObject(CoreGlobal.EVALUATOR_MAP, new HashMap());
}
public void log(Request jettyRequest, Response jettyResponse) {
JettyServerAdapter adapter = new JettyServerAdapter(jettyRequest,
jettyResponse);
AccessEvent accessEvent = new AccessEvent(jettyRequest, jettyResponse,
adapter);
if (getFilterChainDecision(accessEvent) == FilterReply.DENY) {
return;
}
// TODO better exception handling
aai.appendLoopOnAppenders(accessEvent);
}
public void start() {
if (filename == null) {
String jettyHomeProperty = System.getProperty("jetty.home");
filename = jettyHomeProperty + File.separatorChar + DEFAULT_CONFIG_FILE;
getStatusManager().add(
new WarnStatus("filename property not set. Assuming [" + filename
+ "]", this));
}
try {
File configFile = new File(filename);
if (configFile.exists()) {
JoranConfigurator jc = new JoranConfigurator();
jc.setContext(this);
jc.doConfigure(filename);
} else {
getStatusManager().add(
new ErrorStatus("[" + filename + "] does not exist", this));
}
if (getName() == null) {
setName("LogbackRequestLog");
}
RequestLogRegistry.register(this);
getStatusManager().add(
new InfoStatus("RequestLog added to RequestLogRegistry with name: "
+ getName(), this));
} catch (JoranException e) {
// errors have been registered as status messages
}
StatusPrinter.print(getStatusManager());
}
public void stop() {
aai.detachAndStopAllAppenders();
}
public boolean isRunning() {
return false;
}
public void setFileName(String filename) {
this.filename = filename;
}
public boolean isStarted() {
return true;
}
public boolean isStarting() {
return false;
}
public boolean isStopping() {
return false;
}
public boolean isFailed() {
return false;
}
public void addAppender(Appender newAppender) {
aai.addAppender(newAppender);
}
public Iterator iteratorForAppenders() {
return aai.iteratorForAppenders();
}
public Appender getAppender(String name) {
return aai.getAppender(name);
}
public boolean isAttached(Appender appender) {
return aai.isAttached(appender);
}
public void detachAndStopAllAppenders() {
aai.detachAndStopAllAppenders();
}
public boolean detachAppender(Appender appender) {
return aai.detachAppender(appender);
}
public Appender detachAppender(String name) {
return aai.detachAppender(name);
}
public void addFilter(Filter newFilter) {
fai.addFilter(newFilter);
}
public void clearAllFilters() {
fai.clearAllFilters();
}
public FilterReply getFilterChainDecision(Object event) {
return fai.getFilterChainDecision(event);
}
public Filter getFirstFilter() {
return fai.getFirstFilter();
}
}