http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2d621da3/0101/javadoc/org/apache/kafka/clients/producer/ProducerConfig.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/clients/producer/ProducerConfig.html b/0101/javadoc/org/apache/kafka/clients/producer/ProducerConfig.html new file mode 100644 index 0000000..72adbc8 --- /dev/null +++ b/0101/javadoc/org/apache/kafka/clients/producer/ProducerConfig.html @@ -0,0 +1,831 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Oct 04 12:37:09 PDT 2016 --> +<title>ProducerConfig (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ProducerConfig (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="interface in org.apache.kafka.clients.producer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/producer/ProducerConfig.html" target="_top">Frames</a></li> +<li><a href="ProducerConfig.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.producer</div> +<h2 title="Class ProducerConfig" class="title">Class ProducerConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">org.apache.kafka.common.config.AbstractConfig</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.producer.ProducerConfig</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ProducerConfig</span> +extends <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></pre> +<div class="block">Configuration for the Kafka Producer. Documentation for these configurations can be found in the <a + href="http://kafka.apache.org/documentation.html#producerconfigs";>Kafka documentation</a></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#ACKS_CONFIG">ACKS_CONFIG</a></strong></code> +<div class="block"><code>acks</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#BATCH_SIZE_CONFIG">BATCH_SIZE_CONFIG</a></strong></code> +<div class="block"><code>batch.size</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#BLOCK_ON_BUFFER_FULL_CONFIG">BLOCK_ON_BUFFER_FULL_CONFIG</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This config will be removed in a future release. Please use <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_BLOCK_MS_CONFIG"><code>MAX_BLOCK_MS_CONFIG</code></a>.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#BOOTSTRAP_SERVERS_CONFIG">BOOTSTRAP_SERVERS_CONFIG</a></strong></code> +<div class="block"><code>bootstrap.servers</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#BUFFER_MEMORY_CONFIG">BUFFER_MEMORY_CONFIG</a></strong></code> +<div class="block"><code>buffer.memory</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#CLIENT_ID_CONFIG">CLIENT_ID_CONFIG</a></strong></code> +<div class="block"><code>client.id</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#COMPRESSION_TYPE_CONFIG">COMPRESSION_TYPE_CONFIG</a></strong></code> +<div class="block"><code>compression.type</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#CONNECTIONS_MAX_IDLE_MS_CONFIG">CONNECTIONS_MAX_IDLE_MS_CONFIG</a></strong></code> +<div class="block"><code>connections.max.idle.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#INTERCEPTOR_CLASSES_CONFIG">INTERCEPTOR_CLASSES_CONFIG</a></strong></code> +<div class="block"><code>interceptor.classes</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#INTERCEPTOR_CLASSES_DOC">INTERCEPTOR_CLASSES_DOC</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#KEY_SERIALIZER_CLASS_CONFIG">KEY_SERIALIZER_CLASS_CONFIG</a></strong></code> +<div class="block"><code>key.serializer</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#KEY_SERIALIZER_CLASS_DOC">KEY_SERIALIZER_CLASS_DOC</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#LINGER_MS_CONFIG">LINGER_MS_CONFIG</a></strong></code> +<div class="block"><code>linger.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_BLOCK_MS_CONFIG">MAX_BLOCK_MS_CONFIG</a></strong></code> +<div class="block"><code>max.block.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION">MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION</a></strong></code> +<div class="block"><code>max.in.flight.requests.per.connection</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_REQUEST_SIZE_CONFIG">MAX_REQUEST_SIZE_CONFIG</a></strong></code> +<div class="block"><code>max.request.size</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#METADATA_FETCH_TIMEOUT_CONFIG">METADATA_FETCH_TIMEOUT_CONFIG</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This config will be removed in a future release. Please use <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_BLOCK_MS_CONFIG"><code>MAX_BLOCK_MS_CONFIG</code></a></i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#METADATA_MAX_AGE_CONFIG">METADATA_MAX_AGE_CONFIG</a></strong></code> +<div class="block"><code>metadata.max.age.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#METRIC_REPORTER_CLASSES_CONFIG">METRIC_REPORTER_CLASSES_CONFIG</a></strong></code> +<div class="block"><code>metric.reporters</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#METRICS_NUM_SAMPLES_CONFIG">METRICS_NUM_SAMPLES_CONFIG</a></strong></code> +<div class="block"><code>metrics.num.samples</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#METRICS_SAMPLE_WINDOW_MS_CONFIG">METRICS_SAMPLE_WINDOW_MS_CONFIG</a></strong></code> +<div class="block"><code>metrics.sample.window.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#PARTITIONER_CLASS_CONFIG">PARTITIONER_CLASS_CONFIG</a></strong></code> +<div class="block"><code>partitioner.class</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#RECEIVE_BUFFER_CONFIG">RECEIVE_BUFFER_CONFIG</a></strong></code> +<div class="block"><code>receive.buffer.bytes</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#RECONNECT_BACKOFF_MS_CONFIG">RECONNECT_BACKOFF_MS_CONFIG</a></strong></code> +<div class="block"><code>reconnect.backoff.ms</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#REQUEST_TIMEOUT_MS_CONFIG">REQUEST_TIMEOUT_MS_CONFIG</a></strong></code> +<div class="block"><code>request.timeout.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#RETRIES_CONFIG">RETRIES_CONFIG</a></strong></code> +<div class="block"><code>retries</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#RETRY_BACKOFF_MS_CONFIG">RETRY_BACKOFF_MS_CONFIG</a></strong></code> +<div class="block"><code>retry.backoff.ms</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#SEND_BUFFER_CONFIG">SEND_BUFFER_CONFIG</a></strong></code> +<div class="block"><code>send.buffer.bytes</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#TIMEOUT_CONFIG">TIMEOUT_CONFIG</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This config will be removed in a future release. Please use <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#REQUEST_TIMEOUT_MS_CONFIG"><code>REQUEST_TIMEOUT_MS_CONFIG</code></a></i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#VALUE_SERIALIZER_CLASS_CONFIG">VALUE_SERIALIZER_CLASS_CONFIG</a></strong></code> +<div class="block"><code>value.serializer</code></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#VALUE_SERIALIZER_CLASS_DOC">VALUE_SERIALIZER_CLASS_DOC</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#addSerializerToConfig(java.util.Map,%20org.apache.kafka.common.serialization.Serializer,%20org.apache.kafka.common.serialization.Serializer)">addSerializerToConfig</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> configs, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> keySerializer, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> valueSerializer)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#addSerializerToConfig(java.util.Properties,%20org.apache.kafka.common.serialization.Serializer,%20org.apache.kafka.common.serialization.Serializer)">addSerializerToConfig</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> properties, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> keySerializer, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> valueSerializer)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#configNames()">configNames</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#main(java.lang.String[])">main</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] args)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.common.config.AbstractConfig"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.common.config.<a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></h3> +<code><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#get(java.lang.String)">get</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getClass(java.lang.String)">getClass</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstance(java.lang.String,%20java.lang.Class)">getConfiguredInstance</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstances(java.lang.String,%20java.lang.Class)">getConfiguredInstances</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getDouble(java.lang.String)">getDouble</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getInt(java.l ang.String)">getInt</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getList(java.lang.String)">getList</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getLong(java.lang.String)">getLong</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getPassword(java.lang.String)">getPassword</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getShort(java.lang.String)">getShort</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getString(java.lang.String)">getString</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#hashCode()">hashCode</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#ignore(java.lang.String)">ignore</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#logUnused()">logUnused</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractCon fig.html#originals()">originals</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsStrings()">originalsStrings</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsWithPrefix(java.lang.String)">originalsWithPrefix</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#unused()">unused</a>, <a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#values()">values</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.ht ml?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="BOOTSTRAP_SERVERS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BOOTSTRAP_SERVERS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> BOOTSTRAP_SERVERS_CONFIG</pre> +<div class="block"><code>bootstrap.servers</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.BOOTSTRAP_SERVERS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="METADATA_FETCH_TIMEOUT_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METADATA_FETCH_TIMEOUT_CONFIG</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> METADATA_FETCH_TIMEOUT_CONFIG</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This config will be removed in a future release. Please use <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_BLOCK_MS_CONFIG"><code>MAX_BLOCK_MS_CONFIG</code></a></i></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.METADATA_FETCH_TIMEOUT_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="METADATA_MAX_AGE_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METADATA_MAX_AGE_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> METADATA_MAX_AGE_CONFIG</pre> +<div class="block"><code>metadata.max.age.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.METADATA_MAX_AGE_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="BATCH_SIZE_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BATCH_SIZE_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> BATCH_SIZE_CONFIG</pre> +<div class="block"><code>batch.size</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.BATCH_SIZE_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ACKS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ACKS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> ACKS_CONFIG</pre> +<div class="block"><code>acks</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.ACKS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TIMEOUT_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TIMEOUT_CONFIG</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> TIMEOUT_CONFIG</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This config will be removed in a future release. Please use <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#REQUEST_TIMEOUT_MS_CONFIG"><code>REQUEST_TIMEOUT_MS_CONFIG</code></a></i></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.TIMEOUT_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LINGER_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LINGER_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> LINGER_MS_CONFIG</pre> +<div class="block"><code>linger.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.LINGER_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CLIENT_ID_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLIENT_ID_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> CLIENT_ID_CONFIG</pre> +<div class="block"><code>client.id</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.CLIENT_ID_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="SEND_BUFFER_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SEND_BUFFER_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SEND_BUFFER_CONFIG</pre> +<div class="block"><code>send.buffer.bytes</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.SEND_BUFFER_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RECEIVE_BUFFER_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RECEIVE_BUFFER_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> RECEIVE_BUFFER_CONFIG</pre> +<div class="block"><code>receive.buffer.bytes</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.RECEIVE_BUFFER_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MAX_REQUEST_SIZE_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_REQUEST_SIZE_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> MAX_REQUEST_SIZE_CONFIG</pre> +<div class="block"><code>max.request.size</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.MAX_REQUEST_SIZE_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RECONNECT_BACKOFF_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RECONNECT_BACKOFF_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> RECONNECT_BACKOFF_MS_CONFIG</pre> +<div class="block"><code>reconnect.backoff.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.RECONNECT_BACKOFF_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MAX_BLOCK_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_BLOCK_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> MAX_BLOCK_MS_CONFIG</pre> +<div class="block"><code>max.block.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.MAX_BLOCK_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="BLOCK_ON_BUFFER_FULL_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BLOCK_ON_BUFFER_FULL_CONFIG</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> BLOCK_ON_BUFFER_FULL_CONFIG</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This config will be removed in a future release. Please use <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#MAX_BLOCK_MS_CONFIG"><code>MAX_BLOCK_MS_CONFIG</code></a>.</i></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.BLOCK_ON_BUFFER_FULL_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="BUFFER_MEMORY_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BUFFER_MEMORY_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> BUFFER_MEMORY_CONFIG</pre> +<div class="block"><code>buffer.memory</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.BUFFER_MEMORY_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RETRY_BACKOFF_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RETRY_BACKOFF_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> RETRY_BACKOFF_MS_CONFIG</pre> +<div class="block"><code>retry.backoff.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.RETRY_BACKOFF_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COMPRESSION_TYPE_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COMPRESSION_TYPE_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> COMPRESSION_TYPE_CONFIG</pre> +<div class="block"><code>compression.type</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.COMPRESSION_TYPE_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="METRICS_SAMPLE_WINDOW_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRICS_SAMPLE_WINDOW_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> METRICS_SAMPLE_WINDOW_MS_CONFIG</pre> +<div class="block"><code>metrics.sample.window.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.METRICS_SAMPLE_WINDOW_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="METRICS_NUM_SAMPLES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRICS_NUM_SAMPLES_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> METRICS_NUM_SAMPLES_CONFIG</pre> +<div class="block"><code>metrics.num.samples</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.METRICS_NUM_SAMPLES_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="METRIC_REPORTER_CLASSES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>METRIC_REPORTER_CLASSES_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> METRIC_REPORTER_CLASSES_CONFIG</pre> +<div class="block"><code>metric.reporters</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.METRIC_REPORTER_CLASSES_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION</pre> +<div class="block"><code>max.in.flight.requests.per.connection</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RETRIES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RETRIES_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> RETRIES_CONFIG</pre> +<div class="block"><code>retries</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.RETRIES_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="KEY_SERIALIZER_CLASS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEY_SERIALIZER_CLASS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> KEY_SERIALIZER_CLASS_CONFIG</pre> +<div class="block"><code>key.serializer</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="KEY_SERIALIZER_CLASS_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEY_SERIALIZER_CLASS_DOC</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> KEY_SERIALIZER_CLASS_DOC</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.KEY_SERIALIZER_CLASS_DOC">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="VALUE_SERIALIZER_CLASS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALUE_SERIALIZER_CLASS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> VALUE_SERIALIZER_CLASS_CONFIG</pre> +<div class="block"><code>value.serializer</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="VALUE_SERIALIZER_CLASS_DOC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALUE_SERIALIZER_CLASS_DOC</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> VALUE_SERIALIZER_CLASS_DOC</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.VALUE_SERIALIZER_CLASS_DOC">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CONNECTIONS_MAX_IDLE_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONNECTIONS_MAX_IDLE_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> CONNECTIONS_MAX_IDLE_MS_CONFIG</pre> +<div class="block"><code>connections.max.idle.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.CONNECTIONS_MAX_IDLE_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PARTITIONER_CLASS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PARTITIONER_CLASS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> PARTITIONER_CLASS_CONFIG</pre> +<div class="block"><code>partitioner.class</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.PARTITIONER_CLASS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="REQUEST_TIMEOUT_MS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REQUEST_TIMEOUT_MS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> REQUEST_TIMEOUT_MS_CONFIG</pre> +<div class="block"><code>request.timeout.ms</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.REQUEST_TIMEOUT_MS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INTERCEPTOR_CLASSES_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INTERCEPTOR_CLASSES_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> INTERCEPTOR_CLASSES_CONFIG</pre> +<div class="block"><code>interceptor.classes</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.INTERCEPTOR_CLASSES_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INTERCEPTOR_CLASSES_DOC"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INTERCEPTOR_CLASSES_DOC</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> INTERCEPTOR_CLASSES_DOC</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.clients.producer.ProducerConfig.INTERCEPTOR_CLASSES_DOC">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addSerializerToConfig(java.util.Map, org.apache.kafka.common.serialization.Serializer, org.apache.kafka.common.serialization.Serializer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSerializerToConfig</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> addSerializerToConfig(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> configs, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> keySerializer, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> valueSerializer)</pre> +</li> +</ul> +<a name="addSerializerToConfig(java.util.Properties, org.apache.kafka.common.serialization.Serializer, org.apache.kafka.common.serialization.Serializer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSerializerToConfig</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> addSerializerToConfig(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> properties, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> keySerializer, + <a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><?> valueSerializer)</pre> +</li> +</ul> +<a name="configNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>configNames</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> configNames()</pre> +</li> +</ul> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] args)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="interface in org.apache.kafka.clients.producer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/producer/ProducerConfig.html" target="_top">Frames</a></li> +<li><a href="ProducerConfig.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2d621da3/0101/javadoc/org/apache/kafka/clients/producer/ProducerInterceptor.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/clients/producer/ProducerInterceptor.html b/0101/javadoc/org/apache/kafka/clients/producer/ProducerInterceptor.html new file mode 100644 index 0000000..227bf44 --- /dev/null +++ b/0101/javadoc/org/apache/kafka/clients/producer/ProducerInterceptor.html @@ -0,0 +1,310 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Oct 04 12:37:09 PDT 2016 --> +<title>ProducerInterceptor (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ProducerInterceptor (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html" title="class in org.apache.kafka.clients.producer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/producer/ProducerInterceptor.html" target="_top">Frames</a></li> +<li><a href="ProducerInterceptor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.producer</div> +<h2 title="Interface ProducerInterceptor" class="title">Interface ProducerInterceptor<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ProducerInterceptor<K,V></span> +extends <a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></pre> +<div class="block">A plugin interface that allows you to intercept (and possibly mutate) the records received by the producer before + they are published to the Kafka cluster. + <p> + This class will get producer config properties via <code>configure()</code> method, including clientId assigned + by KafkaProducer if not specified in the producer config. The interceptor implementation needs to be aware that it will be + sharing producer config namespace with other interceptors and serializers, and ensure that there are no conflicts. + <p> + Exceptions thrown by ProducerInterceptor methods will be caught, logged, but not propagated further. As a result, if + the user configures the interceptor with the wrong key and value type parameters, the producer will not throw an exception, + just log the errors. + <p> + ProducerInterceptor callbacks may be called from multiple threads. Interceptor implementation must ensure thread-safety, if needed. + <p> + Implement <a href="../../../../../org/apache/kafka/common/ClusterResourceListener.html" title="interface in org.apache.kafka.common"><code>ClusterResourceListener</code></a> to receive cluster metadata once it's available. Please see the class documentation for ClusterResourceListener for more information.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html#close()">close</a></strong>()</code> +<div class="block">This is called when interceptor is closed</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html#onAcknowledgement(org.apache.kafka.clients.producer.RecordMetadata,%20java.lang.Exception)">onAcknowledgement</a></strong>(<a href="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</a> metadata, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> exception)</code> +<div class="block">This method is called when the record sent to the server has been acknowledged, or when sending the record fails before + it gets sent to the server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html#onSend(org.apache.kafka.clients.producer.ProducerRecord)">onSend</a></strong>(<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/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">V</a>> record)</code> +<div class="block">This is called from <a href="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)"><code>KafkaProducer.send(ProducerRecord)</code></a> and + <a href="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord,%20org.apache.kafka.clients.producer.Callback)"><code>KafkaProducer.send(ProducerRecord, Callback)</code></a> methods, before key and value + get serialized and partition is assigned (if partition is not specified in ProducerRecord).</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.common.Configurable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.kafka.common.<a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></h3> +<code><a href="../../../../../org/apache/kafka/common/Configurable.html#configure(java.util.Map)">configure</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="onSend(org.apache.kafka.clients.producer.ProducerRecord)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onSend</h4> +<pre><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/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">V</a>> onSend(<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/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">K</a>,<a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="type parameter in ProducerInterceptor">V</a>> record)</pre> +<div class="block">This is called from <a href="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)"><code>KafkaProducer.send(ProducerRecord)</code></a> and + <a href="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord,%20org.apache.kafka.clients.producer.Callback)"><code>KafkaProducer.send(ProducerRecord, Callback)</code></a> methods, before key and value + get serialized and partition is assigned (if partition is not specified in ProducerRecord). + <p> + This method is allowed to modify the record, in which case, the new record will be returned. The implication of modifying + key/value is that partition assignment (if not specified in ProducerRecord) will be done based on modified key/value, + not key/value from the client. Consequently, key and value transformation done in onSend() needs to be consistent: + same key and value should mutate to the same (modified) key and value. Otherwise, log compaction would not work + as expected. + <p> + Similarly, it is up to interceptor implementation to ensure that correct topic/partition is returned in ProducerRecord. + Most often, it should be the same topic/partition from 'record'. + <p> + Any exception thrown by this method will be caught by the caller and logged, but not propagated further. + <p> + Since the producer may run multiple interceptors, a particular interceptor's onSend() callback will be called in the order + specified by <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html#INTERCEPTOR_CLASSES_CONFIG"><code>ProducerConfig.INTERCEPTOR_CLASSES_CONFIG</code></a>. The first interceptor + in the list gets the record passed from the client, the following interceptor will be passed the record returned by the + previous interceptor, and so on. Since interceptors are allowed to modify records, interceptors may potentially get + the record already modified by other interceptors. However, building a pipeline of mutable interceptors that depend on the output + of the previous interceptor is discouraged, because of potential side-effects caused by interceptors potentially failing to + modify the record and throwing an exception. If one of the interceptors in the list throws an exception from onSend(), the exception + is caught, logged, and the next interceptor is called with the record returned by the last successful interceptor in the list, + or otherwise the client.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>record</code> - the record from client or the record returned by the previous interceptor in the chain of interceptors.</dd> +<dt><span class="strong">Returns:</span></dt><dd>producer record to send to topic/partition</dd></dl> +</li> +</ul> +<a name="onAcknowledgement(org.apache.kafka.clients.producer.RecordMetadata, java.lang.Exception)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onAcknowledgement</h4> +<pre>void onAcknowledgement(<a href="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</a> metadata, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> exception)</pre> +<div class="block">This method is called when the record sent to the server has been acknowledged, or when sending the record fails before + it gets sent to the server. + <p> + This method is generally called just before the user callback is called, and in additional cases when <code>KafkaProducer.send()</code> + throws an exception. + <p> + Any exception thrown by this method will be ignored by the caller. + <p> + This method will generally execute in the background I/O thread, so the implementation should be reasonably fast. + Otherwise, sending of messages from other threads could be delayed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>metadata</code> - The metadata for the record that was sent (i.e. the partition and offset). + If an error occurred, metadata will contain only valid topic and maybe + partition. If partition is not given in ProducerRecord and an error occurs + before partition gets assigned, then partition will be set to RecordMetadata.NO_PARTITION. + The metadata may be null if the client passed null record to + <a href="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)"><code>KafkaProducer.send(ProducerRecord)</code></a>.</dd><dd><code>exception</code> - The exception thrown during processing of this record. Null if no error occurred.</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">This is called when interceptor is closed</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html" title="class in org.apache.kafka.clients.producer"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/producer/ProducerInterceptor.html" target="_top">Frames</a></li> +<li><a href="ProducerInterceptor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
