| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Wed Jun 07 15:10:50 EDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>NCSARequestLog (Jetty :: Project 9.2.22.v20170606 API)</title> |
| <meta name="date" content="2017-06-07"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NCSARequestLog (Jetty :: Project 9.2.22.v20170606 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCSARequestLog.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/jetty/server/LowResourceMonitor.html" title="class in org.eclipse.jetty.server"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/server/NegotiatingServerConnection.html" title="class in org.eclipse.jetty.server"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/server/NCSARequestLog.html" target="_top">Frames</a></li> |
| <li><a href="NCSARequestLog.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_classes_inherited_from_class_org.eclipse.jetty.util.component.AbstractLifeCycle">Nested</a> | </li> |
| <li><a href="#fields_inherited_from_class_org.eclipse.jetty.server.AbstractNCSARequestLog">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.jetty.server</div> |
| <h2 title="Class NCSARequestLog" class="title">Class NCSARequestLog</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">org.eclipse.jetty.server.AbstractNCSARequestLog</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.server.NCSARequestLog</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/eclipse/jetty/server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/eclipse/jetty/server/AsyncNCSARequestLog.html" title="class in org.eclipse.jetty.server">AsyncNCSARequestLog</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../org/eclipse/jetty/util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>(<a href="../../../../org/eclipse/jetty/util/annotation/ManagedObject.html#value()">value</a>="NCSA standard format request log") |
| public class <span class="strong">NCSARequestLog</span> |
| extends <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a> |
| implements <a href="../../../../org/eclipse/jetty/server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a></pre> |
| <div class="block">This <a href="../../../../org/eclipse/jetty/server/RequestLog.html" title="interface in org.eclipse.jetty.server"><code>RequestLog</code></a> implementation outputs logs in the pseudo-standard |
| NCSA common log format. Configuration options allow a choice between the |
| standard Common Log Format (as used in the 3 log format) and the Combined Log |
| Format (single log format). This log format can be output by most web |
| servers, and almost all web log analysis software can understand these |
| formats.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.eclipse.jetty.server.AbstractNCSARequestLog"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.server.<a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#LOG">LOG</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#NCSARequestLog()">NCSARequestLog</a></strong>()</code> |
| <div class="block">Create request log object with default settings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#NCSARequestLog(java.lang.String)">NCSARequestLog</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</code> |
| <div class="block">Create request log object with specified output file name.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#doStart()">doStart</a></strong>()</code> |
| <div class="block">Set up request logging and open log file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#doStop()">doStop</a></strong>()</code> |
| <div class="block">Close the log file and perform cleanup.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#getDatedFilename()">getDatedFilename</a></strong>()</code> |
| <div class="block">Retrieve the file name of the request log with the expanded |
| date wildcard if the output is written to the disk using |
| <a href="../../../../org/eclipse/jetty/util/RolloverFileOutputStream.html" title="class in org.eclipse.jetty.util"><code>RolloverFileOutputStream</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#getFilename()">getFilename</a></strong>()</code> |
| <div class="block">Retrieve the output file name of the request log.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#getFilenameDateFormat()">getFilenameDateFormat</a></strong>()</code> |
| <div class="block">Retrieve the file name date format string.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#getRetainDays()">getRetainDays</a></strong>()</code> |
| <div class="block">Retrieve the number of days before rotated log files are deleted.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#isAppend()">isAppend</a></strong>()</code> |
| <div class="block">Retrieve append to log flag.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#isEnabled()">isEnabled</a></strong>()</code> |
| <div class="block">Is logging enabled</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#setAppend(boolean)">setAppend</a></strong>(boolean append)</code> |
| <div class="block">Set append to log flag.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#setFilename(java.lang.String)">setFilename</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</code> |
| <div class="block">Set the output file name of the request log.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#setFilenameDateFormat(java.lang.String)">setFilenameDateFormat</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> logFileDateFormat)</code> |
| <div class="block">Set the log file name date format.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#setRetainDays(int)">setRetainDays</a></strong>(int retainDays)</code> |
| <div class="block">Set the number of days before rotated log files are deleted.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/eclipse/jetty/server/NCSARequestLog.html#write(java.lang.String)">write</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> requestEntry)</code> |
| <div class="block">Write requestEntry out.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.eclipse.jetty.server.AbstractNCSARequestLog"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.<a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getIgnorePaths()">getIgnorePaths</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getLogCookies()">getLogCookies</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getLogDateFormat()">getLogDateFormat</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getLogLatency()">getLogLatency</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getLogLocale()">getLogLocale</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getLogServer()">getLogServer</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getLogTimeZone()">getLogTimeZone</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#getPreferProxiedForAddress()">getPreferProxiedForAddress</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#isExtended()">isExtended</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#isLogDispatch()">isLogDispatch</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#log(org.eclipse.jetty.server.Request,%20org.eclipse.jetty.server.Response)">log</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#logExtended(org.eclipse.jetty.server.Request,%20org.eclipse.jetty.server.Response,%20java.lang.StringBuilder)">logExtended</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setExtended(boolean)">setExtended</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setIgnorePaths(java.lang.String[])">setIgnorePaths</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogCookies(boolean)">setLogCookies</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogDateFormat(java.lang.String)">setLogDateFormat</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogDispatch(boolean)">setLogDispatch</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogLatency(boolean)">setLogLatency</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogLocale(java.util.Locale)">setLogLocale</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogServer(boolean)">setLogServer</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setLogTimeZone(java.lang.String)">setLogTimeZone</a>, <a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#setPreferProxiedForAddress(boolean)">setPreferProxiedForAddress</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#stop()">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.eclipse.jetty.server.RequestLog"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.server.<a href="../../../../org/eclipse/jetty/server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/server/RequestLog.html#log(org.eclipse.jetty.server.Request,%20org.eclipse.jetty.server.Response)">log</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#isFailed()">isFailed</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#isRunning()">isRunning</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#isStarted()">isStarted</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#isStarting()">isStarting</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#isStopped()">isStopped</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#isStopping()">isStopping</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#start()">start</a>, <a href="../../../../org/eclipse/jetty/util/component/LifeCycle.html#stop()">stop</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="NCSARequestLog()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NCSARequestLog</h4> |
| <pre>public NCSARequestLog()</pre> |
| <div class="block">Create request log object with default settings.</div> |
| </li> |
| </ul> |
| <a name="NCSARequestLog(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NCSARequestLog</h4> |
| <pre>public NCSARequestLog(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</pre> |
| <div class="block">Create request log object with specified output file name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the file name for the request log. |
| This may be in the format expected |
| by <a href="../../../../org/eclipse/jetty/util/RolloverFileOutputStream.html" title="class in org.eclipse.jetty.util"><code>RolloverFileOutputStream</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setFilename(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilename</h4> |
| <pre>public void setFilename(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</pre> |
| <div class="block">Set the output file name of the request log. |
| The file name may be in the format expected by |
| <a href="../../../../org/eclipse/jetty/util/RolloverFileOutputStream.html" title="class in org.eclipse.jetty.util"><code>RolloverFileOutputStream</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - file name of the request log</dd></dl> |
| </li> |
| </ul> |
| <a name="getFilename()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilename</h4> |
| <pre><a href="../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#value()">value</a>="file of log") |
| public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFilename()</pre> |
| <div class="block">Retrieve the output file name of the request log.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>file name of the request log</dd></dl> |
| </li> |
| </ul> |
| <a name="getDatedFilename()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatedFilename</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDatedFilename()</pre> |
| <div class="block">Retrieve the file name of the request log with the expanded |
| date wildcard if the output is written to the disk using |
| <a href="../../../../org/eclipse/jetty/util/RolloverFileOutputStream.html" title="class in org.eclipse.jetty.util"><code>RolloverFileOutputStream</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>file name of the request log, or null if not applicable</dd></dl> |
| </li> |
| </ul> |
| <a name="isEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnabled</h4> |
| <pre>protected boolean isEnabled()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#isEnabled()">AbstractNCSARequestLog</a></code></strong></div> |
| <div class="block">Is logging enabled</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#isEnabled()">isEnabled</a></code> in class <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRetainDays(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRetainDays</h4> |
| <pre>public void setRetainDays(int retainDays)</pre> |
| <div class="block">Set the number of days before rotated log files are deleted.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>retainDays</code> - number of days to keep a log file</dd></dl> |
| </li> |
| </ul> |
| <a name="getRetainDays()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetainDays</h4> |
| <pre><a href="../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#value()">value</a>="number of days that log files are kept") |
| public int getRetainDays()</pre> |
| <div class="block">Retrieve the number of days before rotated log files are deleted.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>number of days to keep a log file</dd></dl> |
| </li> |
| </ul> |
| <a name="setAppend(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAppend</h4> |
| <pre>public void setAppend(boolean append)</pre> |
| <div class="block">Set append to log flag.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>append</code> - true - request log file will be appended after restart, |
| false - request log file will be overwritten after restart</dd></dl> |
| </li> |
| </ul> |
| <a name="isAppend()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAppend</h4> |
| <pre><a href="../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#value()">value</a>="existing log files are appends to the new one") |
| public boolean isAppend()</pre> |
| <div class="block">Retrieve append to log flag.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>value of the flag</dd></dl> |
| </li> |
| </ul> |
| <a name="setFilenameDateFormat(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilenameDateFormat</h4> |
| <pre>public void setFilenameDateFormat(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> logFileDateFormat)</pre> |
| <div class="block">Set the log file name date format.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>logFileDateFormat</code> - format string that is passed to <a href="../../../../org/eclipse/jetty/util/RolloverFileOutputStream.html" title="class in org.eclipse.jetty.util"><code>RolloverFileOutputStream</code></a></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/eclipse/jetty/util/RolloverFileOutputStream.html#RolloverFileOutputStream(java.lang.String,%20boolean,%20int,%20java.util.TimeZone,%20java.lang.String,%20java.lang.String)"><code>RolloverFileOutputStream.RolloverFileOutputStream(String, boolean, int, TimeZone, String, String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getFilenameDateFormat()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilenameDateFormat</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFilenameDateFormat()</pre> |
| <div class="block">Retrieve the file name date format string.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the log File Date Format</dd></dl> |
| </li> |
| </ul> |
| <a name="write(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public void write(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> requestEntry) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#write(java.lang.String)">AbstractNCSARequestLog</a></code></strong></div> |
| <div class="block">Write requestEntry out. (to disk or slf4j log)</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#write(java.lang.String)">write</a></code> in class <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="doStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre>protected void doStart() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set up request logging and open log file.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#doStart()">doStart</a></code> in class <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#doStart()"><code>AbstractLifeCycle.doStart()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="doStop()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>doStop</h4> |
| <pre>protected void doStop() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Close the log file and perform cleanup.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html#doStop()">doStop</a></code> in class <code><a href="../../../../org/eclipse/jetty/server/AbstractNCSARequestLog.html" title="class in org.eclipse.jetty.server">AbstractNCSARequestLog</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#doStop()"><code>AbstractLifeCycle.doStop()</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCSARequestLog.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/jetty/server/LowResourceMonitor.html" title="class in org.eclipse.jetty.server"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/server/NegotiatingServerConnection.html" title="class in org.eclipse.jetty.server"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/server/NCSARequestLog.html" target="_top">Frames</a></li> |
| <li><a href="NCSARequestLog.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_classes_inherited_from_class_org.eclipse.jetty.util.component.AbstractLifeCycle">Nested</a> | </li> |
| <li><a href="#fields_inherited_from_class_org.eclipse.jetty.server.AbstractNCSARequestLog">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1995-2017 <a href="http://webtide.com">Webtide</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
