org.janusgraph.graphdb.management

Class ConfigurationManagementGraph

java.lang.Object

org.janusgraph.graphdb.management.ConfigurationManagementGraph

public class ConfigurationManagementGraph
extends Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CREATED_USING_TEMPLATE
static String	PROPERTY_GRAPH_NAME

Constructor Summary

Constructors

Constructor and Description
ConfigurationManagementGraph(StandardJanusGraph graph) This class allows you to create/update/remove configuration objects used to open a graph.

Method Summary

Modifier and Type	Method and Description
void	createConfiguration(org.apache.commons.configuration2.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.configuration2.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
Set<String>	getGraphNames() Get a set of all graph names, excluding the template configuration; if none exist, return an empty set
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	removeConfiguration(String graphName, Set<String> configKeys) Remove configuration corresponding to supplied graphName; we remove supplied existing properties.
void	removeTemplateConfiguration() Remove template configuration
static void	shutdownConfigurationManagementGraph()
void	updateConfiguration(String graphName, org.apache.commons.configuration2.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.configuration2.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_GRAPH_NAME

public static final String PROPERTY_GRAPH_NAME

PROPERTY_CREATED_USING_TEMPLATE

public static final String PROPERTY_CREATED_USING_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

ConfigurationManagementGraph

public ConfigurationManagementGraph(StandardJanusGraph graph)

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.

Method Detail

shutdownConfigurationManagementGraph

public static void shutdownConfigurationManagementGraph()

getInstance

public static ConfigurationManagementGraph getInstance()
                                                throws ConfigurationManagementGraphNotEnabledException

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.

Throws:

ConfigurationManagementGraphNotEnabledException

createConfiguration

public void createConfiguration(org.apache.commons.configuration2.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.

createTemplateConfiguration

public void createTemplateConfiguration(org.apache.commons.configuration2.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.

updateConfiguration

public void updateConfiguration(String graphName,
                                org.apache.commons.configuration2.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.

updateTemplateConfiguration

public void updateTemplateConfiguration(org.apache.commons.configuration2.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.

removeConfiguration

public void removeConfiguration(String graphName)

Remove Configuration according to graphName

removeConfiguration

public void removeConfiguration(String graphName,
                                Set<String> configKeys)

Remove configuration corresponding to supplied graphName; we remove supplied existing properties. 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.

removeTemplateConfiguration

public void removeTemplateConfiguration()

Remove template configuration

getConfiguration

public Map<String,Object> getConfiguration(String configName)

Get Configuration according to supplied graphName mapped to a specific Graph; if does not exist, return null.

Returns:

Map<String, Object>

getConfigurations

public List<Map<String,Object>> getConfigurations()

Get a list of all Configurations, excluding the template configuration; if none exist, return an empty list

Returns:

List<Map<String, Object>>

getGraphNames

public Set<String> getGraphNames()

Get a set of all graph names, excluding the template configuration; if none exist, return an empty set

Returns:

all available graph names

getTemplateConfiguration

public Map<String,Object> getTemplateConfiguration()

Get template configuration if exists, else return null.

Returns:

Map<String, Object>