/javadoc/com/googlecode/jmxtrans/OutputWriter.html

http://jmxtrans.googlecode.com/ · HTML · 358 lines · 294 code · 44 blank · 20 comment · 0 complexity · a90abff40ef28bd13acbd2012aacac33 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_24) on Fri Jul 08 14:42:36 PDT 2011 -->
  6. <TITLE>
  7. OutputWriter (jmxlogger javadoc)
  8. </TITLE>
  9. <META NAME="date" CONTENT="2011-07-08">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="OutputWriter (jmxlogger javadoc)";
  16. }
  17. }
  18. </SCRIPT>
  19. <NOSCRIPT>
  20. </NOSCRIPT>
  21. </HEAD>
  22. <BODY BGCOLOR="white" onload="windowTitle();">
  23. <HR>
  24. <!-- ========= START OF TOP NAVBAR ======= -->
  25. <A NAME="navbar_top"><!-- --></A>
  26. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  27. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  28. <TR>
  29. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  30. <A NAME="navbar_top_firstrow"><!-- --></A>
  31. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  32. <TR ALIGN="center" VALIGN="top">
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  36. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  40. </TR>
  41. </TABLE>
  42. </TD>
  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  44. </EM>
  45. </TD>
  46. </TR>
  47. <TR>
  48. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  49. &nbsp;<A HREF="../../../com/googlecode/jmxtrans/JmxTransformer.html" title="class in com.googlecode.jmxtrans"><B>PREV CLASS</B></A>&nbsp;
  50. &nbsp;NEXT CLASS</FONT></TD>
  51. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  52. <A HREF="../../../index.html?com/googlecode/jmxtrans/OutputWriter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  53. &nbsp;<A HREF="OutputWriter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  54. &nbsp;<SCRIPT type="text/javascript">
  55. <!--
  56. if(window==top) {
  57. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  58. }
  59. //-->
  60. </SCRIPT>
  61. <NOSCRIPT>
  62. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  63. </NOSCRIPT>
  64. </FONT></TD>
  65. </TR>
  66. <TR>
  67. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  68. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  71. </TR>
  72. </TABLE>
  73. <A NAME="skip-navbar_top"></A>
  74. <!-- ========= END OF TOP NAVBAR ========= -->
  75. <HR>
  76. <!-- ======== START OF CLASS DATA ======== -->
  77. <H2>
  78. <FONT SIZE="-1">
  79. com.googlecode.jmxtrans</FONT>
  80. <BR>
  81. Interface OutputWriter</H2>
  82. <DL>
  83. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/googlecode/jmxtrans/util/BaseOutputWriter.html" title="class in com.googlecode.jmxtrans.util">BaseOutputWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/GangliaWriter.html" title="class in com.googlecode.jmxtrans.model.output">GangliaWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/GraphiteWriter.html" title="class in com.googlecode.jmxtrans.model.output">GraphiteWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/KeyOutWriter.html" title="class in com.googlecode.jmxtrans.model.output">KeyOutWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/RRDToolWriter.html" title="class in com.googlecode.jmxtrans.model.output">RRDToolWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/RRDWriter.html" title="class in com.googlecode.jmxtrans.model.output">RRDWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/StdOutWriter.html" title="class in com.googlecode.jmxtrans.model.output">StdOutWriter</A>, <A HREF="../../../com/googlecode/jmxtrans/model/output/VelocityWriter.html" title="class in com.googlecode.jmxtrans.model.output">VelocityWriter</A></DD>
  84. </DL>
  85. <HR>
  86. <DL>
  87. <DT><PRE>public interface <B>OutputWriter</B></DL>
  88. </PRE>
  89. <P>
  90. Interface which defines a writer for taking jmx data and
  91. writing it out in whatever format you want.
  92. Note that this class uses a feature of Jackson to serialize
  93. anything that implements this as a "@class". That way, when
  94. Jackson deserializes implementations of this interface, it is
  95. done with new objects that implement this interface.
  96. <P>
  97. <P>
  98. <DL>
  99. <DT><B>Author:</B></DT>
  100. <DD>jon</DD>
  101. </DL>
  102. <HR>
  103. <P>
  104. <!-- ========== METHOD SUMMARY =========== -->
  105. <A NAME="method_summary"><!-- --></A>
  106. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  107. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  108. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  109. <B>Method Summary</B></FONT></TH>
  110. </TR>
  111. <TR BGCOLOR="white" CLASS="TableRowColor">
  112. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  113. <CODE>&nbsp;void</CODE></FONT></TD>
  114. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#doWrite(com.googlecode.jmxtrans.model.Query)">doWrite</A></B>(<A HREF="../../../com/googlecode/jmxtrans/model/Query.html" title="class in com.googlecode.jmxtrans.model">Query</A>&nbsp;query)</CODE>
  115. <BR>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  117. </TR>
  118. <TR BGCOLOR="white" CLASS="TableRowColor">
  119. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  120. <CODE>&nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;</CODE></FONT></TD>
  121. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#getSettings()">getSettings</A></B>()</CODE>
  122. <BR>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Settings allow you to configure your Writers with whatever they might need.</TD>
  124. </TR>
  125. <TR BGCOLOR="white" CLASS="TableRowColor">
  126. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  127. <CODE>&nbsp;void</CODE></FONT></TD>
  128. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#setObjectPoolMap(java.util.Map)">setObjectPoolMap</A></B>(java.util.Map&lt;java.lang.String,org.apache.commons.pool.KeyedObjectPool&gt;&nbsp;poolMap)</CODE>
  129. <BR>
  130. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Some writers, like GraphiteWriter will use this for object pooling.</TD>
  131. </TR>
  132. <TR BGCOLOR="white" CLASS="TableRowColor">
  133. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  134. <CODE>&nbsp;void</CODE></FONT></TD>
  135. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#setSettings(java.util.Map)">setSettings</A></B>(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;settings)</CODE>
  136. <BR>
  137. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Settings allow you to configure your Writers with whatever they might need.</TD>
  138. </TR>
  139. <TR BGCOLOR="white" CLASS="TableRowColor">
  140. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  141. <CODE>&nbsp;void</CODE></FONT></TD>
  142. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#start()">start</A></B>()</CODE>
  143. <BR>
  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  145. </TR>
  146. <TR BGCOLOR="white" CLASS="TableRowColor">
  147. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  148. <CODE>&nbsp;void</CODE></FONT></TD>
  149. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#stop()">stop</A></B>()</CODE>
  150. <BR>
  151. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>&nbsp;void</CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#validateSetup(com.googlecode.jmxtrans.model.Query)">validateSetup</A></B>(<A HREF="../../../com/googlecode/jmxtrans/model/Query.html" title="class in com.googlecode.jmxtrans.model">Query</A>&nbsp;query)</CODE>
  157. <BR>
  158. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is run when the object is instantiated.</TD>
  159. </TR>
  160. </TABLE>
  161. &nbsp;
  162. <P>
  163. <!-- ============ METHOD DETAIL ========== -->
  164. <A NAME="method_detail"><!-- --></A>
  165. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  166. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  167. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  168. <B>Method Detail</B></FONT></TH>
  169. </TR>
  170. </TABLE>
  171. <A NAME="start()"><!-- --></A><H3>
  172. start</H3>
  173. <PRE>
  174. void <B>start</B>()
  175. throws <A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></PRE>
  176. <DL>
  177. <DD><DL>
  178. <DT><B>Throws:</B>
  179. <DD><CODE><A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></CODE></DL>
  180. </DD>
  181. </DL>
  182. <HR>
  183. <A NAME="stop()"><!-- --></A><H3>
  184. stop</H3>
  185. <PRE>
  186. void <B>stop</B>()
  187. throws <A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></PRE>
  188. <DL>
  189. <DD><DL>
  190. <DT><B>Throws:</B>
  191. <DD><CODE><A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></CODE></DL>
  192. </DD>
  193. </DL>
  194. <HR>
  195. <A NAME="doWrite(com.googlecode.jmxtrans.model.Query)"><!-- --></A><H3>
  196. doWrite</H3>
  197. <PRE>
  198. void <B>doWrite</B>(<A HREF="../../../com/googlecode/jmxtrans/model/Query.html" title="class in com.googlecode.jmxtrans.model">Query</A>&nbsp;query)
  199. throws java.lang.Exception</PRE>
  200. <DL>
  201. <DD><DL>
  202. <DT><B>Throws:</B>
  203. <DD><CODE>java.lang.Exception</CODE></DL>
  204. </DD>
  205. </DL>
  206. <HR>
  207. <A NAME="getSettings()"><!-- --></A><H3>
  208. getSettings</H3>
  209. <PRE>
  210. java.util.Map&lt;java.lang.String,java.lang.Object&gt; <B>getSettings</B>()</PRE>
  211. <DL>
  212. <DD>Settings allow you to configure your Writers with whatever they might need.
  213. <P>
  214. <DD><DL>
  215. </DL>
  216. </DD>
  217. </DL>
  218. <HR>
  219. <A NAME="setSettings(java.util.Map)"><!-- --></A><H3>
  220. setSettings</H3>
  221. <PRE>
  222. void <B>setSettings</B>(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;settings)</PRE>
  223. <DL>
  224. <DD>Settings allow you to configure your Writers with whatever they might need.
  225. <P>
  226. <DD><DL>
  227. </DL>
  228. </DD>
  229. </DL>
  230. <HR>
  231. <A NAME="validateSetup(com.googlecode.jmxtrans.model.Query)"><!-- --></A><H3>
  232. validateSetup</H3>
  233. <PRE>
  234. void <B>validateSetup</B>(<A HREF="../../../com/googlecode/jmxtrans/model/Query.html" title="class in com.googlecode.jmxtrans.model">Query</A>&nbsp;query)
  235. throws <A HREF="../../../com/googlecode/jmxtrans/util/ValidationException.html" title="class in com.googlecode.jmxtrans.util">ValidationException</A></PRE>
  236. <DL>
  237. <DD>This is run when the object is instantiated. You want to get the settings and validate them.
  238. <P>
  239. <DD><DL>
  240. <DT><B>Throws:</B>
  241. <DD><CODE><A HREF="../../../com/googlecode/jmxtrans/util/ValidationException.html" title="class in com.googlecode.jmxtrans.util">ValidationException</A></CODE></DL>
  242. </DD>
  243. </DL>
  244. <HR>
  245. <A NAME="setObjectPoolMap(java.util.Map)"><!-- --></A><H3>
  246. setObjectPoolMap</H3>
  247. <PRE>
  248. void <B>setObjectPoolMap</B>(java.util.Map&lt;java.lang.String,org.apache.commons.pool.KeyedObjectPool&gt;&nbsp;poolMap)</PRE>
  249. <DL>
  250. <DD>Some writers, like GraphiteWriter will use this for object pooling. Things like
  251. Socket connections to remote servers that we are writing to are ripe for pooling.
  252. This is super extensible as a map because we could have multiple object pools.
  253. <P>
  254. <DD><DL>
  255. </DL>
  256. </DD>
  257. </DL>
  258. <!-- ========= END OF CLASS DATA ========= -->
  259. <HR>
  260. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  261. <A NAME="navbar_bottom"><!-- --></A>
  262. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  263. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  264. <TR>
  265. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  266. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  267. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  268. <TR ALIGN="center" VALIGN="top">
  269. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  270. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  271. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  272. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  273. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  274. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  275. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  276. </TR>
  277. </TABLE>
  278. </TD>
  279. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  280. </EM>
  281. </TD>
  282. </TR>
  283. <TR>
  284. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  285. &nbsp;<A HREF="../../../com/googlecode/jmxtrans/JmxTransformer.html" title="class in com.googlecode.jmxtrans"><B>PREV CLASS</B></A>&nbsp;
  286. &nbsp;NEXT CLASS</FONT></TD>
  287. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  288. <A HREF="../../../index.html?com/googlecode/jmxtrans/OutputWriter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  289. &nbsp;<A HREF="OutputWriter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  290. &nbsp;<SCRIPT type="text/javascript">
  291. <!--
  292. if(window==top) {
  293. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  294. }
  295. //-->
  296. </SCRIPT>
  297. <NOSCRIPT>
  298. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  299. </NOSCRIPT>
  300. </FONT></TD>
  301. </TR>
  302. <TR>
  303. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  304. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  305. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  306. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  307. </TR>
  308. </TABLE>
  309. <A NAME="skip-navbar_bottom"></A>
  310. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  311. <HR>
  312. <i>Copyright &#169; 2011 Jon Stevens and a gang of pencils. All Rights Reserved. Build version: 199</i>
  313. </BODY>
  314. </HTML>