| <!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_121) on Tue Apr 25 03:06:39 SST 2017 --> |
| <title>ClusterConfig</title> |
| <meta name="date" content="2017-04-25"> |
| <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="ClusterConfig"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/gearpump/cluster/ClientToMaster.SubmitApplication$.html" title="class in org.apache.gearpump.cluster"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.Configs.html" title="class in org.apache.gearpump.cluster"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/gearpump/cluster/ClusterConfig.html" target="_top">Frames</a></li> |
| <li><a href="ClusterConfig.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><a href="#nested.class.summary">Nested</a> | </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.gearpump.cluster</div> |
| <h2 title="Class ClusterConfig" class="title">Class ClusterConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.gearpump.cluster.ClusterConfig</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ClusterConfig</span> |
| extends java.lang.Object</pre> |
| <div class="block">All Gearpump application should use this class to load configurations. |
| <p> |
| Compared with Akka built-in com.typesafe.config.ConfigFactory, this class also |
| resolve config from file gear.conf and geardefault.conf. |
| <p> |
| Overriding order: |
| <pre><code> |
| System Properties |
| > Custom configuration file (by using system property -Dgearpump.config.file) > |
| > gear.conf |
| > geardefault.conf |
| > reference.conf |
| </code></pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.Configs.html" title="class in org.apache.gearpump.cluster">ClusterConfig.Configs</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.ConfigValidationException.html" title="class in org.apache.gearpump.cluster">ClusterConfig.ConfigValidationException</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#ClusterConfig--">ClusterConfig</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#APPLICATION--">APPLICATION</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static com.typesafe.config.Config</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#defaultConfig--">defaultConfig</a></span>()</code> |
| <div class="block">alias for default |
| default is a reserved word for java</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static com.typesafe.config.Config</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#filterOutDefaultConfig-com.typesafe.config.Config-">filterOutDefaultConfig</a></span>(com.typesafe.config.Config input)</code> |
| <div class="block">filter JVM reserved keys and akka default reference.conf</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static scala.collection.immutable.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#JVM_RESERVED_PROPERTIES--">JVM_RESERVED_PROPERTIES</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/gearpump/cluster/ClusterConfig.Configs.html" title="class in org.apache.gearpump.cluster">ClusterConfig.Configs</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#load-org.apache.gearpump.cluster.ClusterConfigSource-">load</a></span>(<a href="../../../../org/apache/gearpump/cluster/ClusterConfigSource.html" title="interface in org.apache.gearpump.cluster">ClusterConfigSource</a> source)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#LOG--">LOG</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static com.typesafe.config.Config</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#master-java.lang.String-">master</a></span>(java.lang.String configFile)</code> |
| <div class="block">configuration for master node</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#render-com.typesafe.config.Config-boolean-">render</a></span>(com.typesafe.config.Config config, |
| boolean concise)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#saveConfig-com.typesafe.config.Config-java.io.File-">saveConfig</a></span>(com.typesafe.config.Config conf, |
| java.io.File file)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static com.typesafe.config.Config</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#ui-java.lang.String-">ui</a></span>(java.lang.String configFile)</code> |
| <div class="block">configuration for UI server</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static com.typesafe.config.Config</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.html#worker-java.lang.String-">worker</a></span>(java.lang.String configFile)</code> |
| <div class="block">configuration for worker node</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ClusterConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ClusterConfig</h4> |
| <pre>public ClusterConfig()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="defaultConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultConfig</h4> |
| <pre>public static com.typesafe.config.Config defaultConfig()</pre> |
| <div class="block">alias for default |
| default is a reserved word for java</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="master-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>master</h4> |
| <pre>public static com.typesafe.config.Config master(java.lang.String configFile)</pre> |
| <div class="block">configuration for master node</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configFile</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="worker-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>worker</h4> |
| <pre>public static com.typesafe.config.Config worker(java.lang.String configFile)</pre> |
| <div class="block">configuration for worker node</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configFile</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ui-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ui</h4> |
| <pre>public static com.typesafe.config.Config ui(java.lang.String configFile)</pre> |
| <div class="block">configuration for UI server</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configFile</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="APPLICATION--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>APPLICATION</h4> |
| <pre>public static java.lang.String APPLICATION()</pre> |
| </li> |
| </ul> |
| <a name="LOG--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>public static org.slf4j.Logger LOG()</pre> |
| </li> |
| </ul> |
| <a name="saveConfig-com.typesafe.config.Config-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>saveConfig</h4> |
| <pre>public static void saveConfig(com.typesafe.config.Config conf, |
| java.io.File file)</pre> |
| </li> |
| </ul> |
| <a name="render-com.typesafe.config.Config-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>render</h4> |
| <pre>public static java.lang.String render(com.typesafe.config.Config config, |
| boolean concise)</pre> |
| </li> |
| </ul> |
| <a name="filterOutDefaultConfig-com.typesafe.config.Config-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterOutDefaultConfig</h4> |
| <pre>public static com.typesafe.config.Config filterOutDefaultConfig(com.typesafe.config.Config input)</pre> |
| <div class="block">filter JVM reserved keys and akka default reference.conf</div> |
| </li> |
| </ul> |
| <a name="load-org.apache.gearpump.cluster.ClusterConfigSource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public static <a href="../../../../org/apache/gearpump/cluster/ClusterConfig.Configs.html" title="class in org.apache.gearpump.cluster">ClusterConfig.Configs</a> load(<a href="../../../../org/apache/gearpump/cluster/ClusterConfigSource.html" title="interface in org.apache.gearpump.cluster">ClusterConfigSource</a> source)</pre> |
| </li> |
| </ul> |
| <a name="JVM_RESERVED_PROPERTIES--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JVM_RESERVED_PROPERTIES</h4> |
| <pre>public static scala.collection.immutable.List<java.lang.String> JVM_RESERVED_PROPERTIES()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/gearpump/cluster/ClientToMaster.SubmitApplication$.html" title="class in org.apache.gearpump.cluster"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/gearpump/cluster/ClusterConfig.Configs.html" title="class in org.apache.gearpump.cluster"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/gearpump/cluster/ClusterConfig.html" target="_top">Frames</a></li> |
| <li><a href="ClusterConfig.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><a href="#nested.class.summary">Nested</a> | </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> |
