| <!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_80) on Fri Nov 10 23:49:16 GMT 2017 --> |
| <title>ClusterResourceListener (kafka 0.11.0.2 API)</title> |
| <meta name="date" content="2017-11-10"> |
| <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="ClusterResourceListener (kafka 0.11.0.2 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/common/ClusterResource.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/kafka/common/ClusterResourceListener.html" target="_top">Frames</a></li> |
| <li><a href="ClusterResourceListener.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.common</div> |
| <h2 title="Interface ClusterResourceListener" class="title">Interface ClusterResourceListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ClusterResourceListener</span></pre> |
| <div class="block">A callback interface that users can implement when they wish to get notified about changes in the Cluster metadata. |
| <p> |
| Users who need access to cluster metadata in interceptors, metric reporters, serializers and deserializers |
| can implement this interface. The order of method calls for each of these types is described below. |
| <p> |
| <h4>Clients</h4> |
| There will be one invocation of <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> after each metadata response. |
| Note that the cluster id may be null when the Kafka broker version is below 0.10.1.0. If you receive a null cluster id, you can expect it to always be null unless you have a cluster with multiple broker versions which can happen if the cluster is being upgraded while the client is running. |
| <p> |
| <a href="../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="interface in org.apache.kafka.clients.producer"><code>ProducerInterceptor</code></a> : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked after <a href="../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html#onSend(org.apache.kafka.clients.producer.ProducerRecord)"><code>ProducerInterceptor.onSend(ProducerRecord)</code></a> |
| but before <a href="../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html#onAcknowledgement(org.apache.kafka.clients.producer.RecordMetadata,%20java.lang.Exception)"><code>ProducerInterceptor.onAcknowledgement(RecordMetadata, Exception)</code></a> . |
| <p> |
| <a href="../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="interface in org.apache.kafka.clients.consumer"><code>ConsumerInterceptor</code></a> : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked before <a href="../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html#onConsume(org.apache.kafka.clients.consumer.ConsumerRecords)"><code>ConsumerInterceptor.onConsume(ConsumerRecords)</code></a> |
| <p> |
| <a href="../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><code>Serializer</code></a> : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked before <a href="../../../../org/apache/kafka/common/serialization/Serializer.html#serialize(java.lang.String,%20T)"><code>Serializer.serialize(String, Object)</code></a> |
| <p> |
| <a href="../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization"><code>Deserializer</code></a> : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked before <a href="../../../../org/apache/kafka/common/serialization/Deserializer.html#deserialize(java.lang.String,%20byte[])"><code>Deserializer.deserialize(String, byte[])</code></a> |
| <p> |
| <code>MetricsReporter</code> : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked after first <a href="../../../../org/apache/kafka/clients/producer/KafkaProducer.html#send(org.apache.kafka.clients.producer.ProducerRecord)"><code>KafkaProducer.send(ProducerRecord)</code></a> invocation for Producer metrics reporter |
| and after first <a href="../../../../org/apache/kafka/clients/consumer/KafkaConsumer.html#poll(long)"><code>KafkaConsumer.poll(long)</code></a> invocation for Consumer metrics reporters. The reporter may receive metric events from the network layer before this method is invoked. |
| <h4>Broker</h4> |
| There is a single invocation <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> on broker start-up and the cluster metadata will never change. |
| <p> |
| KafkaMetricsReporter : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked during the bootup of the Kafka broker. The reporter may receive metric events from the network layer before this method is invoked. |
| <p> |
| <code>MetricsReporter</code> : The <a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)"><code>onUpdate(ClusterResource)</code></a> method will be invoked during the bootup of the Kafka broker. The reporter may receive metric events from the network layer before this method is invoked.</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/common/ClusterResourceListener.html#onUpdate(org.apache.kafka.common.ClusterResource)">onUpdate</a></strong>(<a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common">ClusterResource</a> clusterResource)</code> |
| <div class="block">A callback method that a user can implement to get updates for <a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common"><code>ClusterResource</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </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="onUpdate(org.apache.kafka.common.ClusterResource)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onUpdate</h4> |
| <pre>void onUpdate(<a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common">ClusterResource</a> clusterResource)</pre> |
| <div class="block">A callback method that a user can implement to get updates for <a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common"><code>ClusterResource</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clusterResource</code> - cluster metadata</dd></dl> |
| </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/common/ClusterResource.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/kafka/common/ClusterResourceListener.html" target="_top">Frames</a></li> |
| <li><a href="ClusterResourceListener.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> |
