http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2d621da3/0101/javadoc/org/apache/kafka/common/serialization/package-summary.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/common/serialization/package-summary.html b/0101/javadoc/org/apache/kafka/common/serialization/package-summary.html new file mode 100644 index 0000000..508a725 --- /dev/null +++ b/0101/javadoc/org/apache/kafka/common/serialization/package-summary.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 (version 1.7.0_79) on Tue Oct 04 12:37:09 PDT 2016 --> +<title>org.apache.kafka.common.serialization (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.kafka.common.serialization (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>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/errors/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/serialization/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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 title="Package" class="title">Package org.apache.kafka.common.serialization</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><T></td> +<td class="colLast"> +<div class="block">The interface for wrapping a serializer and deserializer for the given data type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/ByteArrayDeserializer.html" title="class in org.apache.kafka.common.serialization">ByteArrayDeserializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/ByteArraySerializer.html" title="class in org.apache.kafka.common.serialization">ByteArraySerializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/ByteBufferDeserializer.html" title="class in org.apache.kafka.common.serialization">ByteBufferDeserializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/ByteBufferSerializer.html" title="class in org.apache.kafka.common.serialization">ByteBufferSerializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/BytesDeserializer.html" title="class in org.apache.kafka.common.serialization">BytesDeserializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/BytesSerializer.html" title="class in org.apache.kafka.common.serialization">BytesSerializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/DoubleDeserializer.html" title="class in org.apache.kafka.common.serialization">DoubleDeserializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/DoubleSerializer.html" title="class in org.apache.kafka.common.serialization">DoubleSerializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/IntegerDeserializer.html" title="class in org.apache.kafka.common.serialization">IntegerDeserializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/IntegerSerializer.html" title="class in org.apache.kafka.common.serialization">IntegerSerializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/LongDeserializer.html" title="class in org.apache.kafka.common.serialization">LongDeserializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/LongSerializer.html" title="class in org.apache.kafka.common.serialization">LongSerializer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.html" title="class in org.apache.kafka.common.serialization">Serdes</a></td> +<td class="colLast"> +<div class="block">Factory for creating serializers / deserializers.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.ByteArraySerde.html" title="class in org.apache.kafka.common.serialization">Serdes.ByteArraySerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.ByteBufferSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.ByteBufferSerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.BytesSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.BytesSerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.DoubleSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.DoubleSerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.IntegerSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.IntegerSerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.LongSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.LongSerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.StringSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.StringSerde</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/Serdes.WrapperSerde.html" title="class in org.apache.kafka.common.serialization">Serdes.WrapperSerde</a><T></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/StringDeserializer.html" title="class in org.apache.kafka.common.serialization">StringDeserializer</a></td> +<td class="colLast"> +<div class="block">String encoding defaults to UTF8 and can be customized by setting the property key.deserializer.encoding, + value.deserializer.encoding or deserializer.encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/serialization/StringSerializer.html" title="class in org.apache.kafka.common.serialization">StringSerializer</a></td> +<td class="colLast"> +<div class="block">String encoding defaults to UTF8 and can be customized by setting the property key.serializer.encoding, + value.serializer.encoding or serializer.encoding.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/errors/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/serialization/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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/2d621da3/0101/javadoc/org/apache/kafka/common/serialization/package-tree.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/common/serialization/package-tree.html b/0101/javadoc/org/apache/kafka/common/serialization/package-tree.html new file mode 100644 index 0000000..781c2fd --- /dev/null +++ b/0101/javadoc/org/apache/kafka/common/serialization/package-tree.html @@ -0,0 +1,165 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Oct 04 12:37:09 PDT 2016 --> +<title>org.apache.kafka.common.serialization Class Hierarchy (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.kafka.common.serialization Class Hierarchy (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</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/common/errors/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/serialization/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.common.serialization</h1> +<span class="strong">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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang"><span class="strong">Object</span></a> +<ul> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/ByteArrayDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">ByteArrayDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/ByteArraySerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">ByteArraySerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/ByteBufferDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">ByteBufferDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/ByteBufferSerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">ByteBufferSerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/BytesDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">BytesDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/BytesSerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">BytesSerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/DoubleDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">DoubleDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/DoubleSerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">DoubleSerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/IntegerDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">IntegerDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/IntegerSerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">IntegerSerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/LongDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">LongDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/LongSerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">LongSerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.WrapperSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.WrapperSerde</span></a><T> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><T>) +<ul> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.ByteArraySerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.ByteArraySerde</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.ByteBufferSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.ByteBufferSerde</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.BytesSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.BytesSerde</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.DoubleSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.DoubleSerde</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.IntegerSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.IntegerSerde</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.LongSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.LongSerde</span></a></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serdes.StringSerde.html" title="class in org.apache.kafka.common.serialization"><span class="strong">Serdes.StringSerde</span></a></li> +</ul> +</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/StringDeserializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">StringDeserializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization">Deserializer</a><T>)</li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/StringSerializer.html" title="class in org.apache.kafka.common.serialization"><span class="strong">StringSerializer</span></a> (implements org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization">Serializer</a><T>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang"><span class="strong">AutoCloseable</span></a> +<ul> +<li type="circle">java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io"><span class="strong">Closeable</span></a> +<ul> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Deserializer.html" title="interface in org.apache.kafka.common.serialization"><span class="strong">Deserializer</span></a><T></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><span class="strong">Serde</span></a><T></li> +<li type="circle">org.apache.kafka.common.serialization.<a href="../../../../../org/apache/kafka/common/serialization/Serializer.html" title="interface in org.apache.kafka.common.serialization"><span class="strong">Serializer</span></a><T></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</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/common/errors/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/serialization/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/2d621da3/0101/javadoc/org/apache/kafka/connect/connector/ConnectRecord.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/connect/connector/ConnectRecord.html b/0101/javadoc/org/apache/kafka/connect/connector/ConnectRecord.html new file mode 100644 index 0000000..b2059cf --- /dev/null +++ b/0101/javadoc/org/apache/kafka/connect/connector/ConnectRecord.html @@ -0,0 +1,406 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Oct 04 12:37:08 PDT 2016 --> +<title>ConnectRecord (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConnectRecord (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/connector/ConnectRecord.html" target="_top">Frames</a></li> +<li><a href="ConnectRecord.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.connect.connector</div> +<h2 title="Class ConnectRecord" class="title">Class ConnectRecord</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.connect.connector.ConnectRecord</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink">SinkRecord</a>, <a href="../../../../../org/apache/kafka/connect/source/SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public abstract class <span class="strong">ConnectRecord</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block"><p> + Base class for records containing data to be copied to/from Kafka. This corresponds closely to + Kafka's ProducerRecord and ConsumerRecord classes, and holds the data that may be used by both + sources and sinks (topic, kafkaPartition, key, value). Although both implementations include a + notion of offset, it is not included here because they differ in type. + </p></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="overviewSummary" 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><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#ConnectRecord(java.lang.String,%20java.lang.Integer,%20org.apache.kafka.connect.data.Schema,%20java.lang.Object,%20org.apache.kafka.connect.data.Schema,%20java.lang.Object,%20java.lang.Long)">ConnectRecord</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> kafkaPartition, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a> timestamp)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#kafkaPartition()">kafkaPartition</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#key()">key</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#keySchema()">keySchema</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#timestamp()">timestamp</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#topic()">topic</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#value()">value</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#valueSchema()">valueSchema</a></strong>()</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-ex ternal=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConnectRecord(java.lang.String, java.lang.Integer, org.apache.kafka.connect.data.Schema, java.lang.Object, org.apache.kafka.connect.data.Schema, java.lang.Object, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConnectRecord</h4> +<pre>public ConnectRecord(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> kafkaPartition, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a> timestamp)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="topic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>topic</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic()</pre> +</li> +</ul> +<a name="kafkaPartition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>kafkaPartition</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> kafkaPartition()</pre> +</li> +</ul> +<a name="key()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>key</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key()</pre> +</li> +</ul> +<a name="keySchema()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySchema</h4> +<pre>public <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema()</pre> +</li> +</ul> +<a name="value()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>value</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value()</pre> +</li> +</ul> +<a name="valueSchema()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueSchema</h4> +<pre>public <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema()</pre> +</li> +</ul> +<a name="timestamp()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timestamp</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a> timestamp()</pre> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></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/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/connector/ConnectRecord.html" target="_top">Frames</a></li> +<li><a href="ConnectRecord.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/2d621da3/0101/javadoc/org/apache/kafka/connect/connector/Connector.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/connect/connector/Connector.html b/0101/javadoc/org/apache/kafka/connect/connector/Connector.html new file mode 100644 index 0000000..44f8ad5 --- /dev/null +++ b/0101/javadoc/org/apache/kafka/connect/connector/Connector.html @@ -0,0 +1,490 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Oct 04 12:37:08 PDT 2016 --> +<title>Connector (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Connector (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/connector/Connector.html" target="_top">Frames</a></li> +<li><a href="Connector.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><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.connect.connector</div> +<h2 title="Class Connector" class="title">Class Connector</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.connect.connector.Connector</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/kafka/connect/sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink">SinkConnector</a>, <a href="../../../../../org/apache/kafka/connect/source/SourceConnector.html" title="class in org.apache.kafka.connect.source">SourceConnector</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public abstract class <span class="strong">Connector</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block"><p> + Connectors manage integration of Kafka Connect with another system, either as an input that ingests + data into Kafka or an output that passes data to an external system. Implementations should + not use this class directly; they should inherit from SourceConnector or SinkConnector. + </p> + <p> + Connectors have two primary tasks. First, given some configuration, they are responsible for + creating configurations for a set of <a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector"><code>Task</code></a>s that split up the data processing. For + example, a database Connector might create Tasks by dividing the set of tables evenly among + tasks. Second, they are responsible for monitoring inputs for changes that require + reconfiguration and notifying the Kafka Connect runtime via the ConnectorContext. Continuing the + previous example, the connector might periodically check for new tables and notify Kafka Connect of + additions and deletions. Kafka Connect will then request new configurations and update the running + Tasks. + </p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#context">context</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#Connector()">Connector</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#config()">config</a></strong>()</code> +<div class="block">Define the configuration for the connector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext)">initialize</a></strong>(<a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx)</code> +<div class="block">Initialize this connector, using the provided ConnectorContext to notify the runtime of + input configuration changes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext,%20java.util.List)">initialize</a></strong>(<a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> taskConfigs)</code> +<div class="block"> + Initialize this connector, using the provided ConnectorContext to notify the runtime of + input configuration changes and using the provided set of Task configurations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#reconfigure(java.util.Map)">reconfigure</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> props)</code> +<div class="block">Reconfigure this Connector.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#start(java.util.Map)">start</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> props)</code> +<div class="block">Start this Connector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#stop()">stop</a></strong>()</code> +<div class="block">Stop this connector.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#taskClass()">taskClass</a></strong>()</code> +<div class="block">Returns the Task implementation for this Connector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#taskConfigs(int)">taskConfigs</a></strong>(int maxTasks)</code> +<div class="block">Returns a set of configurations for Tasks based on the current configuration, + producing at most count configurations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/config/Config.html" title="class in org.apache.kafka.common.config">Config</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#validate(java.util.Map)">validate</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> connectorConfigs)</code> +<div class="block">Validate the connector configuration values against configuration definitions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#version()">version</a></strong>()</code> +<div class="block">Get the version of this connector.</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="context"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>context</h4> +<pre>protected <a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> context</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Connector()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Connector</h4> +<pre>public Connector()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="version()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>version</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> version()</pre> +<div class="block">Get the version of this connector.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the version, formatted as a String</dd></dl> +</li> +</ul> +<a name="initialize(org.apache.kafka.connect.connector.ConnectorContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public void initialize(<a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx)</pre> +<div class="block">Initialize this connector, using the provided ConnectorContext to notify the runtime of + input configuration changes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctx</code> - context object used to interact with the Kafka Connect runtime</dd></dl> +</li> +</ul> +<a name="initialize(org.apache.kafka.connect.connector.ConnectorContext, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public void initialize(<a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> taskConfigs)</pre> +<div class="block"><p> + Initialize this connector, using the provided ConnectorContext to notify the runtime of + input configuration changes and using the provided set of Task configurations. + This version is only used to recover from failures. + </p> + <p> + The default implementation ignores the provided Task configurations. During recovery, Kafka Connect will request + an updated set of configurations and update the running Tasks appropriately. However, Connectors should + implement special handling of this case if it will avoid unnecessary changes to running Tasks. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctx</code> - context object used to interact with the Kafka Connect runtime</dd><dd><code>taskConfigs</code> - existing task configurations, which may be used when generating new task configs to avoid + churn in partition to task assignments</dd></dl> +</li> +</ul> +<a name="start(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public abstract void start(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> props)</pre> +<div class="block">Start this Connector. This method will only be called on a clean Connector, i.e. it has + either just been instantiated and initialized or <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#stop()"><code>stop()</code></a> has been invoked.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - configuration settings</dd></dl> +</li> +</ul> +<a name="reconfigure(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reconfigure</h4> +<pre>public void reconfigure(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> props)</pre> +<div class="block">Reconfigure this Connector. Most implementations will not override this, using the default + implementation that calls <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#stop()"><code>stop()</code></a> followed by <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#start(java.util.Map)"><code>start(Map)</code></a>. + Implementations only need to override this if they want to handle this process more + efficiently, e.g. without shutting down network connections to the external system.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - new configuration settings</dd></dl> +</li> +</ul> +<a name="taskClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>taskClass</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a>> taskClass()</pre> +<div class="block">Returns the Task implementation for this Connector.</div> +</li> +</ul> +<a name="taskConfigs(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>taskConfigs</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> taskConfigs(int maxTasks)</pre> +<div class="block">Returns a set of configurations for Tasks based on the current configuration, + producing at most count configurations.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxTasks</code> - maximum number of configurations to generate</dd> +<dt><span class="strong">Returns:</span></dt><dd>configurations for Tasks</dd></dl> +</li> +</ul> +<a name="stop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>public abstract void stop()</pre> +<div class="block">Stop this connector.</div> +</li> +</ul> +<a name="validate(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validate</h4> +<pre>public <a href="../../../../../org/apache/kafka/common/config/Config.html" title="class in org.apache.kafka.common.config">Config</a> validate(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> connectorConfigs)</pre> +<div class="block">Validate the connector configuration values against configuration definitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>connectorConfigs</code> - the provided configuration values</dd> +<dt><span class="strong">Returns:</span></dt><dd>List of Config, each Config contains the updated configuration information given + the current configuration values.</dd></dl> +</li> +</ul> +<a name="config()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>config</h4> +<pre>public abstract <a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> config()</pre> +<div class="block">Define the configuration for the connector.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The ConfigDef for this connector.</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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/connector/Connector.html" target="_top">Frames</a></li> +<li><a href="Connector.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><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/2d621da3/0101/javadoc/org/apache/kafka/connect/connector/ConnectorContext.html ---------------------------------------------------------------------- diff --git a/0101/javadoc/org/apache/kafka/connect/connector/ConnectorContext.html b/0101/javadoc/org/apache/kafka/connect/connector/ConnectorContext.html new file mode 100644 index 0000000..4782f58 --- /dev/null +++ b/0101/javadoc/org/apache/kafka/connect/connector/ConnectorContext.html @@ -0,0 +1,229 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Oct 04 12:37:08 PDT 2016 --> +<title>ConnectorContext (kafka 0.10.1.0 API)</title> +<meta name="date" content="2016-10-04"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConnectorContext (kafka 0.10.1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/connect/connector/Connector.html" title="class in org.apache.kafka.connect.connector"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/connector/ConnectorContext.html" target="_top">Frames</a></li> +<li><a href="ConnectorContext.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.connect.connector</div> +<h2 title="Interface ConnectorContext" class="title">Interface ConnectorContext</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public interface <span class="strong">ConnectorContext</span></pre> +<div class="block">ConnectorContext allows Connectors to proactively interact with the Kafka Connect runtime.</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/connect/connector/ConnectorContext.html#raiseError(java.lang.Exception)">raiseError</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> e)</code> +<div class="block">Raise an unrecoverable exception to the Connect framework.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/connector/ConnectorContext.html#requestTaskReconfiguration()">requestTaskReconfiguration</a></strong>()</code> +<div class="block">Requests that the runtime reconfigure the Tasks for this source.</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="requestTaskReconfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requestTaskReconfiguration</h4> +<pre>void requestTaskReconfiguration()</pre> +<div class="block">Requests that the runtime reconfigure the Tasks for this source. This should be used to + indicate to the runtime that something about the input/output has changed (e.g. partitions + added/removed) and the running Tasks will need to be modified.</div> +</li> +</ul> +<a name="raiseError(java.lang.Exception)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>raiseError</h4> +<pre>void raiseError(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> e)</pre> +<div class="block">Raise an unrecoverable exception to the Connect framework. This will cause the status of the + connector to transition to FAILED.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - Exception to be raised.</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/connect/connector/Connector.html" title="class in org.apache.kafka.connect.connector"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/connector/ConnectorContext.html" target="_top">Frames</a></li> +<li><a href="ConnectorContext.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>
