/lib/apache-log4j/site/apidocs/org/apache/log4j/jdbc/JDBCAppender.html

https://bitbucket.org/arkban/somersault · HTML · 1063 lines · 928 code · 111 blank · 24 comment · 0 complexity · 9027ce69d7dd24b5457bcf07a74a8132 MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_16) -->
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <TITLE>
  8. JDBCAppender (Apache Log4j 1.2.16 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2010-03-30">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="JDBCAppender (Apache Log4j 1.2.16 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDBCAppender.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;PREV CLASS&nbsp;
  52. &nbsp;NEXT CLASS</FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../index.html?org/apache/log4j/jdbc/JDBCAppender.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="JDBCAppender.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. org.apache.log4j.jdbc</FONT>
  82. <BR>
  83. Class JDBCAppender</H2>
  84. <PRE>
  85. <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  86. <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">org.apache.log4j.AppenderSkeleton</A>
  87. <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.log4j.jdbc.JDBCAppender</B>
  88. </PRE>
  89. <DL>
  90. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/log4j/Appender.html" title="interface in org.apache.log4j">Appender</A>, <A HREF="../../../../org/apache/log4j/spi/OptionHandler.html" title="interface in org.apache.log4j.spi">OptionHandler</A></DD>
  91. </DL>
  92. <HR>
  93. <DL>
  94. <DT><PRE>public class <B>JDBCAppender</B><DT>extends <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</A><DT>implements <A HREF="../../../../org/apache/log4j/Appender.html" title="interface in org.apache.log4j">Appender</A></DL>
  95. </PRE>
  96. <P>
  97. The JDBCAppender provides for sending log events to a database.
  98. <p><b><font color="#FF2222">WARNING: This version of JDBCAppender
  99. is very likely to be completely replaced in the future. Moreoever,
  100. it does not log exceptions</font></b>.
  101. <p>Each append call adds to an <code>ArrayList</code> buffer. When
  102. the buffer is filled each log event is placed in a sql statement
  103. (configurable) and executed.
  104. <b>BufferSize</b>, <b>db URL</b>, <b>User</b>, & <b>Password</b> are
  105. configurable options in the standard log4j ways.
  106. <p>The <code>setSql(String sql)</code> sets the SQL statement to be
  107. used for logging -- this statement is sent to a
  108. <code>PatternLayout</code> (either created automaticly by the
  109. appender or added by the user). Therefore by default all the
  110. conversion patterns in <code>PatternLayout</code> can be used
  111. inside of the statement. (see the test cases for examples)
  112. <p>Overriding the <A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getLogStatement(org.apache.log4j.spi.LoggingEvent)"><CODE>getLogStatement(org.apache.log4j.spi.LoggingEvent)</CODE></A> method allows more
  113. explicit control of the statement used for logging.
  114. <p>For use as a base class:
  115. <ul>
  116. <li>Override <code>getConnection()</code> to pass any connection
  117. you want. Typically this is used to enable application wide
  118. connection pooling.
  119. <li>Override <code>closeConnection(Connection con)</code> -- if
  120. you override getConnection make sure to implement
  121. <code>closeConnection</code> to handle the connection you
  122. generated. Typically this would return the connection to the
  123. pool it came from.
  124. <li>Override <code>getLogStatement(LoggingEvent event)</code> to
  125. produce specialized or dynamic statements. The default uses the
  126. sql option value.
  127. </ul>
  128. <P>
  129. <P>
  130. <DL>
  131. <DT><B>Author:</B></DT>
  132. <DD>Kevin Steppe (<A HREF="mailto:ksteppe@pacbell.net">ksteppe@pacbell.net</A>)</DD>
  133. </DL>
  134. <HR>
  135. <P>
  136. <!-- =========== FIELD SUMMARY =========== -->
  137. <A NAME="field_summary"><!-- --></A>
  138. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  139. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  140. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  141. <B>Field Summary</B></FONT></TH>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  145. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A></CODE></FONT></TD>
  146. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#buffer">buffer</A></B></CODE>
  147. <BR>
  148. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ArrayList holding the buffer of Logging Events.</TD>
  149. </TR>
  150. <TR BGCOLOR="white" CLASS="TableRowColor">
  151. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  152. <CODE>protected &nbsp;int</CODE></FONT></TD>
  153. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#bufferSize">bufferSize</A></B></CODE>
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;size of LoggingEvent buffer before writting to the database.</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</A></CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#connection">connection</A></B></CODE>
  161. <BR>
  162. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connection used by default.</TD>
  163. </TR>
  164. <TR BGCOLOR="white" CLASS="TableRowColor">
  165. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  166. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  167. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#databasePassword">databasePassword</A></B></CODE>
  168. <BR>
  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User to use for default connection handling</TD>
  170. </TR>
  171. <TR BGCOLOR="white" CLASS="TableRowColor">
  172. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  173. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  174. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#databaseURL">databaseURL</A></B></CODE>
  175. <BR>
  176. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;URL of the DB for default connection handling</TD>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  181. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#databaseUser">databaseUser</A></B></CODE>
  182. <BR>
  183. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User to connect as for default connection handling</TD>
  184. </TR>
  185. <TR BGCOLOR="white" CLASS="TableRowColor">
  186. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  187. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A></CODE></FONT></TD>
  188. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#removes">removes</A></B></CODE>
  189. <BR>
  190. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Helper object for clearing out the buffer</TD>
  191. </TR>
  192. <TR BGCOLOR="white" CLASS="TableRowColor">
  193. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  194. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  195. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#sqlStatement">sqlStatement</A></B></CODE>
  196. <BR>
  197. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores the string given to the pattern layout for conversion into a SQL
  198. statement, eg: insert into LogTable (Thread, Class, Message) values
  199. ("%t", "%c", "%m").</TD>
  200. </TR>
  201. </TABLE>
  202. &nbsp;<A NAME="fields_inherited_from_class_org.apache.log4j.AppenderSkeleton"><!-- --></A>
  203. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  204. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  205. <TH ALIGN="left"><B>Fields inherited from class org.apache.log4j.<A HREF="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</A></B></TH>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD><CODE><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#closed">closed</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#errorHandler">errorHandler</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#headFilter">headFilter</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#layout">layout</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#name">name</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#tailFilter">tailFilter</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#threshold">threshold</A></CODE></TD>
  209. </TR>
  210. </TABLE>
  211. &nbsp;
  212. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  213. <A NAME="constructor_summary"><!-- --></A>
  214. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  215. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  216. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  217. <B>Constructor Summary</B></FONT></TH>
  218. </TR>
  219. <TR BGCOLOR="white" CLASS="TableRowColor">
  220. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#JDBCAppender()">JDBCAppender</A></B>()</CODE>
  221. <BR>
  222. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  223. </TR>
  224. </TABLE>
  225. &nbsp;
  226. <!-- ========== METHOD SUMMARY =========== -->
  227. <A NAME="method_summary"><!-- --></A>
  228. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  229. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  230. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  231. <B>Method Summary</B></FONT></TH>
  232. </TR>
  233. <TR BGCOLOR="white" CLASS="TableRowColor">
  234. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  235. <CODE>&nbsp;void</CODE></FONT></TD>
  236. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#append(org.apache.log4j.spi.LoggingEvent)">append</A></B>(<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;event)</CODE>
  237. <BR>
  238. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the event to the buffer.</TD>
  239. </TR>
  240. <TR BGCOLOR="white" CLASS="TableRowColor">
  241. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  242. <CODE>&nbsp;void</CODE></FONT></TD>
  243. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#close()">close</A></B>()</CODE>
  244. <BR>
  245. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the appender, flushing the buffer first then closing the default
  246. connection if it is open.</TD>
  247. </TR>
  248. <TR BGCOLOR="white" CLASS="TableRowColor">
  249. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  250. <CODE>protected &nbsp;void</CODE></FONT></TD>
  251. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#closeConnection(java.sql.Connection)">closeConnection</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</A>&nbsp;con)</CODE>
  252. <BR>
  253. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override this to return the connection to a pool, or to clean up the
  254. resource.</TD>
  255. </TR>
  256. <TR BGCOLOR="white" CLASS="TableRowColor">
  257. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  258. <CODE>protected &nbsp;void</CODE></FONT></TD>
  259. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#execute(java.lang.String)">execute</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;sql)</CODE>
  260. <BR>
  261. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override this to provide an alertnate method of getting
  262. connections (such as caching).</TD>
  263. </TR>
  264. <TR BGCOLOR="white" CLASS="TableRowColor">
  265. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  266. <CODE>&nbsp;void</CODE></FONT></TD>
  267. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#finalize()">finalize</A></B>()</CODE>
  268. <BR>
  269. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;closes the appender before disposal</TD>
  270. </TR>
  271. <TR BGCOLOR="white" CLASS="TableRowColor">
  272. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  273. <CODE>&nbsp;void</CODE></FONT></TD>
  274. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#flushBuffer()">flushBuffer</A></B>()</CODE>
  275. <BR>
  276. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loops through the buffer of LoggingEvents, gets a
  277. sql string from getLogStatement() and sends it to execute().</TD>
  278. </TR>
  279. <TR BGCOLOR="white" CLASS="TableRowColor">
  280. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  281. <CODE>&nbsp;int</CODE></FONT></TD>
  282. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getBufferSize()">getBufferSize</A></B>()</CODE>
  283. <BR>
  284. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  285. </TR>
  286. <TR BGCOLOR="white" CLASS="TableRowColor">
  287. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  288. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</A></CODE></FONT></TD>
  289. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getConnection()">getConnection</A></B>()</CODE>
  290. <BR>
  291. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override this to link with your connection pooling system.</TD>
  292. </TR>
  293. <TR BGCOLOR="white" CLASS="TableRowColor">
  294. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  295. <CODE>&nbsp;boolean</CODE></FONT></TD>
  296. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getLocationInfo()">getLocationInfo</A></B>()</CODE>
  297. <BR>
  298. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets whether the location of the logging request call
  299. should be captured.</TD>
  300. </TR>
  301. <TR BGCOLOR="white" CLASS="TableRowColor">
  302. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  303. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  304. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getLogStatement(org.apache.log4j.spi.LoggingEvent)">getLogStatement</A></B>(<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;event)</CODE>
  305. <BR>
  306. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;By default getLogStatement sends the event to the required Layout object.</TD>
  307. </TR>
  308. <TR BGCOLOR="white" CLASS="TableRowColor">
  309. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  310. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  311. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getPassword()">getPassword</A></B>()</CODE>
  312. <BR>
  313. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  314. </TR>
  315. <TR BGCOLOR="white" CLASS="TableRowColor">
  316. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  317. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  318. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getSql()">getSql</A></B>()</CODE>
  319. <BR>
  320. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns pre-formated statement eg: insert into LogTable (msg) values ("%m")</TD>
  321. </TR>
  322. <TR BGCOLOR="white" CLASS="TableRowColor">
  323. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  324. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  325. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getURL()">getURL</A></B>()</CODE>
  326. <BR>
  327. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  328. </TR>
  329. <TR BGCOLOR="white" CLASS="TableRowColor">
  330. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  331. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  332. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#getUser()">getUser</A></B>()</CODE>
  333. <BR>
  334. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  335. </TR>
  336. <TR BGCOLOR="white" CLASS="TableRowColor">
  337. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  338. <CODE>&nbsp;boolean</CODE></FONT></TD>
  339. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#requiresLayout()">requiresLayout</A></B>()</CODE>
  340. <BR>
  341. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;JDBCAppender requires a layout.</TD>
  342. </TR>
  343. <TR BGCOLOR="white" CLASS="TableRowColor">
  344. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  345. <CODE>&nbsp;void</CODE></FONT></TD>
  346. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setBufferSize(int)">setBufferSize</A></B>(int&nbsp;newBufferSize)</CODE>
  347. <BR>
  348. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  349. </TR>
  350. <TR BGCOLOR="white" CLASS="TableRowColor">
  351. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  352. <CODE>&nbsp;void</CODE></FONT></TD>
  353. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setDriver(java.lang.String)">setDriver</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;driverClass)</CODE>
  354. <BR>
  355. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ensures that the given driver class has been loaded for sql connection
  356. creation.</TD>
  357. </TR>
  358. <TR BGCOLOR="white" CLASS="TableRowColor">
  359. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  360. <CODE>&nbsp;void</CODE></FONT></TD>
  361. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setLocationInfo(boolean)">setLocationInfo</A></B>(boolean&nbsp;flag)</CODE>
  362. <BR>
  363. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <b>LocationInfo</b> option takes a boolean value.</TD>
  364. </TR>
  365. <TR BGCOLOR="white" CLASS="TableRowColor">
  366. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  367. <CODE>&nbsp;void</CODE></FONT></TD>
  368. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setPassword(java.lang.String)">setPassword</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;password)</CODE>
  369. <BR>
  370. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  371. </TR>
  372. <TR BGCOLOR="white" CLASS="TableRowColor">
  373. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  374. <CODE>&nbsp;void</CODE></FONT></TD>
  375. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setSql(java.lang.String)">setSql</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;s)</CODE>
  376. <BR>
  377. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  378. </TR>
  379. <TR BGCOLOR="white" CLASS="TableRowColor">
  380. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  381. <CODE>&nbsp;void</CODE></FONT></TD>
  382. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setURL(java.lang.String)">setURL</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;url)</CODE>
  383. <BR>
  384. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  385. </TR>
  386. <TR BGCOLOR="white" CLASS="TableRowColor">
  387. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  388. <CODE>&nbsp;void</CODE></FONT></TD>
  389. <TD><CODE><B><A HREF="../../../../org/apache/log4j/jdbc/JDBCAppender.html#setUser(java.lang.String)">setUser</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;user)</CODE>
  390. <BR>
  391. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  392. </TR>
  393. </TABLE>
  394. &nbsp;<A NAME="methods_inherited_from_class_org.apache.log4j.AppenderSkeleton"><!-- --></A>
  395. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  396. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  397. <TH ALIGN="left"><B>Methods inherited from class org.apache.log4j.<A HREF="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</A></B></TH>
  398. </TR>
  399. <TR BGCOLOR="white" CLASS="TableRowColor">
  400. <TD><CODE><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#activateOptions()">activateOptions</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#addFilter(org.apache.log4j.spi.Filter)">addFilter</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#clearFilters()">clearFilters</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#doAppend(org.apache.log4j.spi.LoggingEvent)">doAppend</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#getErrorHandler()">getErrorHandler</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#getFilter()">getFilter</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#getFirstFilter()">getFirstFilter</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#getLayout()">getLayout</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#getName()">getName</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#getThreshold()">getThreshold</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#isAsSevereAsThreshold(org.apache.log4j.Priority)">isAsSevereAsThreshold</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#setErrorHandler(org.apache.log4j.spi.ErrorHandler)">setErrorHandler</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#setLayout(org.apache.log4j.Layout)">setLayout</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#setThreshold(org.apache.log4j.Priority)">setThreshold</A></CODE></TD>
  401. </TR>
  402. </TABLE>
  403. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  404. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  405. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  406. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
  407. </TR>
  408. <TR BGCOLOR="white" CLASS="TableRowColor">
  409. <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.3/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://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  410. </TR>
  411. </TABLE>
  412. &nbsp;<A NAME="methods_inherited_from_class_org.apache.log4j.Appender"><!-- --></A>
  413. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  414. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  415. <TH ALIGN="left"><B>Methods inherited from interface org.apache.log4j.<A HREF="../../../../org/apache/log4j/Appender.html" title="interface in org.apache.log4j">Appender</A></B></TH>
  416. </TR>
  417. <TR BGCOLOR="white" CLASS="TableRowColor">
  418. <TD><CODE><A HREF="../../../../org/apache/log4j/Appender.html#addFilter(org.apache.log4j.spi.Filter)">addFilter</A>, <A HREF="../../../../org/apache/log4j/Appender.html#clearFilters()">clearFilters</A>, <A HREF="../../../../org/apache/log4j/Appender.html#doAppend(org.apache.log4j.spi.LoggingEvent)">doAppend</A>, <A HREF="../../../../org/apache/log4j/Appender.html#getErrorHandler()">getErrorHandler</A>, <A HREF="../../../../org/apache/log4j/Appender.html#getFilter()">getFilter</A>, <A HREF="../../../../org/apache/log4j/Appender.html#getLayout()">getLayout</A>, <A HREF="../../../../org/apache/log4j/Appender.html#getName()">getName</A>, <A HREF="../../../../org/apache/log4j/Appender.html#setErrorHandler(org.apache.log4j.spi.ErrorHandler)">setErrorHandler</A>, <A HREF="../../../../org/apache/log4j/Appender.html#setLayout(org.apache.log4j.Layout)">setLayout</A>, <A HREF="../../../../org/apache/log4j/Appender.html#setName(java.lang.String)">setName</A></CODE></TD>
  419. </TR>
  420. </TABLE>
  421. &nbsp;
  422. <P>
  423. <!-- ============ FIELD DETAIL =========== -->
  424. <A NAME="field_detail"><!-- --></A>
  425. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  426. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  427. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  428. <B>Field Detail</B></FONT></TH>
  429. </TR>
  430. </TABLE>
  431. <A NAME="databaseURL"><!-- --></A><H3>
  432. databaseURL</H3>
  433. <PRE>
  434. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>databaseURL</B></PRE>
  435. <DL>
  436. <DD>URL of the DB for default connection handling
  437. <P>
  438. <DL>
  439. </DL>
  440. </DL>
  441. <HR>
  442. <A NAME="databaseUser"><!-- --></A><H3>
  443. databaseUser</H3>
  444. <PRE>
  445. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>databaseUser</B></PRE>
  446. <DL>
  447. <DD>User to connect as for default connection handling
  448. <P>
  449. <DL>
  450. </DL>
  451. </DL>
  452. <HR>
  453. <A NAME="databasePassword"><!-- --></A><H3>
  454. databasePassword</H3>
  455. <PRE>
  456. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>databasePassword</B></PRE>
  457. <DL>
  458. <DD>User to use for default connection handling
  459. <P>
  460. <DL>
  461. </DL>
  462. </DL>
  463. <HR>
  464. <A NAME="connection"><!-- --></A><H3>
  465. connection</H3>
  466. <PRE>
  467. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</A> <B>connection</B></PRE>
  468. <DL>
  469. <DD>Connection used by default. The connection is opened the first time it
  470. is needed and then held open until the appender is closed (usually at
  471. garbage collection). This behavior is best modified by creating a
  472. sub-class and overriding the <code>getConnection</code> and
  473. <code>closeConnection</code> methods.
  474. <P>
  475. <DL>
  476. </DL>
  477. </DL>
  478. <HR>
  479. <A NAME="sqlStatement"><!-- --></A><H3>
  480. sqlStatement</H3>
  481. <PRE>
  482. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>sqlStatement</B></PRE>
  483. <DL>
  484. <DD>Stores the string given to the pattern layout for conversion into a SQL
  485. statement, eg: insert into LogTable (Thread, Class, Message) values
  486. ("%t", "%c", "%m").
  487. Be careful of quotes in your messages!
  488. Also see PatternLayout.
  489. <P>
  490. <DL>
  491. </DL>
  492. </DL>
  493. <HR>
  494. <A NAME="bufferSize"><!-- --></A><H3>
  495. bufferSize</H3>
  496. <PRE>
  497. protected int <B>bufferSize</B></PRE>
  498. <DL>
  499. <DD>size of LoggingEvent buffer before writting to the database.
  500. Default is 1.
  501. <P>
  502. <DL>
  503. </DL>
  504. </DL>
  505. <HR>
  506. <A NAME="buffer"><!-- --></A><H3>
  507. buffer</H3>
  508. <PRE>
  509. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A> <B>buffer</B></PRE>
  510. <DL>
  511. <DD>ArrayList holding the buffer of Logging Events.
  512. <P>
  513. <DL>
  514. </DL>
  515. </DL>
  516. <HR>
  517. <A NAME="removes"><!-- --></A><H3>
  518. removes</H3>
  519. <PRE>
  520. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A> <B>removes</B></PRE>
  521. <DL>
  522. <DD>Helper object for clearing out the buffer
  523. <P>
  524. <DL>
  525. </DL>
  526. </DL>
  527. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  528. <A NAME="constructor_detail"><!-- --></A>
  529. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  530. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  531. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  532. <B>Constructor Detail</B></FONT></TH>
  533. </TR>
  534. </TABLE>
  535. <A NAME="JDBCAppender()"><!-- --></A><H3>
  536. JDBCAppender</H3>
  537. <PRE>
  538. public <B>JDBCAppender</B>()</PRE>
  539. <DL>
  540. </DL>
  541. <!-- ============ METHOD DETAIL ========== -->
  542. <A NAME="method_detail"><!-- --></A>
  543. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  544. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  545. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  546. <B>Method Detail</B></FONT></TH>
  547. </TR>
  548. </TABLE>
  549. <A NAME="getLocationInfo()"><!-- --></A><H3>
  550. getLocationInfo</H3>
  551. <PRE>
  552. public boolean <B>getLocationInfo</B>()</PRE>
  553. <DL>
  554. <DD>Gets whether the location of the logging request call
  555. should be captured.
  556. <P>
  557. <DD><DL>
  558. </DL>
  559. </DD>
  560. <DD><DL>
  561. <DT><B>Returns:</B><DD>the current value of the <b>LocationInfo</b> option.<DT><B>Since:</B></DT>
  562. <DD>1.2.16</DD>
  563. </DL>
  564. </DD>
  565. </DL>
  566. <HR>
  567. <A NAME="setLocationInfo(boolean)"><!-- --></A><H3>
  568. setLocationInfo</H3>
  569. <PRE>
  570. public void <B>setLocationInfo</B>(boolean&nbsp;flag)</PRE>
  571. <DL>
  572. <DD>The <b>LocationInfo</b> option takes a boolean value. By default, it is
  573. set to false which means there will be no effort to extract the location
  574. information related to the event. As a result, the event that will be
  575. ultimately logged will likely to contain the wrong location information
  576. (if present in the log format).
  577. <p/>
  578. <p/>
  579. Location information extraction is comparatively very slow and should be
  580. avoided unless performance is not a concern.
  581. </p>
  582. <P>
  583. <DD><DL>
  584. </DL>
  585. </DD>
  586. <DD><DL>
  587. <DT><B>Parameters:</B><DD><CODE>flag</CODE> - true if location information should be extracted.<DT><B>Since:</B></DT>
  588. <DD>1.2.16</DD>
  589. </DL>
  590. </DD>
  591. </DL>
  592. <HR>
  593. <A NAME="append(org.apache.log4j.spi.LoggingEvent)"><!-- --></A><H3>
  594. append</H3>
  595. <PRE>
  596. public void <B>append</B>(<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;event)</PRE>
  597. <DL>
  598. <DD>Adds the event to the buffer. When full the buffer is flushed.
  599. <P>
  600. <DD><DL>
  601. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#append(org.apache.log4j.spi.LoggingEvent)">append</A></CODE> in class <CODE><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</A></CODE></DL>
  602. </DD>
  603. <DD><DL>
  604. </DL>
  605. </DD>
  606. </DL>
  607. <HR>
  608. <A NAME="getLogStatement(org.apache.log4j.spi.LoggingEvent)"><!-- --></A><H3>
  609. getLogStatement</H3>
  610. <PRE>
  611. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLogStatement</B>(<A HREF="../../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</A>&nbsp;event)</PRE>
  612. <DL>
  613. <DD>By default getLogStatement sends the event to the required Layout object.
  614. The layout will format the given pattern into a workable SQL string.
  615. Overriding this provides direct access to the LoggingEvent
  616. when constructing the logging statement.
  617. <P>
  618. <DD><DL>
  619. </DL>
  620. </DD>
  621. <DD><DL>
  622. </DL>
  623. </DD>
  624. </DL>
  625. <HR>
  626. <A NAME="execute(java.lang.String)"><!-- --></A><H3>
  627. execute</H3>
  628. <PRE>
  629. protected void <B>execute</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;sql)
  630. throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE>
  631. <DL>
  632. <DD>Override this to provide an alertnate method of getting
  633. connections (such as caching). One method to fix this is to open
  634. connections at the start of flushBuffer() and close them at the
  635. end. I use a connection pool outside of JDBCAppender which is
  636. accessed in an override of this method.
  637. <P>
  638. <DD><DL>
  639. </DL>
  640. </DD>
  641. <DD><DL>
  642. <DT><B>Throws:</B>
  643. <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL>
  644. </DD>
  645. </DL>
  646. <HR>
  647. <A NAME="closeConnection(java.sql.Connection)"><!-- --></A><H3>
  648. closeConnection</H3>
  649. <PRE>
  650. protected void <B>closeConnection</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</A>&nbsp;con)</PRE>
  651. <DL>
  652. <DD>Override this to return the connection to a pool, or to clean up the
  653. resource.
  654. The default behavior holds a single connection open until the appender
  655. is closed (typically when garbage collected).
  656. <P>
  657. <DD><DL>
  658. </DL>
  659. </DD>
  660. <DD><DL>
  661. </DL>
  662. </DD>
  663. </DL>
  664. <HR>
  665. <A NAME="getConnection()"><!-- --></A><H3>
  666. getConnection</H3>
  667. <PRE>
  668. protected <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</A> <B>getConnection</B>()
  669. throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE>
  670. <DL>
  671. <DD>Override this to link with your connection pooling system.
  672. By default this creates a single connection which is held open
  673. until the object is garbage collected.
  674. <P>
  675. <DD><DL>
  676. </DL>
  677. </DD>
  678. <DD><DL>
  679. <DT><B>Throws:</B>
  680. <DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL>
  681. </DD>
  682. </DL>
  683. <HR>
  684. <A NAME="close()"><!-- --></A><H3>
  685. close</H3>
  686. <PRE>
  687. public void <B>close</B>()</PRE>
  688. <DL>
  689. <DD>Closes the appender, flushing the buffer first then closing the default
  690. connection if it is open.
  691. <P>
  692. <DD><DL>
  693. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/Appender.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../org/apache/log4j/Appender.html" title="interface in org.apache.log4j">Appender</A></CODE></DL>
  694. </DD>
  695. <DD><DL>
  696. </DL>
  697. </DD>
  698. </DL>
  699. <HR>
  700. <A NAME="flushBuffer()"><!-- --></A><H3>
  701. flushBuffer</H3>
  702. <PRE>
  703. public void <B>flushBuffer</B>()</PRE>
  704. <DL>
  705. <DD>loops through the buffer of LoggingEvents, gets a
  706. sql string from getLogStatement() and sends it to execute().
  707. Errors are sent to the errorHandler.
  708. If a statement fails the LoggingEvent stays in the buffer!
  709. <P>
  710. <DD><DL>
  711. </DL>
  712. </DD>
  713. <DD><DL>
  714. </DL>
  715. </DD>
  716. </DL>
  717. <HR>
  718. <A NAME="finalize()"><!-- --></A><H3>
  719. finalize</H3>
  720. <PRE>
  721. public void <B>finalize</B>()</PRE>
  722. <DL>
  723. <DD>closes the appender before disposal
  724. <P>
  725. <DD><DL>
  726. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html#finalize()">finalize</A></CODE> in class <CODE><A HREF="../../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</A></CODE></DL>
  727. </DD>
  728. <DD><DL>
  729. </DL>
  730. </DD>
  731. </DL>
  732. <HR>
  733. <A NAME="requiresLayout()"><!-- --></A><H3>
  734. requiresLayout</H3>
  735. <PRE>
  736. public boolean <B>requiresLayout</B>()</PRE>
  737. <DL>
  738. <DD>JDBCAppender requires a layout.
  739. <P>
  740. <DD><DL>
  741. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/log4j/Appender.html#requiresLayout()">requiresLayout</A></CODE> in interface <CODE><A HREF="../../../../org/apache/log4j/Appender.html" title="interface in org.apache.log4j">Appender</A></CODE></DL>
  742. </DD>
  743. <DD><DL>
  744. </DL>
  745. </DD>
  746. </DL>
  747. <HR>
  748. <A NAME="setSql(java.lang.String)"><!-- --></A><H3>
  749. setSql</H3>
  750. <PRE>
  751. public void <B>setSql</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;s)</PRE>
  752. <DL>
  753. <DD><DL>
  754. </DL>
  755. </DD>
  756. <DD><DL>
  757. </DL>
  758. </DD>
  759. </DL>
  760. <HR>
  761. <A NAME="getSql()"><!-- --></A><H3>
  762. getSql</H3>
  763. <PRE>
  764. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getSql</B>()</PRE>
  765. <DL>
  766. <DD>Returns pre-formated statement eg: insert into LogTable (msg) values ("%m")
  767. <P>
  768. <DD><DL>
  769. </DL>
  770. </DD>
  771. <DD><DL>
  772. </DL>
  773. </DD>
  774. </DL>
  775. <HR>
  776. <A NAME="setUser(java.lang.String)"><!-- --></A><H3>
  777. setUser</H3>
  778. <PRE>
  779. public void <B>setUser</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;user)</PRE>
  780. <DL>
  781. <DD><DL>
  782. </DL>
  783. </DD>
  784. <DD><DL>
  785. </DL>
  786. </DD>
  787. </DL>
  788. <HR>
  789. <A NAME="setURL(java.lang.String)"><!-- --></A><H3>
  790. setURL</H3>
  791. <PRE>
  792. public void <B>setURL</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;url)</PRE>
  793. <DL>
  794. <DD><DL>
  795. </DL>
  796. </DD>
  797. <DD><DL>
  798. </DL>
  799. </DD>
  800. </DL>
  801. <HR>
  802. <A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
  803. setPassword</H3>
  804. <PRE>
  805. public void <B>setPassword</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;password)</PRE>
  806. <DL>
  807. <DD><DL>
  808. </DL>
  809. </DD>
  810. <DD><DL>
  811. </DL>
  812. </DD>
  813. </DL>
  814. <HR>
  815. <A NAME="setBufferSize(int)"><!-- --></A><H3>
  816. setBufferSize</H3>
  817. <PRE>
  818. public void <B>setBufferSize</B>(int&nbsp;newBufferSize)</PRE>
  819. <DL>
  820. <DD><DL>
  821. </DL>
  822. </DD>
  823. <DD><DL>
  824. </DL>
  825. </DD>
  826. </DL>
  827. <HR>
  828. <A NAME="getUser()"><!-- --></A><H3>
  829. getUser</H3>
  830. <PRE>
  831. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getUser</B>()</PRE>
  832. <DL>
  833. <DD><DL>
  834. </DL>
  835. </DD>
  836. <DD><DL>
  837. </DL>
  838. </DD>
  839. </DL>
  840. <HR>
  841. <A NAME="getURL()"><!-- --></A><H3>
  842. getURL</H3>
  843. <PRE>
  844. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getURL</B>()</PRE>
  845. <DL>
  846. <DD><DL>
  847. </DL>
  848. </DD>
  849. <DD><DL>
  850. </DL>
  851. </DD>
  852. </DL>
  853. <HR>
  854. <A NAME="getPassword()"><!-- --></A><H3>
  855. getPassword</H3>
  856. <PRE>
  857. public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPassword</B>()</PRE>
  858. <DL>
  859. <DD><DL>
  860. </DL>
  861. </DD>
  862. <DD><DL>
  863. </DL>
  864. </DD>
  865. </DL>
  866. <HR>
  867. <A NAME="getBufferSize()"><!-- --></A><H3>
  868. getBufferSize</H3>
  869. <PRE>
  870. public int <B>getBufferSize</B>()</PRE>
  871. <DL>
  872. <DD><DL>
  873. </DL>
  874. </DD>
  875. <DD><DL>
  876. </DL>
  877. </DD>
  878. </DL>
  879. <HR>
  880. <A NAME="setDriver(java.lang.String)"><!-- --></A><H3>
  881. setDriver</H3>
  882. <PRE>
  883. public void <B>setDriver</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;driverClass)</PRE>
  884. <DL>
  885. <DD>Ensures that the given driver class has been loaded for sql connection
  886. creation.
  887. <P>
  888. <DD><DL>
  889. </DL>
  890. </DD>
  891. <DD><DL>
  892. </DL>
  893. </DD>
  894. </DL>
  895. <!-- ========= END OF CLASS DATA ========= -->
  896. <HR>
  897. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  898. <A NAME="navbar_bottom"><!-- --></A>
  899. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  900. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  901. <TR>
  902. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  903. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  904. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  905. <TR ALIGN="center" VALIGN="top">
  906. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  907. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  908. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  909. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDBCAppender.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  910. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  911. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  912. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  913. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  914. </TR>
  915. </TABLE>
  916. </TD>
  917. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  918. </EM>
  919. </TD>
  920. </TR>
  921. <TR>
  922. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  923. &nbsp;PREV CLASS&nbsp;
  924. &nbsp;NEXT CLASS</FONT></TD>
  925. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  926. <A HREF="../../../../index.html?org/apache/log4j/jdbc/JDBCAppender.html" target="_top"><B>FRAMES</B></A> &nbsp;
  927. &nbsp;<A HREF="JDBCAppender.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  928. &nbsp;<SCRIPT type="text/javascript">
  929. <!--
  930. if(window==top) {
  931. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  932. }
  933. //-->
  934. </SCRIPT>
  935. <NOSCRIPT>
  936. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  937. </NOSCRIPT>
  938. </FONT></TD>
  939. </TR>
  940. <TR>
  941. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  942. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  943. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  944. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  945. </TR>
  946. </TABLE>
  947. <A NAME="skip-navbar_bottom"></A>
  948. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  949. <HR>
  950. Copyright &#169; 1999-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
  951. </BODY>
  952. </HTML>