Hugging Face's logo

dingyiz
/
AMLSim

Model card Files Community
AMLSim / jars /janusgraph-1.0.0 /javadocs /org /janusgraph /graphdb /management /ConfigurationManagementGraph.html
dingyiz's picture
dingyiz
Upload folder using huggingface_hub
2795186 verified
raw
history blame contribute delete
36.2 kB
 <!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_382) on Sat Oct 21 16:38:49 UTC 2023 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ConfigurationManagementGraph (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)</title>
<meta name="date" content="2023-10-21">
<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="ConfigurationManagementGraph (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":10,"i12":10};
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="class-use/ConfigurationManagementGraph.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/janusgraph/graphdb/management/JanusGraphManager.html" title="class in org.janusgraph.graphdb.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/janusgraph/graphdb/management/ConfigurationManagementGraph.html" target="_top">Frames</a></li>
<li><a href="ConfigurationManagementGraph.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">org.janusgraph.graphdb.management</div>
<h2 title="Class ConfigurationManagementGraph" class="title">Class ConfigurationManagementGraph</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.janusgraph.graphdb.management.ConfigurationManagementGraph</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ConfigurationManagementGraph</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class allows you to create/update/remove configuration objects used to open a graph.
To use these APIs, you must define one of your graph's key as "ConfigurationManagementGraph"
in your server's YAML; the configuration objects you define using these APIs will be stored
in a graph representation (on a vertex, more precisely), and this graph will be opened
according to the file supplied along with the "ConfigurationManagementGraph" key.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="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>static <a href="https://docs.oracle.com/javase/8/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="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#PROPERTY_CREATED_USING_TEMPLATE">PROPERTY_CREATED_USING_TEMPLATE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/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="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#PROPERTY_GRAPH_NAME">PROPERTY_GRAPH_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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#ConfigurationManagementGraph-org.janusgraph.graphdb.database.StandardJanusGraph-">ConfigurationManagementGraph</a></span>(<a href="../../../../org/janusgraph/graphdb/database/StandardJanusGraph.html" title="class in org.janusgraph.graphdb.database">StandardJanusGraph</a>&nbsp;graph)</code>
<div class="block">This class allows you to create/update/remove configuration objects used to open a graph.</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="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#createConfiguration-org.apache.commons.configuration2.Configuration-">createConfiguration</a></span>(org.apache.commons.configuration2.Configuration&nbsp;config)</code>
<div class="block">Create a configuration according to the supplied <code>Configuration</code>; you must include
the property "graph.graphname" with a value in the configuration; you can then
open your graph using graph.graphname without having to supply the
Configuration or File each time using the <a href="../../../../org/janusgraph/core/ConfiguredGraphFactory.html" title="class in org.janusgraph.core"><code>ConfiguredGraphFactory</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#createTemplateConfiguration-org.apache.commons.configuration2.Configuration-">createTemplateConfiguration</a></span>(org.apache.commons.configuration2.Configuration&nbsp;config)</code>
<div class="block">Create a template configuration according to the supplied <code>Configuration</code>; if
you already created a template configuration or the supplied <code>Configuration</code>
contains the property "graph.graphname", we throw a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a>; you can then use
this template configuration to create a graph using the
ConfiguredGraphFactory create signature and supplying a new graphName.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#getConfiguration-java.lang.String-">getConfiguration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configName)</code>
<div class="block">Get Configuration according to supplied graphName mapped to a specific
<code>Graph</code>; if does not exist, return null.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#getConfigurations--">getConfigurations</a></span>()</code>
<div class="block">Get a list of all Configurations, excluding the template configuration; if none exist,
return an empty list</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/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="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#getGraphNames--">getGraphNames</a></span>()</code>
<div class="block">Get a set of all graph names, excluding the template configuration; if none exist,
return an empty set</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html" title="class in org.janusgraph.graphdb.management">ConfigurationManagementGraph</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#getInstance--">getInstance</a></span>()</code>
<div class="block">If one of your "graphs" key was equivalent to "ConfigurationManagementGraph" in your
YAML file supplied at server start, then we return the ConfigurationManagementGraph
Singleton-- otherwise we throw a <a href="../../../../org/janusgraph/graphdb/management/utils/ConfigurationManagementGraphNotEnabledException.html" title="class in org.janusgraph.graphdb.management.utils"><code>ConfigurationManagementGraphNotEnabledException</code></a> exception.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#getTemplateConfiguration--">getTemplateConfiguration</a></span>()</code>
<div class="block">Get template configuration if exists, else return null.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#removeConfiguration-java.lang.String-">removeConfiguration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;graphName)</code>
<div class="block">Remove Configuration according to graphName</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#removeConfiguration-java.lang.String-java.util.Set-">removeConfiguration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;graphName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;configKeys)</code>
<div class="block">Remove configuration corresponding to supplied graphName; we remove supplied existing
properties.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#removeTemplateConfiguration--">removeTemplateConfiguration</a></span>()</code>
<div class="block">Remove template configuration</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#shutdownConfigurationManagementGraph--">shutdownConfigurationManagementGraph</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#updateConfiguration-java.lang.String-org.apache.commons.configuration2.Configuration-">updateConfiguration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;graphName,
org.apache.commons.configuration2.Configuration&nbsp;config)</code>
<div class="block">Update configuration corresponding to supplied graphName; we update supplied existing
properties and add new ones to the <code>Configuration</code>; The supplied <code>Configuration</code> must include a
property "graph.graphname" and it must match supplied graphName;
NOTE: The updated configuration is only guaranteed to take effect if the <code>Graph</code> corresponding to
graphName has been closed and reopened on every JanusGraph Node.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html#updateTemplateConfiguration-org.apache.commons.configuration2.Configuration-">updateTemplateConfiguration</a></span>(org.apache.commons.configuration2.Configuration&nbsp;config)</code>
<div class="block">Update template configuration by updating supplied existing properties and adding new ones to the
<code>Configuration</code>; your updated Configuration may not contain the property "graph.graphname";
NOTE: Any graph using a configuration that was created using the template configuration must--
1) be closed and reopened on every JanusGraph Node 2) have its corresponding Configuration removed
and 3) recreate the graph-- before the update is guaranteed to take effect.</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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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="PROPERTY_GRAPH_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_GRAPH_NAME</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_GRAPH_NAME</pre>
</li>
</ul>
<a name="PROPERTY_CREATED_USING_TEMPLATE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PROPERTY_CREATED_USING_TEMPLATE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_CREATED_USING_TEMPLATE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.janusgraph.graphdb.management.ConfigurationManagementGraph.PROPERTY_CREATED_USING_TEMPLATE">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="ConfigurationManagementGraph-org.janusgraph.graphdb.database.StandardJanusGraph-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConfigurationManagementGraph</h4>
<pre>public&nbsp;ConfigurationManagementGraph(<a href="../../../../org/janusgraph/graphdb/database/StandardJanusGraph.html" title="class in org.janusgraph.graphdb.database">StandardJanusGraph</a>&nbsp;graph)</pre>
<div class="block">This class allows you to create/update/remove configuration objects used to open a graph.
To use these APIs, you must define one of your graph's key as "ConfigurationManagementGraph"
in your server's YAML; the configuration objects you define using these APIs will be stored
in a graph representation (on a vertex, more precisely), and this graph will be opened
according to the file supplied along with the "ConfigurationManagementGraph" key.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="shutdownConfigurationManagementGraph--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdownConfigurationManagementGraph</h4>
<pre>public static&nbsp;void&nbsp;shutdownConfigurationManagementGraph()</pre>
</li>
</ul>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../org/janusgraph/graphdb/management/ConfigurationManagementGraph.html" title="class in org.janusgraph.graphdb.management">ConfigurationManagementGraph</a>&nbsp;getInstance()
throws <a href="../../../../org/janusgraph/graphdb/management/utils/ConfigurationManagementGraphNotEnabledException.html" title="class in org.janusgraph.graphdb.management.utils">ConfigurationManagementGraphNotEnabledException</a></pre>
<div class="block">If one of your "graphs" key was equivalent to "ConfigurationManagementGraph" in your
YAML file supplied at server start, then we return the ConfigurationManagementGraph
Singleton-- otherwise we throw a <a href="../../../../org/janusgraph/graphdb/management/utils/ConfigurationManagementGraphNotEnabledException.html" title="class in org.janusgraph.graphdb.management.utils"><code>ConfigurationManagementGraphNotEnabledException</code></a> exception.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/janusgraph/graphdb/management/utils/ConfigurationManagementGraphNotEnabledException.html" title="class in org.janusgraph.graphdb.management.utils">ConfigurationManagementGraphNotEnabledException</a></code></dd>
</dl>
</li>
</ul>
<a name="createConfiguration-org.apache.commons.configuration2.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createConfiguration</h4>
<pre>public&nbsp;void&nbsp;createConfiguration(org.apache.commons.configuration2.Configuration&nbsp;config)</pre>
<div class="block">Create a configuration according to the supplied <code>Configuration</code>; you must include
the property "graph.graphname" with a value in the configuration; you can then
open your graph using graph.graphname without having to supply the
Configuration or File each time using the <a href="../../../../org/janusgraph/core/ConfiguredGraphFactory.html" title="class in org.janusgraph.core"><code>ConfiguredGraphFactory</code></a>.</div>
</li>
</ul>
<a name="createTemplateConfiguration-org.apache.commons.configuration2.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTemplateConfiguration</h4>
<pre>public&nbsp;void&nbsp;createTemplateConfiguration(org.apache.commons.configuration2.Configuration&nbsp;config)</pre>
<div class="block">Create a template configuration according to the supplied <code>Configuration</code>; if
you already created a template configuration or the supplied <code>Configuration</code>
contains the property "graph.graphname", we throw a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a>; you can then use
this template configuration to create a graph using the
ConfiguredGraphFactory create signature and supplying a new graphName.</div>
</li>
</ul>
<a name="updateConfiguration-java.lang.String-org.apache.commons.configuration2.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateConfiguration</h4>
<pre>public&nbsp;void&nbsp;updateConfiguration(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;graphName,
org.apache.commons.configuration2.Configuration&nbsp;config)</pre>
<div class="block">Update configuration corresponding to supplied graphName; we update supplied existing
properties and add new ones to the <code>Configuration</code>; The supplied <code>Configuration</code> must include a
property "graph.graphname" and it must match supplied graphName;
NOTE: The updated configuration is only guaranteed to take effect if the <code>Graph</code> corresponding to
graphName has been closed and reopened on every JanusGraph Node.</div>
</li>
</ul>
<a name="updateTemplateConfiguration-org.apache.commons.configuration2.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateTemplateConfiguration</h4>
<pre>public&nbsp;void&nbsp;updateTemplateConfiguration(org.apache.commons.configuration2.Configuration&nbsp;config)</pre>
<div class="block">Update template configuration by updating supplied existing properties and adding new ones to the
<code>Configuration</code>; your updated Configuration may not contain the property "graph.graphname";
NOTE: Any graph using a configuration that was created using the template configuration must--
1) be closed and reopened on every JanusGraph Node 2) have its corresponding Configuration removed
and 3) recreate the graph-- before the update is guaranteed to take effect.</div>
</li>
</ul>
<a name="removeConfiguration-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeConfiguration</h4>
<pre>public&nbsp;void&nbsp;removeConfiguration(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;graphName)</pre>
<div class="block">Remove Configuration according to graphName</div>
</li>
</ul>
<a name="removeConfiguration-java.lang.String-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeConfiguration</h4>
<pre>public&nbsp;void&nbsp;removeConfiguration(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;graphName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;configKeys)</pre>
<div class="block">Remove configuration corresponding to supplied graphName; we remove supplied existing
properties.
NOTE: The updated configuration is only guaranteed to take effect if the <code>Graph</code> corresponding to
graphName has been closed and reopened on every JanusGraph Node.</div>
</li>
</ul>
<a name="removeTemplateConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTemplateConfiguration</h4>
<pre>public&nbsp;void&nbsp;removeTemplateConfiguration()</pre>
<div class="block">Remove template configuration</div>
</li>
</ul>
<a name="getConfiguration-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getConfiguration(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configName)</pre>
<div class="block">Get Configuration according to supplied graphName mapped to a specific
<code>Graph</code>; if does not exist, return null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map&lt;String, Object&gt;</dd>
</dl>
</li>
</ul>
<a name="getConfigurations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigurations</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/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/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&gt;&nbsp;getConfigurations()</pre>
<div class="block">Get a list of all Configurations, excluding the template configuration; if none exist,
return an empty list</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List&lt;Map&lt;String, Object&gt;&gt;</dd>
</dl>
</li>
</ul>
<a name="getGraphNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGraphNames</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getGraphNames()</pre>
<div class="block">Get a set of all graph names, excluding the template configuration; if none exist,
return an empty set</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all available graph names</dd>
</dl>
</li>
</ul>
<a name="getTemplateConfiguration--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTemplateConfiguration</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getTemplateConfiguration()</pre>
<div class="block">Get template configuration if exists, else return null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map&lt;String, Object&gt;</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="class-use/ConfigurationManagementGraph.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/janusgraph/graphdb/management/JanusGraphManager.html" title="class in org.janusgraph.graphdb.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/janusgraph/graphdb/management/ConfigurationManagementGraph.html" target="_top">Frames</a></li>
<li><a href="ConfigurationManagementGraph.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2023. All rights reserved.</small></p>
</body>
</html>