blob: e29b7d98c40200af2a2fac221296720ce66cbffd [file] [log] [blame]
<!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_40) on Thu Jul 20 13:16:30 PDT 2017 -->
<title>KafkaSchemaRegistry (gobblin-kafka-common 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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="KafkaSchemaRegistry (gobblin-kafka-common 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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="../../../gobblin/kafka/schemareg/HttpClientFactory.html" title="class in gobblin.kafka.schemareg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistryConfigurationKeys.html" title="class in gobblin.kafka.schemareg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/kafka/schemareg/KafkaSchemaRegistry.html" target="_top">Frames</a></li>
<li><a href="KafkaSchemaRegistry.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">gobblin.kafka.schemareg</div>
<h2 title="Interface KafkaSchemaRegistry" class="title">Interface KafkaSchemaRegistry&lt;K,S&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - : the type of the schema identifier (e.g. int, string, md5, ...)</dd>
<dd><code>S</code> - : the type of the schema system in use (e.g. avro's Schema, ... )</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../gobblin/kafka/schemareg/CachingKafkaSchemaRegistry.html" title="class in gobblin.kafka.schemareg">CachingKafkaSchemaRegistry</a>, <a href="../../../gobblin/kafka/schemareg/ConfigDrivenMd5SchemaRegistry.html" title="class in gobblin.kafka.schemareg">ConfigDrivenMd5SchemaRegistry</a>, <a href="../../../gobblin/kafka/schemareg/LiKafkaSchemaRegistry.html" title="class in gobblin.kafka.schemareg">LiKafkaSchemaRegistry</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">KafkaSchemaRegistry&lt;K,S&gt;</span></pre>
<div class="block">An interface for a Kafka Schema Registry
Classes implementing this interface will typically be constructed by a <a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistryFactory.html" title="class in gobblin.kafka.schemareg"><code>KafkaSchemaRegistryFactory</code></a>
and should have a constructor that takes a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> object as a parameter.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">S</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html#getById-K-">getById</a></span>(<a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">K</a>&nbsp;id)</code>
<div class="block">Get a schema given an id</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">S</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html#getLatestSchema-java.lang.String-">getLatestSchema</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Get the latest schema that was registered under this name</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html#hasInternalCache--">hasInternalCache</a></span>()</code>
<div class="block">SchemaRegistry implementations that do not have an internal cache can set this to false
and Gobblin will supplement such registries with a cache on top (if enabled).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">K</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html#register-java.lang.String-S-">register</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">S</a>&nbsp;schema)</code>
<div class="block">Register this schema under the provided name</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="register-java.lang.String-java.lang.Object-">
<!-- -->
</a><a name="register-java.lang.String-S-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">K</a>&nbsp;register(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">S</a>&nbsp;schema)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../gobblin/kafka/schemareg/SchemaRegistryException.html" title="class in gobblin.kafka.schemareg">SchemaRegistryException</a></pre>
<div class="block">Register this schema under the provided name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - </dd>
<dd><code>schema</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the schema identifier</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="../../../gobblin/kafka/schemareg/SchemaRegistryException.html" title="class in gobblin.kafka.schemareg">SchemaRegistryException</a></code></dd>
</dl>
</li>
</ul>
<a name="getById-java.lang.Object-">
<!-- -->
</a><a name="getById-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getById</h4>
<pre><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">S</a>&nbsp;getById(<a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">K</a>&nbsp;id)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../gobblin/kafka/schemareg/SchemaRegistryException.html" title="class in gobblin.kafka.schemareg">SchemaRegistryException</a></pre>
<div class="block">Get a schema given an id</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="../../../gobblin/kafka/schemareg/SchemaRegistryException.html" title="class in gobblin.kafka.schemareg">SchemaRegistryException</a></code></dd>
</dl>
</li>
</ul>
<a name="getLatestSchema-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLatestSchema</h4>
<pre><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistry.html" title="type parameter in KafkaSchemaRegistry">S</a>&nbsp;getLatestSchema(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../gobblin/kafka/schemareg/SchemaRegistryException.html" title="class in gobblin.kafka.schemareg">SchemaRegistryException</a></pre>
<div class="block">Get the latest schema that was registered under this name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the latest Schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../gobblin/kafka/schemareg/SchemaRegistryException.html" title="class in gobblin.kafka.schemareg">SchemaRegistryException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="hasInternalCache--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hasInternalCache</h4>
<pre>boolean&nbsp;hasInternalCache()</pre>
<div class="block">SchemaRegistry implementations that do not have an internal cache can set this to false
and Gobblin will supplement such registries with a cache on top (if enabled).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this implementation of the schema registry has an internal cache</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="../../../gobblin/kafka/schemareg/HttpClientFactory.html" title="class in gobblin.kafka.schemareg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/kafka/schemareg/KafkaSchemaRegistryConfigurationKeys.html" title="class in gobblin.kafka.schemareg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/kafka/schemareg/KafkaSchemaRegistry.html" target="_top">Frames</a></li>
<li><a href="KafkaSchemaRegistry.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>