Package org.opendaylight.graph

Interface ConnectedGraphProvider

  • All Known Implementing Classes:
    ConnectedGraphServer
    public interface ConnectedGraphProvider
    Connected Graph Provider is a new service provided by the Graph feature to manage the Connected Graph.

    It allows to get, create, add and delete Connected Graph. All associated Graph are automatically stored in the DataStore.

    Author:
    Olivier Dugeon, Philippe Niger

    • Method Detail

      • getGraph

        Graph getGraph​(String name)
        Returns Graph for the given graph name.
        Parameters:
        name - Name of the Graph
        Returns:
        Graph

      • getGraph

        Graph getGraph​(GraphKey key)
        Returns the Graph for the given graph key.
        Parameters:
        key - Unique Graph Identifier
        Returns:
        Graph

      • getConnectedGraph

        ConnectedGraph getConnectedGraph​(String name)
        Returns Connected Graph for the given graph name.
        Parameters:
        name - Name of the Graph
        Returns:
        Connected Graph

      • getConnectedGraph

        ConnectedGraph getConnectedGraph​(GraphKey key)
        Returns Connected Graph for the given graph key.
        Parameters:
        key - Unique Graph Identifier
        Returns:
        Connected Graph

      • getConnectedGraphs

        List<ConnectedGraph> getConnectedGraphs()
        Returns all registered Connected Graphs.
        Returns:
        List of Connected Graph

      • createConnectedGraph

        ConnectedGraph createConnectedGraph​(String name,
                                    Graph.DomainScope scope)
        Create Connected Graph and associated Graph for given name and Graph Type. The associated Graph is also stored in the DataStore.
        Parameters:
        name - Name of the Graph
        scope - Domain scope of the Graph (Intra or Inter domain)
        Returns:
        Connected Graph

      • addGraph

        ConnectedGraph addGraph​(Graph graph)
        Add a Graph. This action will automatically create the associated Connected Graph and store is in the DataStore.
        Parameters:
        graph - Graph to be added
        Returns:
        Connected Graph

      • deleteGraph

        void deleteGraph​(GraphKey key)
        Remove a Graph. This action will automatically delete the associated Connected Graph and store is in the DataStore.
        Parameters:
        key - Graph Identifier