public class ConfigurationManagementGraph extends Object
Modifier and Type | Field and Description |
---|---|
static String |
PROPERTY_CREATED_USING_TEMPLATE |
static String |
PROPERTY_GRAPH_NAME |
Constructor and Description |
---|
ConfigurationManagementGraph(StandardJanusGraph graph)
This class allows you to create/update/remove configuration objects used to open a graph.
|
Modifier and Type | Method and Description |
---|---|
void |
createConfiguration(org.apache.commons.configuration.Configuration config)
Create a configuration according to the supplied
Configuration ; 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 ConfiguredGraphFactory . |
void |
createTemplateConfiguration(org.apache.commons.configuration.Configuration config)
Create a template configuration according to the supplied
Configuration ; if
you already created a template configuration or the supplied Configuration
contains the property "graph.graphname", we throw a RuntimeException ; you can then use
this template configuration to create a graph using the
ConfiguredGraphFactory create signature and supplying a new graphName. |
Map<String,Object> |
getConfiguration(String configName)
Get Configuration according to supplied graphName mapped to a specific
Graph ; if does not exist, return null. |
List<Map<String,Object>> |
getConfigurations()
Get a list of all Configurations, excluding the template configuration; if none exist,
return an empty list
|
static ConfigurationManagementGraph |
getInstance()
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
ConfigurationManagementGraphNotEnabledException exception. |
Map<String,Object> |
getTemplateConfiguration()
Get template configuration if exists, else return null.
|
void |
removeConfiguration(String graphName)
Remove Configuration according to graphName
|
void |
removeTemplateConfiguration()
Remove template configuration
|
protected static void |
shutdownConfigurationManagementGraph() |
void |
updateConfiguration(String graphName,
org.apache.commons.configuration.Configuration config)
Update configuration corresponding to supplied graphName; we update supplied existing
properties and add new ones to the
Configuration ; The supplied Configuration must include a
property "graph.graphname" and it must match supplied graphName;
NOTE: The updated configuration is only guaranteed to take effect if the Graph corresponding to
graphName has been closed and reopened on every JanusGraph Node. |
void |
updateTemplateConfiguration(org.apache.commons.configuration.Configuration config)
Update template configuration by updating supplied existing properties and adding new ones to the
Configuration ; 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. |
public static final String PROPERTY_GRAPH_NAME
public static final String PROPERTY_CREATED_USING_TEMPLATE
public ConfigurationManagementGraph(StandardJanusGraph graph)
protected static void shutdownConfigurationManagementGraph()
public static ConfigurationManagementGraph getInstance() throws ConfigurationManagementGraphNotEnabledException
ConfigurationManagementGraphNotEnabledException
exception.public void createConfiguration(org.apache.commons.configuration.Configuration config)
Configuration
; 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 ConfiguredGraphFactory
.public void createTemplateConfiguration(org.apache.commons.configuration.Configuration config)
Configuration
; if
you already created a template configuration or the supplied Configuration
contains the property "graph.graphname", we throw a RuntimeException
; you can then use
this template configuration to create a graph using the
ConfiguredGraphFactory create signature and supplying a new graphName.public void updateConfiguration(String graphName, org.apache.commons.configuration.Configuration config)
Configuration
; The supplied Configuration
must include a
property "graph.graphname" and it must match supplied graphName;
NOTE: The updated configuration is only guaranteed to take effect if the Graph
corresponding to
graphName has been closed and reopened on every JanusGraph Node.public void updateTemplateConfiguration(org.apache.commons.configuration.Configuration config)
Configuration
; 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.public void removeConfiguration(String graphName)
public void removeTemplateConfiguration()
public Map<String,Object> getConfiguration(String configName)
Graph
; if does not exist, return null.public List<Map<String,Object>> getConfigurations()
Copyright © 2012–2020. All rights reserved.