/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
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.6.0_24) on Fri Jul 08 14:42:36 PDT 2011 -->
- <TITLE>
- OutputWriter (jmxlogger javadoc)
- </TITLE>
- <META NAME="date" CONTENT="2011-07-08">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="OutputWriter (jmxlogger javadoc)";
- }
- }
- </SCRIPT>
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" onload="windowTitle();">
- <HR>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../com/googlecode/jmxtrans/JmxTransformer.html" title="class in com.googlecode.jmxtrans"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html?com/googlecode/jmxtrans/OutputWriter.html" target="_top"><B>FRAMES</B></A>
- <A HREF="OutputWriter.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- com.googlecode.jmxtrans</FONT>
- <BR>
- Interface OutputWriter</H2>
- <DL>
- <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>
- </DL>
- <HR>
- <DL>
- <DT><PRE>public interface <B>OutputWriter</B></DL>
- </PRE>
- <P>
- Interface which defines a writer for taking jmx data and
- writing it out in whatever format you want.
- Note that this class uses a feature of Jackson to serialize
- anything that implements this as a "@class". That way, when
- Jackson deserializes implementations of this interface, it is
- done with new objects that implement this interface.
- <P>
- <P>
- <DL>
- <DT><B>Author:</B></DT>
- <DD>jon</DD>
- </DL>
- <HR>
- <P>
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> query)</CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#getSettings()">getSettings</A></B>()</CODE>
- <BR>
- Settings allow you to configure your Writers with whatever they might need.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#setObjectPoolMap(java.util.Map)">setObjectPoolMap</A></B>(java.util.Map<java.lang.String,org.apache.commons.pool.KeyedObjectPool> poolMap)</CODE>
- <BR>
- Some writers, like GraphiteWriter will use this for object pooling.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#setSettings(java.util.Map)">setSettings</A></B>(java.util.Map<java.lang.String,java.lang.Object> settings)</CODE>
- <BR>
- Settings allow you to configure your Writers with whatever they might need.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#start()">start</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/googlecode/jmxtrans/OutputWriter.html#stop()">stop</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <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> query)</CODE>
- <BR>
- This is run when the object is instantiated.</TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="start()"><!-- --></A><H3>
- start</H3>
- <PRE>
- void <B>start</B>()
- throws <A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></PRE>
- <DL>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE><A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="stop()"><!-- --></A><H3>
- stop</H3>
- <PRE>
- void <B>stop</B>()
- throws <A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></PRE>
- <DL>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE><A HREF="../../../com/googlecode/jmxtrans/util/LifecycleException.html" title="class in com.googlecode.jmxtrans.util">LifecycleException</A></CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="doWrite(com.googlecode.jmxtrans.model.Query)"><!-- --></A><H3>
- doWrite</H3>
- <PRE>
- void <B>doWrite</B>(<A HREF="../../../com/googlecode/jmxtrans/model/Query.html" title="class in com.googlecode.jmxtrans.model">Query</A> query)
- throws java.lang.Exception</PRE>
- <DL>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE>java.lang.Exception</CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getSettings()"><!-- --></A><H3>
- getSettings</H3>
- <PRE>
- java.util.Map<java.lang.String,java.lang.Object> <B>getSettings</B>()</PRE>
- <DL>
- <DD>Settings allow you to configure your Writers with whatever they might need.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setSettings(java.util.Map)"><!-- --></A><H3>
- setSettings</H3>
- <PRE>
- void <B>setSettings</B>(java.util.Map<java.lang.String,java.lang.Object> settings)</PRE>
- <DL>
- <DD>Settings allow you to configure your Writers with whatever they might need.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="validateSetup(com.googlecode.jmxtrans.model.Query)"><!-- --></A><H3>
- validateSetup</H3>
- <PRE>
- void <B>validateSetup</B>(<A HREF="../../../com/googlecode/jmxtrans/model/Query.html" title="class in com.googlecode.jmxtrans.model">Query</A> query)
- throws <A HREF="../../../com/googlecode/jmxtrans/util/ValidationException.html" title="class in com.googlecode.jmxtrans.util">ValidationException</A></PRE>
- <DL>
- <DD>This is run when the object is instantiated. You want to get the settings and validate them.
- <P>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE><A HREF="../../../com/googlecode/jmxtrans/util/ValidationException.html" title="class in com.googlecode.jmxtrans.util">ValidationException</A></CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setObjectPoolMap(java.util.Map)"><!-- --></A><H3>
- setObjectPoolMap</H3>
- <PRE>
- void <B>setObjectPoolMap</B>(java.util.Map<java.lang.String,org.apache.commons.pool.KeyedObjectPool> poolMap)</PRE>
- <DL>
- <DD>Some writers, like GraphiteWriter will use this for object pooling. Things like
- Socket connections to remote servers that we are writing to are ripe for pooling.
- This is super extensible as a map because we could have multiple object pools.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../com/googlecode/jmxtrans/JmxTransformer.html" title="class in com.googlecode.jmxtrans"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html?com/googlecode/jmxtrans/OutputWriter.html" target="_top"><B>FRAMES</B></A>
- <A HREF="OutputWriter.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- <i>Copyright © 2011 Jon Stevens and a gang of pencils. All Rights Reserved. Build version: 199</i>
- </BODY>
- </HTML>