Package org.opendaylight.graph

Interface ConnectedVertex

All Known Implementing Classes:
ConnectedVertexImpl
public interface ConnectedVertex
Connected Vertex class is the connected version of the Vertex class from the graph yang model.

It is composed of a reference to the associated Vertex class from the Graph class, a unique Key identifier in the associated Connected Graph, and two lists to the associated Connected Edges in the connected Graph: input and output. 

 
                              -------------
                              | Connected |
                         ---->|  Vertex   |---->
 Input Connected Edges {  ... | - Key     | ...  } Output Connected Edges
                         ---->| - Vertex  |---->
                              -------------
Author:
Olivier Dugeon, Philippe Niger

  • Method Details

    • getKey

      @NonNull Long getKey()
      Returns unique key associated to this Connected Vertex.
      Returns:
      Vertex Key

    • getVertex

      @NonNull Vertex getVertex()
      Returns Vertex associated to this Connected Vertex.
      Returns:
      vertex Vertex

    • getEdgeTo

      List<ConnectedEdge> getEdgeTo(Long destinationKey)
      Returns Connected Edges that has for destination the Connected Vertex identified by its key.
      Parameters:
      destinationKey - Unique Key that identify the destination Vertex
      Returns:
      List of Connected Edge

    • getInputEdges

      List<Edge> getInputEdges()
      Returns the list of incoming Edge for this Connected Vertex.
      Returns:
      List of Edge

    • getInputConnectedEdges

      List<ConnectedEdge> getInputConnectedEdges()
      Returns the list of incoming Connected Edge for this Connected Vertex.
      Returns:
      List of Connected Edge

    • getOutputEdges

      List<Edge> getOutputEdges()
      Returns the list of outgoing Edge for this Connected Vertex.
      Returns:
      List of Edge

    • getOutputConnectedEdges

      List<ConnectedEdge> getOutputConnectedEdges()
      Returns the list of outgoing Connected Edge for this Connected Vertex.
      Returns:
      List of Connected Edge

    • getPrefixes

      List<Prefix> getPrefixes()
      Return the list of prefix announced by this Connected Vertex. Prefix contains the associated SID when Segment Routing is enable.
      Returns:
      List of Prefix

    • registerTrigger

      boolean registerTrigger(ConnectedVertexTrigger trigger, String key)
      Register a trigger that is executed when a problem occurs on the Connected Vertex.
      Parameters:
      trigger - Trigger to be registered
      key - A unique key as string e.g. NodeId+LspId
      Returns:
      True if registration is done, false otherwise

    • unRegisterTrigger

      boolean unRegisterTrigger(ConnectedVertexTrigger trigger, String key)
      Un-register a trigger that is already registered on the Connected Vertex.
      Parameters:
      trigger - Trigger to be unregistered
      key - A unique key as string e.g. NodeId+LspId
      Returns:
      True if un-registration is done, false otherwise