blob: 2803fc3bc42d3edb5616f4ec86b6300a5d8344e7 [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>SimpleHadoopFilesystemConfigStore (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="SimpleHadoopFilesystemConfigStore (gobblin-config-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../gobblin/config/store/hdfs/DefaultCapableLocalConfigStoreFactory.html" title="class in gobblin.config.store.hdfs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStoreFactory.html" title="class in gobblin.config.store.hdfs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html" target="_top">Frames</a></li>
<li><a href="SimpleHadoopFilesystemConfigStore.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.hdfs</div>
<h2 title="Class SimpleHadoopFilesystemConfigStore" class="title">Class SimpleHadoopFilesystemConfigStore</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://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>gobblin.config.store.hdfs.SimpleHadoopFilesystemConfigStore</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a>, <a href="../../../../gobblin/config/store/deploy/Deployable.html" title="interface in gobblin.config.store.deploy">Deployable</a>&lt;<a href="../../../../gobblin/config/store/deploy/FsDeploymentConfig.html" title="class in gobblin.config.store.deploy">FsDeploymentConfig</a>&gt;</dd>
</dl>
<hr>
<br>
<pre><a href="../../../../gobblin/config/store/api/ConfigStoreWithStableVersioning.html" title="annotation in gobblin.config.store.api">@ConfigStoreWithStableVersioning</a>
public class <span class="typeNameLabel">SimpleHadoopFilesystemConfigStore</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a>, <a href="../../../../gobblin/config/store/deploy/Deployable.html" title="interface in gobblin.config.store.deploy">Deployable</a>&lt;<a href="../../../../gobblin/config/store/deploy/FsDeploymentConfig.html" title="class in gobblin.config.store.deploy">FsDeploymentConfig</a>&gt;</pre>
<div class="block">An implementation of <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> backed by HDFS. The class assumes a simple file and directory layout
structure where each path under the root store directory corresponds to a dataset. The <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getStoreURI--"><code>getStoreURI()</code></a> method
gives an <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> that identifies the HDFS cluster being used, as well as the root directory of the store. When
querying this store, the scheme should be of the form <code>simple-[hdfs-scheme]</code> (a.k.a the logical scheme). For
example, if the store is located on a the local filesystem the scheme should be <code>simple-file</code>, if the store
is located on HDFS, the scheme should be <code>simple-hdfs</code>. This class can be constructed using a
<a href="../../../../gobblin/config/store/hdfs/SimpleHDFSConfigStoreFactory.html" title="class in gobblin.config.store.hdfs"><code>SimpleHDFSConfigStoreFactory</code></a>.
<p>
The class assumes a directory called <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#CONFIG_STORE_NAME"><code>CONFIG_STORE_NAME</code></a> is under the root directory. This folder should
contain a directory for each version deployed to the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>. An example directory structure could look
like: <br>
<blockquote>
<code>
/root<br>
&emsp;/my-simple-store<br>
&emsp;&emsp;/_CONFIG_STORE<br>
&emsp;&emsp;&emsp;/v1.0<br>
&emsp;&emsp;&emsp;&emsp;/dataset1<br>
&emsp;&emsp;&emsp;&emsp;&emsp;/child-dataset<br>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;/main.conf<br>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;/includes.conf<br>
&emsp;&emsp;&emsp;&emsp;/dataset2<br>
&emsp;&emsp;&emsp;&emsp;&emsp;/main.conf<br>
&emsp;&emsp;&emsp;&emsp;&emsp;/child-dataset<br>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;/main.conf<br>
</code>
</blockquote>
</p>
<p>
In the above example, the root of the store is <code>/root/my-simple-store/</code>. The code automatically assumes that
this folder contains a directory named <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#CONFIG_STORE_NAME"><code>CONFIG_STORE_NAME</code></a>. In order to access the dataset
<code>dataset1/child-dataset</code> using ConfigClient#getConfig(URI), the specified <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> should be
<code>simple-hdfs://[authority]:[port]/root/my-simple-store/dataset1/child-dataset/</code>. Note this is the fully
qualified path to the actual <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#MAIN_CONF_FILE_NAME"><code>MAIN_CONF_FILE_NAME</code></a> file on HDFS, with the <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#CONFIG_STORE_NAME"><code>CONFIG_STORE_NAME</code></a> and the
<code>version</code> directories removed.
</p>
<p>
All the <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a>s for a dataset should be put in the associated <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#MAIN_CONF_FILE_NAME"><code>MAIN_CONF_FILE_NAME</code></a> file, and all
the imports should be put in the associated <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#INCLUDES_CONF_FILE_NAME"><code>INCLUDES_CONF_FILE_NAME</code></a> file.
</p>
<p>
This class is not responsible for deploying configurations from an external source to HDFS, only for reading them.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../gobblin/config/store/hdfs/SimpleHDFSConfigStoreFactory.html" title="class in gobblin.config.store.hdfs"><code>SimpleHDFSConfigStoreFactory</code></a></dd>
</dl>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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 static <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/hdfs/SimpleHadoopFilesystemConfigStore.html#CONFIG_STORE_NAME">CONFIG_STORE_NAME</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#SimpleHadoopFilesystemConfigStore-org.apache.hadoop.fs.FileSystem-java.net.URI-java.net.URI-">SimpleHadoopFilesystemConfigStore</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<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;physicalStoreRoot,
<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;logicalStoreRoot)</code>
<div class="block">Constructs a <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html" title="class in gobblin.config.store.hdfs"><code>SimpleHadoopFilesystemConfigStore</code></a> using a given <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a> and a <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> that points to the
physical location of the store root.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#deploy-gobblin.config.store.deploy.FsDeploymentConfig-">deploy</a></span>(<a href="../../../../gobblin/config/store/deploy/FsDeploymentConfig.html" title="class in gobblin.config.store.deploy">FsDeploymentConfig</a>&nbsp;deploymentConfig)</code>
<div class="block">Deploy configs provided by <code>FsDeploymentConfig#getDeployableConfigSource()</code> to HDFS.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getChildren-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getChildren</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version)</code>
<div class="block">Retrieves all the children of the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> by doing a <code>ls</code> on the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> specified
by the <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/hdfs/SimpleHadoopFilesystemConfigStore.html#getCurrentVersion--">getCurrentVersion</a></span>()</code>
<div class="block">Returns a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> representation of the active version stored in the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getOwnConfig-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getOwnConfig</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version)</code>
<div class="block">Retrieves the <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> for the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> by reading the <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#MAIN_CONF_FILE_NAME"><code>MAIN_CONF_FILE_NAME</code></a>
associated with the dataset specified by the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getOwnImports</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version)</code>
<div class="block">Obtains the list of all config keys with which are given config key is tagged/annotated.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-com.google.common.base.Optional-">getOwnImports</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version,
<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&gt;&nbsp;runtimeConfig)</code>
<div class="block">Retrieves all the <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>s that are imported by the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>(package private) <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getPhysicalStoreRoot--">getPhysicalStoreRoot</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#getStoreURI--">getStoreURI</a></span>()</code>
<div class="block">Returns a <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> representing the logical store <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> where the <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true#getPath--" title="class or interface in java.net"><code>URI.getPath()</code></a> is the path to
the root of the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#resolveIncludesList-java.util.List-">resolveIncludesList</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;includes)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#resolveIncludesList-java.util.List-com.google.common.base.Optional-">resolveIncludesList</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;includes,
<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&gt;&nbsp;runtimeConfig)</code>
<div class="block">A helper to resolve System properties and Environment variables in includes paths
The method loads the list of unresolved <code>includes</code> into an in-memory <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> object and reolves
with a fallback on <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/ConfigFactory.html?is-external=true#defaultOverrides--" title="class or interface in com.typesafe.config"><code>ConfigFactory.defaultOverrides()</code></a></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&nbsp;java.lang.<a href="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="CONFIG_STORE_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CONFIG_STORE_NAME</h4>
<pre>protected static final&nbsp;<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> CONFIG_STORE_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#gobblin.config.store.hdfs.SimpleHadoopFilesystemConfigStore.CONFIG_STORE_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SimpleHadoopFilesystemConfigStore-org.apache.hadoop.fs.FileSystem-java.net.URI-java.net.URI-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleHadoopFilesystemConfigStore</h4>
<pre>protected&nbsp;SimpleHadoopFilesystemConfigStore(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<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;physicalStoreRoot,
<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;logicalStoreRoot)</pre>
<div class="block">Constructs a <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html" title="class in gobblin.config.store.hdfs"><code>SimpleHadoopFilesystemConfigStore</code></a> using a given <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a> and a <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> that points to the
physical location of the store root.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fs</code> - the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a> the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> is stored on.</dd>
<dd><code>physicalStoreRoot</code> - the fully qualified <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> of the physical store root, the <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true#getScheme--" title="class or interface in java.net"><code>URI.getScheme()</code></a> of the
<a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> should match the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true#getScheme--" title="class or interface in org.apache.hadoop.fs"><code>FileSystem.getScheme()</code></a> of the given <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a>.</dd>
<dd><code>logicalStoreRoot</code> - the fully qualfied <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> of the logical store root</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCurrentVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentVersion</h4>
<pre>public&nbsp;<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;getCurrentVersion()</pre>
<div class="block">Returns a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> representation of the active version stored in the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>. This method
determines the current active version by reading the <code>#CONFIG_STORE_METADATA_FILENAME</code> in
<a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#CONFIG_STORE_NAME"><code>CONFIG_STORE_NAME</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getCurrentVersion--">getCurrentVersion</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> representing the current active version of the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getStoreURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStoreURI</h4>
<pre>public&nbsp;<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;getStoreURI()</pre>
<div class="block">Returns a <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> representing the logical store <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> where the <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true#getPath--" title="class or interface in java.net"><code>URI.getPath()</code></a> is the path to
the root of the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getStoreURI--">getStoreURI</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> representing the logical store <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> (e.g. simple-hdfs://[authority]:[port][path-to-root]).</dd>
</dl>
</li>
</ul>
<a name="getChildren-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;&nbsp;getChildren(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version)
throws <a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></pre>
<div class="block">Retrieves all the children of the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> by doing a <code>ls</code> on the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> specified
by the <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>. If the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> described by the <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> does not exist, an empty
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> is returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getChildren-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getChildren</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - the config key path whose children are necessary.</dd>
<dd><code>version</code> - specify the configuration version in the configuration store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> of <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> where each entry is a child of the given configKey.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></code> - if the version specified cannot be found in the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnImports</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;&nbsp;getOwnImports(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">ConfigStore</a></code></span></div>
<div class="block">Obtains the list of all config keys with which are given config key is tagged/annotated.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getOwnImports</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - the config key path whose tags are needed</dd>
<dd><code>version</code> - the configuration version in the configuration store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paths of the directly imported config keys for the specified config key and
version. Note that order is significant the earlier ConfigKeyPath in the List will have higher priority
when resolving configuration conflicts.</dd>
</dl>
</li>
</ul>
<a name="getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-com.google.common.base.Optional-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnImports</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;&nbsp;getOwnImports(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version,
<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&gt;&nbsp;runtimeConfig)
throws <a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></pre>
<div class="block">Retrieves all the <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>s that are imported by the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>. This method does this
by reading the <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#INCLUDES_CONF_FILE_NAME"><code>INCLUDES_CONF_FILE_NAME</code></a> file associated with the dataset specified by the given
<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>. If the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> described by the <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> does not exist, then an empty
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> is returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-com.google.common.base.Optional-">getOwnImports</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - the config key path whose tags are needed</dd>
<dd><code>version</code> - the configuration version in the configuration store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>s where each entry is a <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> imported by the dataset
specified by the configKey.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></code> - if the version specified cannot be found in the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</dd>
</dl>
</li>
</ul>
<a name="resolveIncludesList-java.util.List-com.google.common.base.Optional-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveIncludesList</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;resolveIncludesList(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;includes,
<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&gt;&nbsp;runtimeConfig)</pre>
<div class="block">A helper to resolve System properties and Environment variables in includes paths
The method loads the list of unresolved <code>includes</code> into an in-memory <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> object and reolves
with a fallback on <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/ConfigFactory.html?is-external=true#defaultOverrides--" title="class or interface in com.typesafe.config"><code>ConfigFactory.defaultOverrides()</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>includes</code> - list of unresolved includes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of resolved includes</dd>
</dl>
</li>
</ul>
<a name="resolveIncludesList-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveIncludesList</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;resolveIncludesList(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;includes)</pre>
</li>
</ul>
<a name="getOwnConfig-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnConfig</h4>
<pre>public&nbsp;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;getOwnConfig(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<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;version)
throws <a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></pre>
<div class="block">Retrieves the <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> for the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> by reading the <a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html#MAIN_CONF_FILE_NAME"><code>MAIN_CONF_FILE_NAME</code></a>
associated with the dataset specified by the given <a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a>. If the <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>Path</code></a> described by the
<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api"><code>ConfigKeyPath</code></a> does not exist then an empty <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> is returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnConfig-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getOwnConfig</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - the config key path whose properties are needed.</dd>
<dd><code>version</code> - the configuration version in the configuration store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> for the given configKey.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></code> - if the version specified cannot be found in the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a>.</dd>
</dl>
</li>
</ul>
<a name="deploy-gobblin.config.store.deploy.FsDeploymentConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deploy</h4>
<pre>public&nbsp;void&nbsp;deploy(<a href="../../../../gobblin/config/store/deploy/FsDeploymentConfig.html" title="class in gobblin.config.store.deploy">FsDeploymentConfig</a>&nbsp;deploymentConfig)
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></pre>
<div class="block">Deploy configs provided by <code>FsDeploymentConfig#getDeployableConfigSource()</code> to HDFS.
For each <a href="../../../../gobblin/config/store/deploy/ConfigStream.html" title="class in gobblin.config.store.deploy"><code>ConfigStream</code></a> returned by <a href="../../../../gobblin/config/store/deploy/DeployableConfigSource.html#getConfigStreams--"><code>DeployableConfigSource.getConfigStreams()</code></a>, creates a resource on HDFS.
<br>
<ul> Does the following:
<li> Read <a href="../../../../gobblin/config/store/deploy/ConfigStream.html" title="class in gobblin.config.store.deploy"><code>ConfigStream</code></a>s and write them to HDFS
<li> Create parent directories of <code>ConfigStream#getConfigPath()</code> if required
<li> Set <code>FsDeploymentConfig#getStorePermissions()</code> to all resourced created on HDFS
<li> Update current active version in the store metadata file.
</ul>
<p>
For example: If "test-root" is a resource in classpath and all resources under it needs to be deployed,
<br>
<br>
<b>In Classpath:</b><br>
<blockquote> <code>
test-root<br>
&emsp;/data<br>
&emsp;&emsp;/set1<br>
&emsp;&emsp;&emsp;/main.conf<br>
&emsp;/tag<br>
&emsp;&emsp;/tag1<br>
&emsp;&emsp;&emsp;/main.conf<br>
</code> </blockquote>
</p>
<p>
A new version 2.0.0 <code>FsDeploymentConfig#getNewVersion()</code> is created on HDFS under <code>this.physicalStoreRoot/_CONFIG_STORE</code>
<br>
<br>
<b>On HDFS after deploy:</b><br>
<blockquote> <code>
/_CONFIG_STORE<br>
&emsp;/2.0.0<br>
&emsp;&emsp;/data<br>
&emsp;&emsp;&emsp;/set1<br>
&emsp;&emsp;&emsp;&emsp;/main.conf<br>
&emsp;&emsp;/tag<br>
&emsp;&emsp;&emsp;/tag1<br>
&emsp;&emsp;&emsp;&emsp;/main.conf<br>
</code> </blockquote>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/deploy/Deployable.html#deploy-D-">deploy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/config/store/deploy/Deployable.html" title="interface in gobblin.config.store.deploy">Deployable</a>&lt;<a href="../../../../gobblin/config/store/deploy/FsDeploymentConfig.html" title="class in gobblin.config.store.deploy">FsDeploymentConfig</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deploymentConfig</code> - to use for this deployment</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>
</dl>
</li>
</ul>
<a name="getPhysicalStoreRoot--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPhysicalStoreRoot</h4>
<pre><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;getPhysicalStoreRoot()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../gobblin/config/store/hdfs/DefaultCapableLocalConfigStoreFactory.html" title="class in gobblin.config.store.hdfs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStoreFactory.html" title="class in gobblin.config.store.hdfs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/config/store/hdfs/SimpleHadoopFilesystemConfigStore.html" target="_top">Frames</a></li>
<li><a href="SimpleHadoopFilesystemConfigStore.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>