Skip to content

Latest commit

 

History

History
270 lines (193 loc) · 8.85 KB

Federator.md

File metadata and controls

270 lines (193 loc) · 8.85 KB

Federator

Federater provide the ability to create a fedreted network to integrate original Network.

Operating specifications of the Federator.

  • Topology
    Federated network to create by integrating the original network.
    Link in Federated network the original network It represent in baundarys.
    Update topology in the original network is reflected in the federated network.

  • Flows
    If you set the Flow to federated network, the Flow is reflected in original networks by Federator.original flow is split in consideration of the baundary. When flow status of the all original network is changed to "established", flow status of federated network is to change the "established".

  • Packets
    InPacket transfer from original network to federated network.
    OutPacket transfer from federated network to original network.
    If port_id of the InPacket matches any of the port_id of boundaries, Federator will drop it.

  • boundary
    Original network each other, are connected through the boundary information.
    The boundary information is need on "network" and "node" and "port".

  • Create Instance of Federator.

    Generate an instance of Federator by performing a PUT(or POST) to the System Manager.

    PUT <base_uri>/components/<comp_id>

key value description
id <String> Unique Identifier in ODENOS.
type "Federator" ObjectType
cm_id <String> Specify the componentManager.Property.id to generate an instance. (Optional)

  • Component Connections

    Connection of Federator and Network by performing a PUT(or POST) to the System Manager.

    network | Connection possible number | connection_type ------------------|----------------------------|---------------------------------- original network | One or more | "original" federated network | Only one | "federated"

    PUT <base_uri>/connections/<conn_id>

key value description
id <String> Unique Identifier in ODENOS.
type 　　 　 "LogicAndNetwork"
connection_type "original" or "federated"
state none default "initializing"
logic_id <String> Federator ID
network_id <String> Network ID

REST APIs

GET <base_uri>/property

get Object property.

[Request]:
  • Body : none
[Response]:

PUT <base_uri>/property

update Object property.

[Request]:
[Response]:

GET <base_uri>/settings

Get Setting boundaries List, and relationship of the federated flow id and original flow id.

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : boundaries, federated_network_flow, original_network_flow

GET <base_uri>/settings/boundaries

Get Boundaries.
Boundaries are Boundary control table.
Boundaries are dict.(key:boundary_id, value:boundary object)

[Request]:
  • Body : none
[Response]:

POST <base_uri>/settings/boundaries

Set Boundary. <boundary_id> is automatically assigned.
after the send event to "ObjectSettingsChanged"

[Request]:
[Response]:

PUT <base_uri>/settings/boundaries/<boundary_id>

Set Boundary. after the send event to "ObjectSettingsChanged"

[Request]:
[Response]:

DELETE <base_uri>/settings/boundaries/<boundary_id>

Delete Boundary. after the send event to "ObjectSettingsChanged"

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : none

GET <base_uri>/federated_network_node

Get relationship of the federated node id and original node id. (Key is original)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<original_network_id::original_node_id, federated_node_id>

GET <base_uri>/original_network_node

Get relationship of the federated node id and original node id. (Key is federated)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<federated_node_id, (original_network_id, original_node_id)>

GET <base_uri>/federated_network_port

Get relationship of the federated port id and original port id. (Key is original)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<original_network_id::original_node_id::original_port_id, (federated_node_id, federated_port_id)>

GET <base_uri>/original_network_port

Get relationship of the federated port id and original port id. (Key is federated)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<federated_node_id::federated_port_id, (original_network_id, original_node_id, original_port_id)>

GET <base_uri>/federated_network_link

Get relationship of the federated link id and original link id. (Key is original)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<original_network_id::original_link_id, federated_link_id>

GET <base_uri>/original_network_link

Get relationship of the federated link id and original link id. (Key is federated)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<federated_link_id, (original_network_id, original_link_id)>

GET <base_uri>/federated_network_flow

Get relationship of the federated flow id and original flow id. (Key is original)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<original_network_id::original_flow_id, federated_flow_id>

GET <base_uri>/original_network_flow

Get relationship of the federated flow id and original flow id. (Key is federated)

[Request]:
  • Body : none
[Response]:
  • Status Code : 200
  • Body : dict<federated_flow_id, list[(original_network_id, original_flow_id)]>