PageRenderTime 59ms CodeModel.GetById 17ms app.highlight 33ms RepoModel.GetById 2ms app.codeStats 0ms

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