Added: kafka/site/082/javadoc/index.html URL: http://svn.apache.org/viewvc/kafka/site/082/javadoc/index.html?rev=1656965&view=auto ============================================================================== --- kafka/site/082/javadoc/index.html (added) +++ kafka/site/082/javadoc/index.html Wed Feb 4 01:11:43 2015 @@ -0,0 +1,73 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc on Wed Jan 28 22:31:45 CST 2015--> +<TITLE> +clients 0.8.2.0 API +</TITLE> +<SCRIPT type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_') { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> +</HEAD> +<FRAMESET cols="20%,80%" title="" onLoad="top.loadFrames()"> +<FRAMESET rows="30%,70%" title="" onLoad="top.loadFrames()"> +<FRAME src="overview-frame.html" name="packageListFrame" title="All Packages"> +<FRAME src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</FRAMESET> +<FRAME src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<NOFRAMES> +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> +</NOFRAMES> +</FRAMESET> +</HTML>
Added: kafka/site/082/javadoc/org/apache/kafka/clients/producer/BufferExhaustedException.html URL: http://svn.apache.org/viewvc/kafka/site/082/javadoc/org/apache/kafka/clients/producer/BufferExhaustedException.html?rev=1656965&view=auto ============================================================================== --- kafka/site/082/javadoc/org/apache/kafka/clients/producer/BufferExhaustedException.html (added) +++ kafka/site/082/javadoc/org/apache/kafka/clients/producer/BufferExhaustedException.html Wed Feb 4 01:11:43 2015 @@ -0,0 +1,245 @@ +<!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_65) on Wed Jan 28 22:31:45 CST 2015 --> +<TITLE> +BufferExhaustedException (clients 0.8.2.0 API) +</TITLE> + +<META NAME="date" CONTENT="2015-01-28"> + +<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="BufferExhaustedException (clients 0.8.2.0 API)"; + } +} +</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"> + PREV CLASS + <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/BufferExhaustedException.html" target="_top"><B>FRAMES</B></A> + <A HREF="BufferExhaustedException.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Throwable">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.apache.kafka.clients.producer</FONT> +<BR> +Class BufferExhaustedException</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common">org.apache.kafka.common.KafkaException</A> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.kafka.clients.producer.BufferExhaustedException</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>BufferExhaustedException</B><DT>extends <A HREF="../../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common">KafkaException</A></DL> +</PRE> + +<P> +This exception is thrown if the producer is in non-blocking mode and the rate of data production exceeds the rate at + which data can be sent for long enough for the alloted buffer to be exhausted. +<P> + +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.kafka.clients.producer.BufferExhaustedException">Serialized Form</A></DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/BufferExhaustedException.html#BufferExhaustedException(java.lang.String)">BufferExhaustedException</A></B>(java.lang.String message)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== 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> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="BufferExhaustedException(java.lang.String)"><!-- --></A><H3> +BufferExhaustedException</H3> +<PRE> +public <B>BufferExhaustedException</B>(java.lang.String message)</PRE> +<DL> +</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"> + PREV CLASS + <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/BufferExhaustedException.html" target="_top"><B>FRAMES</B></A> + <A HREF="BufferExhaustedException.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_java.lang.Throwable">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> Added: kafka/site/082/javadoc/org/apache/kafka/clients/producer/Callback.html URL: http://svn.apache.org/viewvc/kafka/site/082/javadoc/org/apache/kafka/clients/producer/Callback.html?rev=1656965&view=auto ============================================================================== --- kafka/site/082/javadoc/org/apache/kafka/clients/producer/Callback.html (added) +++ kafka/site/082/javadoc/org/apache/kafka/clients/producer/Callback.html Wed Feb 4 01:11:43 2015 @@ -0,0 +1,216 @@ +<!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_65) on Wed Jan 28 22:31:45 CST 2015 --> +<TITLE> +Callback (clients 0.8.2.0 API) +</TITLE> + +<META NAME="date" CONTENT="2015-01-28"> + +<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="Callback (clients 0.8.2.0 API)"; + } +} +</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="../../../../../org/apache/kafka/clients/producer/BufferExhaustedException.html" title="class in org.apache.kafka.clients.producer"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="class in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/Callback.html" target="_top"><B>FRAMES</B></A> + <A HREF="Callback.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"> +org.apache.kafka.clients.producer</FONT> +<BR> +Interface Callback</H2> +<HR> +<DL> +<DT><PRE>public interface <B>Callback</B></DL> +</PRE> + +<P> +A callback interface that the user can implement to allow code to execute when the request is complete. This callback + will generally execute in the background I/O thread so it should be fast. +<P> + +<P> +<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="../../../../../org/apache/kafka/clients/producer/Callback.html#onCompletion(org.apache.kafka.clients.producer.RecordMetadata, java.lang.Exception)">onCompletion</A></B>(<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A> metadata, + java.lang.Exception exception)</CODE> + +<BR> + A callback method the user can implement to provide asynchronous handling of request completion.</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="onCompletion(org.apache.kafka.clients.producer.RecordMetadata, java.lang.Exception)"><!-- --></A><H3> +onCompletion</H3> +<PRE> +void <B>onCompletion</B>(<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A> metadata, + java.lang.Exception exception)</PRE> +<DL> +<DD>A callback method the user can implement to provide asynchronous handling of request completion. This method will + be called when the record sent to the server has been acknowledged. Exactly one of the arguments will be + non-null. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>metadata</CODE> - The metadata for the record that was sent (i.e. the partition and offset). Null if an error + occurred.<DD><CODE>exception</CODE> - The exception thrown during processing of this record. Null if no error occurred.</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="../../../../../org/apache/kafka/clients/producer/BufferExhaustedException.html" title="class in org.apache.kafka.clients.producer"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="class in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/Callback.html" target="_top"><B>FRAMES</B></A> + <A HREF="Callback.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> + +</BODY> +</HTML> Added: kafka/site/082/javadoc/org/apache/kafka/clients/producer/KafkaProducer.html URL: http://svn.apache.org/viewvc/kafka/site/082/javadoc/org/apache/kafka/clients/producer/KafkaProducer.html?rev=1656965&view=auto ============================================================================== --- kafka/site/082/javadoc/org/apache/kafka/clients/producer/KafkaProducer.html (added) +++ kafka/site/082/javadoc/org/apache/kafka/clients/producer/KafkaProducer.html Wed Feb 4 01:11:43 2015 @@ -0,0 +1,497 @@ +<!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_65) on Wed Jan 28 22:31:45 CST 2015 --> +<TITLE> +KafkaProducer (clients 0.8.2.0 API) +</TITLE> + +<META NAME="date" CONTENT="2015-01-28"> + +<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="KafkaProducer (clients 0.8.2.0 API)"; + } +} +</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="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html" title="class in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/KafkaProducer.html" target="_top"><B>FRAMES</B></A> + <A HREF="KafkaProducer.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> +org.apache.kafka.clients.producer</FONT> +<BR> +Class KafkaProducer<K,V></H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.kafka.clients.producer.KafkaProducer<K,V></B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Closeable, <A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><K,V></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>KafkaProducer<K,V></B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><K,V></DL> +</PRE> + +<P> +A Kafka client that publishes records to the Kafka cluster. + <P> + The producer is <i>thread safe</i> and should generally be shared among all threads for best performance. + <p> + The producer manages a single background thread that does I/O as well as a TCP connection to each of the brokers it + needs to communicate with. Failure to close the producer after use will leak these resources. +<P> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#KafkaProducer(java.util.Map)">KafkaProducer</A></B>(java.util.Map<java.lang.String,java.lang.Object> configs)</CODE> + +<BR> + A producer is instantiated by providing a set of key-value pairs as configuration.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#KafkaProducer(java.util.Map, org.apache.kafka.common.serialization.Serializer, org.apache.kafka.common.serialization.Serializer)">KafkaProducer</A></B>(java.util.Map<java.lang.String,java.lang.Object> configs, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>> keySerializer, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> valueSerializer)</CODE> + +<BR> + A producer is instantiated by providing a set of key-value pairs as configuration, a key and a value <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#KafkaProducer(java.util.Properties)">KafkaProducer</A></B>(java.util.Properties properties)</CODE> + +<BR> + A producer is instantiated by providing a set of key-value pairs as configuration.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#KafkaProducer(java.util.Properties, org.apache.kafka.common.serialization.Serializer, org.apache.kafka.common.serialization.Serializer)">KafkaProducer</A></B>(java.util.Properties properties, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>> keySerializer, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> valueSerializer)</CODE> + +<BR> + A producer is instantiated by providing a set of key-value pairs as configuration, a key and a value <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>.</TD> +</TR> +</TABLE> + +<!-- ========== 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="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#close()">close</A></B>()</CODE> + +<BR> + Close this producer.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Map<<A HREF="../../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common">MetricName</A>,? extends <A HREF="../../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common">Metric</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#metrics()">metrics</A></B>()</CODE> + +<BR> + Return a map of metrics maintained by the producer</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List<<A HREF="../../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#partitionsFor(java.lang.String)">partitionsFor</A></B>(java.lang.String topic)</CODE> + +<BR> + Get a list of partitions for the given topic for custom partition assignment.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)">send</A></B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> record)</CODE> + +<BR> + Asynchronously send a record to a topic.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)">send</A></B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> record, + <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer">Callback</A> callback)</CODE> + +<BR> + Asynchronously send a record to a topic and invoke the provided callback when the send has been acknowledged.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="KafkaProducer(java.util.Map)"><!-- --></A><H3> +KafkaProducer</H3> +<PRE> +public <B>KafkaProducer</B>(java.util.Map<java.lang.String,java.lang.Object> configs)</PRE> +<DL> +<DD>A producer is instantiated by providing a set of key-value pairs as configuration. Valid configuration strings + are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>. Values can be + either strings or Objects of the appropriate type (for example a numeric configuration would accept either the + string "42" or the integer 42). +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>configs</CODE> - The producer configs</DL> +</DL> +<HR> + +<A NAME="KafkaProducer(java.util.Map, org.apache.kafka.common.serialization.Serializer, org.apache.kafka.common.serialization.Serializer)"><!-- --></A><H3> +KafkaProducer</H3> +<PRE> +public <B>KafkaProducer</B>(java.util.Map<java.lang.String,java.lang.Object> configs, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>> keySerializer, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> valueSerializer)</PRE> +<DL> +<DD>A producer is instantiated by providing a set of key-value pairs as configuration, a key and a value <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>. + Valid configuration strings are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>. + Values can be either strings or Objects of the appropriate type (for example a numeric configuration would accept + either the string "42" or the integer 42). +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>configs</CODE> - The producer configs<DD><CODE>keySerializer</CODE> - The serializer for key that implements <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>. The configure() method won't be + called when the serializer is passed in directly.<DD><CODE>valueSerializer</CODE> - The serializer for value that implements <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>. The configure() method won't + be called when the serializer is passed in directly.</DL> +</DL> +<HR> + +<A NAME="KafkaProducer(java.util.Properties)"><!-- --></A><H3> +KafkaProducer</H3> +<PRE> +public <B>KafkaProducer</B>(java.util.Properties properties)</PRE> +<DL> +<DD>A producer is instantiated by providing a set of key-value pairs as configuration. Valid configuration strings + are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>properties</CODE> - The producer configs</DL> +</DL> +<HR> + +<A NAME="KafkaProducer(java.util.Properties, org.apache.kafka.common.serialization.Serializer, org.apache.kafka.common.serialization.Serializer)"><!-- --></A><H3> +KafkaProducer</H3> +<PRE> +public <B>KafkaProducer</B>(java.util.Properties properties, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>> keySerializer, + <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> valueSerializer)</PRE> +<DL> +<DD>A producer is instantiated by providing a set of key-value pairs as configuration, a key and a value <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>. + Valid configuration strings are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>properties</CODE> - The producer configs<DD><CODE>keySerializer</CODE> - The serializer for key that implements <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>. The configure() method won't be + called when the serializer is passed in directly.<DD><CODE>valueSerializer</CODE> - The serializer for value that implements <A HREF="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><CODE>Serializer</CODE></A>. The configure() method won't + be called when the serializer is passed in directly.</DL> +</DL> + +<!-- ============ 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="send(org.apache.kafka.clients.producer.ProducerRecord)"><!-- --></A><H3> +send</H3> +<PRE> +public java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>> <B>send</B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> record)</PRE> +<DL> +<DD>Asynchronously send a record to a topic. Equivalent to <A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)"><CODE>send(record, null)</CODE></A> +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#send(org.apache.kafka.clients.producer.ProducerRecord)">send</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>record</CODE> - The record to be sent +<DT><B>Returns:</B><DD>A future which will eventually contain the response information</DL> +</DD> +</DL> +<HR> + +<A NAME="send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)"><!-- --></A><H3> +send</H3> +<PRE> +public java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>> <B>send</B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>> record, + <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer">Callback</A> callback)</PRE> +<DL> +<DD>Asynchronously send a record to a topic and invoke the provided callback when the send has been acknowledged. + <p> + The send is asynchronous and this method will return immediately once the record has been stored in the buffer of + records waiting to be sent. This allows sending many records in parallel without blocking to wait for the + response after each one. + <p> + The result of the send is a <A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer"><CODE>RecordMetadata</CODE></A> specifying the partition the record was sent to and the offset + it was assigned. + <p> + Since the send call is asynchronous it returns a <CODE>Future</CODE> for the + <A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer"><CODE>RecordMetadata</CODE></A> that will be assigned to this record. Invoking <CODE>get()</CODE> on this future will result in the metadata for the record or throw any exception that occurred while + sending the record. + <p> + If you want to simulate a simple blocking call you can do the following: + + <pre><code>producer.send(new ProducerRecord<byte[],byte[]>("the-topic", "key".getBytes(), "value".getBytes())).get(); + </code></pre> + <p> + Those desiring fully non-blocking usage can make use of the <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer"><CODE>Callback</CODE></A> parameter to provide a callback that + will be invoked when the request is complete. + + <pre><code>ProducerRecord<byte[],byte[]> record = new ProducerRecord<byte[],byte[]>("the-topic", "key".getBytes(), "value".getBytes()); + producer.send(myRecord, + new Callback() { + public void onCompletion(RecordMetadata metadata, Exception e) { + if(e != null) + e.printStackTrace(); + System.out.println("The offset of the record we just sent is: " + metadata.offset()); + } + }); + </code></pre> + + Callbacks for records being sent to the same partition are guaranteed to execute in order. That is, in the + following example <code>callback1</code> is guaranteed to execute before <code>callback2</code>: + + <pre><code>producer.send(new ProducerRecord<byte[],byte[]>(topic, partition, key1, value1), callback1); + producer.send(new ProducerRecord<byte[],byte[]>(topic, partition, key2, value2), callback2); + </code></pre> + <p> + Note that callbacks will generally execute in the I/O thread of the producer and so should be reasonably fast or + they will delay the sending of messages from other threads. If you want to execute blocking or computationally + expensive callbacks it is recommended to use your own <CODE>Executor</CODE> in the callback body + to parallelize processing. + <p> + The producer manages a buffer of records waiting to be sent. This buffer has a hard limit on it's size, which is + controlled by the configuration <code>total.memory.bytes</code>. If <code>send()</code> is called faster than the + I/O thread can transfer data to the brokers the buffer will eventually run out of space. The default behavior in + this case is to block the send call until the I/O thread catches up and more buffer space is available. However + in cases where non-blocking usage is desired the setting <code>block.on.buffer.full=false</code> will cause the + producer to instead throw an exception when buffer memory is exhausted. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)">send</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>record</CODE> - The record to send<DD><CODE>callback</CODE> - A user-supplied callback to execute when the record has been acknowledged by the server (null + indicates no callback)</DL> +</DD> +</DL> +<HR> + +<A NAME="partitionsFor(java.lang.String)"><!-- --></A><H3> +partitionsFor</H3> +<PRE> +public java.util.List<<A HREF="../../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</A>> <B>partitionsFor</B>(java.lang.String topic)</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#partitionsFor(java.lang.String)">Producer</A></CODE></B></DD> +<DD>Get a list of partitions for the given topic for custom partition assignment. The partition metadata will change + over time so this list should not be cached. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#partitionsFor(java.lang.String)">partitionsFor</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="metrics()"><!-- --></A><H3> +metrics</H3> +<PRE> +public java.util.Map<<A HREF="../../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common">MetricName</A>,? extends <A HREF="../../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common">Metric</A>> <B>metrics</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#metrics()">Producer</A></CODE></B></DD> +<DD>Return a map of metrics maintained by the producer +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#metrics()">metrics</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="close()"><!-- --></A><H3> +close</H3> +<PRE> +public void <B>close</B>()</PRE> +<DL> +<DD>Close this producer. This method blocks until all in-flight requests complete. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>close</CODE> in interface <CODE>java.io.Closeable</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">K</A>,<A HREF="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="type parameter in KafkaProducer">V</A>></CODE></DL> +</DD> +<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="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html" title="class in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/KafkaProducer.html" target="_top"><B>FRAMES</B></A> + <A HREF="KafkaProducer.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> Added: kafka/site/082/javadoc/org/apache/kafka/clients/producer/MockProducer.html URL: http://svn.apache.org/viewvc/kafka/site/082/javadoc/org/apache/kafka/clients/producer/MockProducer.html?rev=1656965&view=auto ============================================================================== --- kafka/site/082/javadoc/org/apache/kafka/clients/producer/MockProducer.html (added) +++ kafka/site/082/javadoc/org/apache/kafka/clients/producer/MockProducer.html Wed Feb 4 01:11:43 2015 @@ -0,0 +1,513 @@ +<!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_65) on Wed Jan 28 22:31:45 CST 2015 --> +<TITLE> +MockProducer (clients 0.8.2.0 API) +</TITLE> + +<META NAME="date" CONTENT="2015-01-28"> + +<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="MockProducer (clients 0.8.2.0 API)"; + } +} +</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="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="class in org.apache.kafka.clients.producer"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/MockProducer.html" target="_top"><B>FRAMES</B></A> + <A HREF="MockProducer.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> +org.apache.kafka.clients.producer</FONT> +<BR> +Class MockProducer</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.kafka.clients.producer.MockProducer</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Closeable, <A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>MockProducer</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></DL> +</PRE> + +<P> +A mock of the producer interface you can use for testing code that uses Kafka. + <p> + By default this mock will synchronously complete each send call successfully. However it can be configured to allow + the user to control the completion of the call and supply an optional error for the producer to throw. +<P> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#MockProducer()">MockProducer</A></B>()</CODE> + +<BR> + Create a new auto completing mock producer + + Equivalent to <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#MockProducer(boolean)"><CODE>new MockProducer(true)</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#MockProducer(boolean)">MockProducer</A></B>(boolean autoComplete)</CODE> + +<BR> + Create a new mock producer with invented metadata the given autoComplete setting.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#MockProducer(org.apache.kafka.common.Cluster, boolean)">MockProducer</A></B>(<A HREF="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</A> cluster, + boolean autoComplete)</CODE> + +<BR> + Create a mock producer</TD> +</TR> +</TABLE> + +<!-- ========== 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="../../../../../org/apache/kafka/clients/producer/MockProducer.html#clear()">clear</A></B>()</CODE> + +<BR> + Clear the stored history of sent records</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="../../../../../org/apache/kafka/clients/producer/MockProducer.html#close()">close</A></B>()</CODE> + +<BR> + Close this producer</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#completeNext()">completeNext</A></B>()</CODE> + +<BR> + Complete the earliest uncompleted call successfully.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#errorNext(java.lang.RuntimeException)">errorNext</A></B>(java.lang.RuntimeException e)</CODE> + +<BR> + Complete the earliest uncompleted call with the given error.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List<<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><byte[],byte[]>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#history()">history</A></B>()</CODE> + +<BR> + Get the list of sent records since the last call to <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#clear()"><CODE>clear()</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Map<<A HREF="../../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common">MetricName</A>,<A HREF="../../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common">Metric</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#metrics()">metrics</A></B>()</CODE> + +<BR> + Return a map of metrics maintained by the producer</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List<<A HREF="../../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#partitionsFor(java.lang.String)">partitionsFor</A></B>(java.lang.String topic)</CODE> + +<BR> + Get a list of partitions for the given topic for custom partition assignment.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)">send</A></B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><byte[],byte[]> record)</CODE> + +<BR> + Adds the record to the list of sent records.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)">send</A></B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><byte[],byte[]> record, + <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer">Callback</A> callback)</CODE> + +<BR> + Adds the record to the list of sent records.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="MockProducer(org.apache.kafka.common.Cluster, boolean)"><!-- --></A><H3> +MockProducer</H3> +<PRE> +public <B>MockProducer</B>(<A HREF="../../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</A> cluster, + boolean autoComplete)</PRE> +<DL> +<DD>Create a mock producer +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>cluster</CODE> - The cluster holding metadata for this producer<DD><CODE>autoComplete</CODE> - If true automatically complete all requests successfully and execute the callback. Otherwise + the user must call <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#completeNext()"><CODE>completeNext()</CODE></A> or <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#errorNext(java.lang.RuntimeException)"><CODE>errorNext(RuntimeException)</CODE></A> after + <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)"><CODE>send()</CODE></A> to complete the call and unblock the @{link + java.util.concurrent.Future Future<RecordMetadata>} that is returned.</DL> +</DL> +<HR> + +<A NAME="MockProducer(boolean)"><!-- --></A><H3> +MockProducer</H3> +<PRE> +public <B>MockProducer</B>(boolean autoComplete)</PRE> +<DL> +<DD>Create a new mock producer with invented metadata the given autoComplete setting. + + Equivalent to <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#MockProducer(org.apache.kafka.common.Cluster, boolean)"><CODE>new MockProducer(null, autoComplete)</CODE></A> +<P> +</DL> +<HR> + +<A NAME="MockProducer()"><!-- --></A><H3> +MockProducer</H3> +<PRE> +public <B>MockProducer</B>()</PRE> +<DL> +<DD>Create a new auto completing mock producer + + Equivalent to <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#MockProducer(boolean)"><CODE>new MockProducer(true)</CODE></A> +<P> +</DL> + +<!-- ============ 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="send(org.apache.kafka.clients.producer.ProducerRecord)"><!-- --></A><H3> +send</H3> +<PRE> +public java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>> <B>send</B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><byte[],byte[]> record)</PRE> +<DL> +<DD>Adds the record to the list of sent records. The <A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer"><CODE>RecordMetadata</CODE></A> returned will be immediately satisfied. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#send(org.apache.kafka.clients.producer.ProducerRecord)">send</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></CODE></DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>record</CODE> - The record to send +<DT><B>Returns:</B><DD>A future which will eventually contain the response information<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#history()"><CODE>history()</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)"><!-- --></A><H3> +send</H3> +<PRE> +public java.util.concurrent.Future<<A HREF="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</A>> <B>send</B>(<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><byte[],byte[]> record, + <A HREF="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer">Callback</A> callback)</PRE> +<DL> +<DD>Adds the record to the list of sent records. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#send(org.apache.kafka.clients.producer.ProducerRecord, org.apache.kafka.clients.producer.Callback)">send</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></CODE></DL> +</DD> +<DD><DL> +<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#history()"><CODE>history()</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="partitionsFor(java.lang.String)"><!-- --></A><H3> +partitionsFor</H3> +<PRE> +public java.util.List<<A HREF="../../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</A>> <B>partitionsFor</B>(java.lang.String topic)</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#partitionsFor(java.lang.String)">Producer</A></CODE></B></DD> +<DD>Get a list of partitions for the given topic for custom partition assignment. The partition metadata will change + over time so this list should not be cached. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#partitionsFor(java.lang.String)">partitionsFor</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="metrics()"><!-- --></A><H3> +metrics</H3> +<PRE> +public java.util.Map<<A HREF="../../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common">MetricName</A>,<A HREF="../../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common">Metric</A>> <B>metrics</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#metrics()">Producer</A></CODE></B></DD> +<DD>Return a map of metrics maintained by the producer +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#metrics()">metrics</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="close()"><!-- --></A><H3> +close</H3> +<PRE> +public void <B>close</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#close()">Producer</A></CODE></B></DD> +<DD>Close this producer +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE>close</CODE> in interface <CODE>java.io.Closeable</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</A><byte[],byte[]></CODE></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="history()"><!-- --></A><H3> +history</H3> +<PRE> +public java.util.List<<A HREF="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer">ProducerRecord</A><byte[],byte[]>> <B>history</B>()</PRE> +<DL> +<DD>Get the list of sent records since the last call to <A HREF="../../../../../org/apache/kafka/clients/producer/MockProducer.html#clear()"><CODE>clear()</CODE></A> +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="clear()"><!-- --></A><H3> +clear</H3> +<PRE> +public void <B>clear</B>()</PRE> +<DL> +<DD>Clear the stored history of sent records +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="completeNext()"><!-- --></A><H3> +completeNext</H3> +<PRE> +public boolean <B>completeNext</B>()</PRE> +<DL> +<DD>Complete the earliest uncompleted call successfully. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true if there was an uncompleted call to complete</DL> +</DD> +</DL> +<HR> + +<A NAME="errorNext(java.lang.RuntimeException)"><!-- --></A><H3> +errorNext</H3> +<PRE> +public boolean <B>errorNext</B>(java.lang.RuntimeException e)</PRE> +<DL> +<DD>Complete the earliest uncompleted call with the given error. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true if there was an uncompleted call to complete</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="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="class in org.apache.kafka.clients.producer"><B>PREV CLASS</B></A> + <A HREF="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?org/apache/kafka/clients/producer/MockProducer.html" target="_top"><B>FRAMES</B></A> + <A HREF="MockProducer.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML>