blob: 0f1791c84373dbb6d7d6138b3add7ad6a26d2843 [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:15:48 PDT 2017 -->
<title>ConfigStoreFactory (gobblin-config-core 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="ConfigStoreFactory (gobblin-config-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/config/store/api/ConfigStoreCreationException.html" title="class in gobblin.config.store.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/config/store/api/ConfigStoreWithBatchFetches.html" title="interface in gobblin.config.store.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/config/store/api/ConfigStoreFactory.html" target="_top">Frames</a></li>
<li><a href="ConfigStoreFactory.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.config.store.api</div>
<h2 title="Interface ConfigStoreFactory" class="title">Interface ConfigStoreFactory&lt;T extends <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a>&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>T</code> - The java class of the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> implementation(s) supported by this factory</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../gobblin/config/store/hdfs/DefaultCapableLocalConfigStoreFactory.html" title="class in gobblin.config.store.hdfs">DefaultCapableLocalConfigStoreFactory</a>, <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStoreFactory.html" title="class in gobblin.config.store.hdfs">SimpleHadoopFilesystemConfigStoreFactory</a>, <a href="../../../../gobblin/config/store/hdfs/SimpleHDFSConfigStoreFactory.html" title="class in gobblin.config.store.hdfs">SimpleHDFSConfigStoreFactory</a>, <a href="../../../../gobblin/config/store/hdfs/SimpleLocalHDFSConfigStoreFactory.html" title="class in gobblin.config.store.hdfs">SimpleLocalHDFSConfigStoreFactory</a></dd>
</dl>
<hr>
<br>
<pre><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/annotation/Alpha.html?is-external=true" title="class or interface in gobblin.annotation">@Alpha</a>
public interface <span class="typeNameLabel">ConfigStoreFactory&lt;T extends <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a>&gt;</span></pre>
<div class="block">ConfigStoreFactory is used to created <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>s. Each ConfigStoreFactory is responsible for
instantiating <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>s that can handle specific config key URI scheme. Typically those
<a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>s correspond to different physical instances and are differentiated by the
authority in the URI. The ConfigStoreFactory will typically also define a default
<a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> which is to be used if no authority is specified in the config key URI.</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/config/store/api/ConfigStoreFactory.html" title="type parameter in ConfigStoreFactory">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigStoreFactory.html#createConfigStore-java.net.URI-">createConfigStore</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;configKey)</code>
<div class="block">Obtains the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> to handle a specific config key.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigStoreFactory.html#getScheme--">getScheme</a></span>()</code>&nbsp;</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="getScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheme</h4>
<pre><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;getScheme()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI scheme for which this configuration store factory is responsible.
All the configuration store created by this configuration factory will share the same scheme
name.</dd>
</dl>
</li>
</ul>
<a name="createConfigStore-java.net.URI-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createConfigStore</h4>
<pre><a href="../../../../gobblin/config/store/api/ConfigStoreFactory.html" title="type parameter in ConfigStoreFactory">T</a>&nbsp;createConfigStore(<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;configKey)
throws <a href="../../../../gobblin/config/store/api/ConfigStoreCreationException.html" title="class in gobblin.config.store.api">ConfigStoreCreationException</a></pre>
<div class="block">Obtains the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> to handle a specific config key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - The URI of the config key that needs to be accessed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> which can handle the specified config key. If the config key URI is
missing the authority part, the factory may choose a default store if available or throw
a ConfigStoreCreationException</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStoreCreationException.html" title="class in gobblin.config.store.api">ConfigStoreCreationException</a></code> - if the URI cannot be mapped to a config store</dd>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the scheme of the config key URI does not match
the value of <a href="../../../../gobblin/config/store/api/ConfigStoreFactory.html#getScheme--"><code>getScheme()</code></a>.</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/config/store/api/ConfigStoreCreationException.html" title="class in gobblin.config.store.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/config/store/api/ConfigStoreWithBatchFetches.html" title="interface in gobblin.config.store.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/config/store/api/ConfigStoreFactory.html" target="_top">Frames</a></li>
<li><a href="ConfigStoreFactory.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>