http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/clients/producer/package-tree.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/clients/producer/package-tree.html b/10/javadoc/org/apache/kafka/clients/producer/package-tree.html new file mode 100644 index 0000000..578c069 --- /dev/null +++ b/10/javadoc/org/apache/kafka/clients/producer/package-tree.html @@ -0,0 +1,180 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:44 GMT 2017 --> +<title>org.apache.kafka.clients.producer Class Hierarchy (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.kafka.clients.producer Class Hierarchy (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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</li> +<li class="navBarCell1Rev">Tree</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/consumer/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/kafka/common/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/producer/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.kafka.clients.producer</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.kafka.common.config.<a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">AbstractConfig</span></a> +<ul> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html" title="class in org.apache.kafka.clients.producer"><span class="typeNameLink">ProducerConfig</span></a></li> +</ul> +</li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/KafkaProducer.html" title="class in org.apache.kafka.clients.producer"><span class="typeNameLink">KafkaProducer</span></a><K,V> (implements org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</a><K,V>)</li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/MockProducer.html" title="class in org.apache.kafka.clients.producer"><span class="typeNameLink">MockProducer</span></a><K,V> (implements org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer">Producer</a><K,V>)</li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/ProducerRecord.html" title="class in org.apache.kafka.clients.producer"><span class="typeNameLink">ProducerRecord</span></a><K,V></li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer"><span class="typeNameLink">RecordMetadata</span></a></li> +<li type="circle">java.lang.Throwable (implements java.io.Serializable) +<ul> +<li type="circle">java.lang.Exception +<ul> +<li type="circle">java.lang.RuntimeException +<ul> +<li type="circle">org.apache.kafka.common.<a href="../../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common"><span class="typeNameLink">KafkaException</span></a> +<ul> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/BufferExhaustedException.html" title="class in org.apache.kafka.clients.producer"><span class="typeNameLink">BufferExhaustedException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">java.lang.AutoCloseable +<ul> +<li type="circle">java.io.Closeable +<ul> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/Partitioner.html" title="interface in org.apache.kafka.clients.producer"><span class="typeNameLink">Partitioner</span></a> (also extends org.apache.kafka.common.<a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a>)</li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/Producer.html" title="interface in org.apache.kafka.clients.producer"><span class="typeNameLink">Producer</span></a><K,V></li> +</ul> +</li> +</ul> +</li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/Callback.html" title="interface in org.apache.kafka.clients.producer"><span class="typeNameLink">Callback</span></a></li> +<li type="circle">org.apache.kafka.common.<a href="../../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Configurable</span></a> +<ul> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/Partitioner.html" title="interface in org.apache.kafka.clients.producer"><span class="typeNameLink">Partitioner</span></a> (also extends java.io.Closeable)</li> +<li type="circle">org.apache.kafka.clients.producer.<a href="../../../../../org/apache/kafka/clients/producer/ProducerInterceptor.html" title="interface in org.apache.kafka.clients.producer"><span class="typeNameLink">ProducerInterceptor</span></a><K,V></li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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</li> +<li class="navBarCell1Rev">Tree</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/consumer/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/kafka/common/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/producer/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/Cluster.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/Cluster.html b/10/javadoc/org/apache/kafka/common/Cluster.html new file mode 100644 index 0000000..acfd4a0 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/Cluster.html @@ -0,0 +1,630 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>Cluster (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Cluster (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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>Prev Class</li> +<li><a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Cluster.html" target="_top">Frames</a></li> +<li><a href="Cluster.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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="Class Cluster" class="title">Class Cluster</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.Cluster</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">Cluster</span> +extends java.lang.Object</pre> +<div class="block">A representation of a subset of the nodes, topics, and partitions in the Kafka cluster.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#Cluster-java.lang.String-java.util.Collection-java.util.Collection-java.util.Set-java.util.Set-">Cluster</a></span>(java.lang.String clusterId, + java.util.Collection<<a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>> nodes, + java.util.Collection<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitions, + java.util.Set<java.lang.String> unauthorizedTopics, + java.util.Set<java.lang.String> internalTopics)</code> +<div class="block">Create a new cluster with the given id, nodes and partitions</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#Cluster-java.lang.String-java.util.Collection-java.util.Collection-java.util.Set-java.util.Set-org.apache.kafka.common.Node-">Cluster</a></span>(java.lang.String clusterId, + java.util.Collection<<a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>> nodes, + java.util.Collection<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitions, + java.util.Set<java.lang.String> unauthorizedTopics, + java.util.Set<java.lang.String> internalTopics, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> controller)</code> +<div class="block">Create a new cluster with the given id, nodes and partitions</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#availablePartitionsForTopic-java.lang.String-">availablePartitionsForTopic</a></span>(java.lang.String topic)</code> +<div class="block">Get the list of available partitions for this topic</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#bootstrap-java.util.List-">bootstrap</a></span>(java.util.List<java.net.InetSocketAddress> addresses)</code> +<div class="block">Create a "bootstrap" cluster using the given list of host/ports</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common">ClusterResource</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#clusterResource--">clusterResource</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#controller--">controller</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#empty--">empty</a></span>()</code> +<div class="block">Create an empty cluster instance with no nodes and no topic-partitions.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#internalTopics--">internalTopics</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#isBootstrapConfigured--">isBootstrapConfigured</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#leaderFor-org.apache.kafka.common.TopicPartition-">leaderFor</a></span>(<a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> topicPartition)</code> +<div class="block">Get the current leader for the given topic-partition</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#nodeById-int-">nodeById</a></span>(int id)</code> +<div class="block">Get the node by the node id (or null if no such node exists)</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#nodes--">nodes</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#partition-org.apache.kafka.common.TopicPartition-">partition</a></span>(<a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> topicPartition)</code> +<div class="block">Get the metadata for the specified partition</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#partitionCountForTopic-java.lang.String-">partitionCountForTopic</a></span>(java.lang.String topic)</code> +<div class="block">Get the number of partitions for the given topic</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#partitionsForNode-int-">partitionsForNode</a></span>(int nodeId)</code> +<div class="block">Get the list of partitions whose leader is this node</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#partitionsForTopic-java.lang.String-">partitionsForTopic</a></span>(java.lang.String topic)</code> +<div class="block">Get the list of partitions for this topic</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#topics--">topics</a></span>()</code> +<div class="block">Get all topics.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#unauthorizedTopics--">unauthorizedTopics</a></span>()</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Cluster.html#withPartitions-java.util.Map-">withPartitions</a></span>(java.util.Map<<a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitions)</code> +<div class="block">Return a copy of this cluster combined with `partitions`.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Cluster-java.lang.String-java.util.Collection-java.util.Collection-java.util.Set-java.util.Set-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Cluster</h4> +<pre>public Cluster(java.lang.String clusterId, + java.util.Collection<<a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>> nodes, + java.util.Collection<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitions, + java.util.Set<java.lang.String> unauthorizedTopics, + java.util.Set<java.lang.String> internalTopics)</pre> +<div class="block">Create a new cluster with the given id, nodes and partitions</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nodes</code> - The nodes in the cluster</dd> +<dd><code>partitions</code> - Information about a subset of the topic-partitions this cluster hosts</dd> +</dl> +</li> +</ul> +<a name="Cluster-java.lang.String-java.util.Collection-java.util.Collection-java.util.Set-java.util.Set-org.apache.kafka.common.Node-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Cluster</h4> +<pre>public Cluster(java.lang.String clusterId, + java.util.Collection<<a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>> nodes, + java.util.Collection<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitions, + java.util.Set<java.lang.String> unauthorizedTopics, + java.util.Set<java.lang.String> internalTopics, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> controller)</pre> +<div class="block">Create a new cluster with the given id, nodes and partitions</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nodes</code> - The nodes in the cluster</dd> +<dd><code>partitions</code> - Information about a subset of the topic-partitions this cluster hosts</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="empty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>empty</h4> +<pre>public static <a href="../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> empty()</pre> +<div class="block">Create an empty cluster instance with no nodes and no topic-partitions.</div> +</li> +</ul> +<a name="bootstrap-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bootstrap</h4> +<pre>public static <a href="../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> bootstrap(java.util.List<java.net.InetSocketAddress> addresses)</pre> +<div class="block">Create a "bootstrap" cluster using the given list of host/ports</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addresses</code> - The addresses</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A cluster for these hosts/ports</dd> +</dl> +</li> +</ul> +<a name="withPartitions-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withPartitions</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> withPartitions(java.util.Map<<a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitions)</pre> +<div class="block">Return a copy of this cluster combined with `partitions`.</div> +</li> +</ul> +<a name="nodes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nodes</h4> +<pre>public java.util.List<<a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>> nodes()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The known set of nodes</dd> +</dl> +</li> +</ul> +<a name="nodeById-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nodeById</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> nodeById(int id)</pre> +<div class="block">Get the node by the node id (or null if no such node exists)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - The id of the node</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The node, or null if no such node exists</dd> +</dl> +</li> +</ul> +<a name="leaderFor-org.apache.kafka.common.TopicPartition-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaderFor</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> leaderFor(<a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> topicPartition)</pre> +<div class="block">Get the current leader for the given topic-partition</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topicPartition</code> - The topic and partition we want to know the leader for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The node that is the leader for this topic-partition, or null if there is currently no leader</dd> +</dl> +</li> +</ul> +<a name="partition-org.apache.kafka.common.TopicPartition-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partition</h4> +<pre>public <a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a> partition(<a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> topicPartition)</pre> +<div class="block">Get the metadata for the specified partition</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topicPartition</code> - The topic and partition to fetch info for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The metadata about the given topic and partition</dd> +</dl> +</li> +</ul> +<a name="partitionsForTopic-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitionsForTopic</h4> +<pre>public java.util.List<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitionsForTopic(java.lang.String topic)</pre> +<div class="block">Get the list of partitions for this topic</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topic</code> - The topic name</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of partitions</dd> +</dl> +</li> +</ul> +<a name="partitionCountForTopic-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitionCountForTopic</h4> +<pre>public java.lang.Integer partitionCountForTopic(java.lang.String topic)</pre> +<div class="block">Get the number of partitions for the given topic</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topic</code> - The topic to get the number of partitions for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The number of partitions or null if there is no corresponding metadata</dd> +</dl> +</li> +</ul> +<a name="availablePartitionsForTopic-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>availablePartitionsForTopic</h4> +<pre>public java.util.List<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> availablePartitionsForTopic(java.lang.String topic)</pre> +<div class="block">Get the list of available partitions for this topic</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topic</code> - The topic name</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of partitions</dd> +</dl> +</li> +</ul> +<a name="partitionsForNode-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitionsForNode</h4> +<pre>public java.util.List<<a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a>> partitionsForNode(int nodeId)</pre> +<div class="block">Get the list of partitions whose leader is this node</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nodeId</code> - The node id</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of partitions</dd> +</dl> +</li> +</ul> +<a name="topics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>topics</h4> +<pre>public java.util.Set<java.lang.String> topics()</pre> +<div class="block">Get all topics.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a set of all topics</dd> +</dl> +</li> +</ul> +<a name="unauthorizedTopics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unauthorizedTopics</h4> +<pre>public java.util.Set<java.lang.String> unauthorizedTopics()</pre> +</li> +</ul> +<a name="internalTopics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>internalTopics</h4> +<pre>public java.util.Set<java.lang.String> internalTopics()</pre> +</li> +</ul> +<a name="isBootstrapConfigured--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBootstrapConfigured</h4> +<pre>public boolean isBootstrapConfigured()</pre> +</li> +</ul> +<a name="clusterResource--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clusterResource</h4> +<pre>public <a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common">ClusterResource</a> clusterResource()</pre> +</li> +</ul> +<a name="controller--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>controller</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> controller()</pre> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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>Prev Class</li> +<li><a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Cluster.html" target="_top">Frames</a></li> +<li><a href="Cluster.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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/2e200cfc/10/javadoc/org/apache/kafka/common/ClusterResource.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/ClusterResource.html b/10/javadoc/org/apache/kafka/common/ClusterResource.html new file mode 100644 index 0000000..7fdfd9a --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/ClusterResource.html @@ -0,0 +1,300 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>ClusterResource (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ClusterResource (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/Cluster.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/ClusterResourceListener.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/ClusterResource.html" target="_top">Frames</a></li> +<li><a href="ClusterResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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="Class ClusterResource" class="title">Class ClusterResource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.ClusterResource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ClusterResource</span> +extends java.lang.Object</pre> +<div class="block">The <code>ClusterResource</code> class encapsulates metadata for a Kafka cluster.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/ClusterResource.html#ClusterResource-java.lang.String-">ClusterResource</a></span>(java.lang.String clusterId)</code> +<div class="block">Create <a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common"><code>ClusterResource</code></a> with a cluster id.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/ClusterResource.html#clusterId--">clusterId</a></span>()</code> +<div class="block">Return the cluster id.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/ClusterResource.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ClusterResource-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClusterResource</h4> +<pre>public ClusterResource(java.lang.String clusterId)</pre> +<div class="block">Create <a href="../../../../org/apache/kafka/common/ClusterResource.html" title="class in org.apache.kafka.common"><code>ClusterResource</code></a> with a cluster id. Note that cluster id may be <code>null</code> if the + metadata request was sent to a broker without support for cluster ids. The first version of Kafka + to support cluster id is 0.10.1.0.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clusterId</code> - </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="clusterId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clusterId</h4> +<pre>public java.lang.String clusterId()</pre> +<div class="block">Return the cluster id. Note that it may be <code>null</code> if the metadata request was sent to a broker without + support for cluster ids. The first version of Kafka to support cluster id is 0.10.1.0.</div> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/Cluster.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/ClusterResourceListener.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/ClusterResource.html" target="_top">Frames</a></li> +<li><a href="ClusterResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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/2e200cfc/10/javadoc/org/apache/kafka/common/ClusterResourceListener.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/ClusterResourceListener.html b/10/javadoc/org/apache/kafka/common/ClusterResourceListener.html new file mode 100644 index 0000000..f173b27 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/ClusterResourceListener.html @@ -0,0 +1,252 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>ClusterResourceListener (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ClusterResourceListener (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">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="typeNameLabel">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-java.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-T-"><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-byte:A-"><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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/ClusterResourceListener.html#onUpdate-org.apache.kafka.common.ClusterResource-">onUpdate</a></span>(<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="paramLabel">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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/Configurable.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">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> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/Configurable.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/Configurable.html b/10/javadoc/org/apache/kafka/common/Configurable.html new file mode 100644 index 0000000..6eea06d --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/Configurable.html @@ -0,0 +1,231 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>Configurable (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Configurable (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/ClusterResourceListener.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Configurable.html" target="_top">Frames</a></li> +<li><a href="Configurable.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 Configurable" class="title">Interface Configurable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/kafka/server/policy/AlterConfigPolicy.html" title="interface in org.apache.kafka.server.policy">AlterConfigPolicy</a>, <a href="../../../../org/apache/kafka/clients/consumer/ConsumerInterceptor.html" title="interface in org.apache.kafka.clients.consumer">ConsumerInterceptor</a><K,V>, <a href="../../../../org/apache/kafka/server/policy/CreateTopicPolicy.html" title="interface in org.apache.kafka.server.policy">CreateTopicPolicy</a>, <a href="../../../../org/apache/kafka/streams/errors/DeserializationExceptionHandler.html" title="interface in org.apache.kafka.streams.errors">DeserializationExceptionHandler</a>, <a href="../../../../org/apache/kafka/clients/producer/Partitioner.html" title="interface in org.apache.kafka.clients.producer">Partitioner</a>, <a href="../../../../org/apache/kafka/common/security/auth/PrincipalBuilder.html" title="interface in org.apache.kafka.common.security.auth">PrincipalBuilder</a>, <a href="../../../../org/apach e/kafka/clients/producer/ProducerInterceptor.html" title="interface in org.apache.kafka.clients.producer">ProducerInterceptor</a><K,V>, <a href="../../../../org/apache/kafka/connect/transforms/Transformation.html" title="interface in org.apache.kafka.connect.transforms">Transformation</a><R></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/kafka/common/security/auth/DefaultPrincipalBuilder.html" title="class in org.apache.kafka.common.security.auth">DefaultPrincipalBuilder</a>, <a href="../../../../org/apache/kafka/streams/errors/LogAndContinueExceptionHandler.html" title="class in org.apache.kafka.streams.errors">LogAndContinueExceptionHandler</a>, <a href="../../../../org/apache/kafka/streams/errors/LogAndFailExceptionHandler.html" title="class in org.apache.kafka.streams.errors">LogAndFailExceptionHandler</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Configurable</span></pre> +<div class="block">A Mix-in style interface for classes that are instantiated by reflection and need to take configuration parameters</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Configurable.html#configure-java.util.Map-">configure</a></span>(java.util.Map<java.lang.String,?> configs)</code> +<div class="block">Configure this class with the given key-value pairs</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="configure-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>configure</h4> +<pre>void configure(java.util.Map<java.lang.String,?> configs)</pre> +<div class="block">Configure this class with the given key-value pairs</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/ClusterResourceListener.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Configurable.html" target="_top">Frames</a></li> +<li><a href="Configurable.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> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/KafkaException.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/KafkaException.html b/10/javadoc/org/apache/kafka/common/KafkaException.html new file mode 100644 index 0000000..705b974 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/KafkaException.html @@ -0,0 +1,308 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>KafkaException (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KafkaException (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/Configurable.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaException.html" target="_top">Frames</a></li> +<li><a href="KafkaException.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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="Class KafkaException" class="title">Class KafkaException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.KafkaException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/kafka/common/errors/ApiException.html" title="class in org.apache.kafka.common.errors">ApiException</a>, <a href="../../../../org/apache/kafka/clients/producer/BufferExhaustedException.html" title="class in org.apache.kafka.clients.producer">BufferExhaustedException</a>, <a href="../../../../org/apache/kafka/clients/consumer/CommitFailedException.html" title="class in org.apache.kafka.clients.consumer">CommitFailedException</a>, <a href="../../../../org/apache/kafka/common/config/ConfigException.html" title="class in org.apache.kafka.common.config">ConfigException</a>, <a href="../../../../org/apache/kafka/connect/errors/ConnectException.html" title="class in org.apache.kafka.connect.errors">ConnectException</a>, <a href="../../../../org/apache/kafka/common/errors/InterruptException.html" title="class in org.apache.kafka.common.errors">InterruptException</a>, <a href="../../../../org/apache/kafka/clients/consumer/InvalidOffsetException.html" title ="class in org.apache.kafka.clients.consumer">InvalidOffsetException</a>, <a href="../../../../org/apache/kafka/common/errors/SerializationException.html" title="class in org.apache.kafka.common.errors">SerializationException</a>, <a href="../../../../org/apache/kafka/streams/errors/StreamsException.html" title="class in org.apache.kafka.streams.errors">StreamsException</a>, <a href="../../../../org/apache/kafka/common/errors/WakeupException.html" title="class in org.apache.kafka.common.errors">WakeupException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">KafkaException</span> +extends java.lang.RuntimeException</pre> +<div class="block">The base class of all other Kafka exceptions</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.kafka.common.KafkaException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaException.html#KafkaException--">KafkaException</a></span>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaException.html#KafkaException-java.lang.String-">KafkaException</a></span>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaException.html#KafkaException-java.lang.String-java.lang.Throwable-">KafkaException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaException.html#KafkaException-java.lang.Throwable-">KafkaException</a></span>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="KafkaException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KafkaException</h4> +<pre>public KafkaException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="KafkaException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KafkaException</h4> +<pre>public KafkaException(java.lang.String message)</pre> +</li> +</ul> +<a name="KafkaException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KafkaException</h4> +<pre>public KafkaException(java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="KafkaException--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KafkaException</h4> +<pre>public KafkaException()</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/Configurable.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaException.html" target="_top">Frames</a></li> +<li><a href="KafkaException.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
