index.md

ODENOS APIs

ODENOS is a framework for developing SDN controller.
It is not SDN controller itself, but libraries (SDK).
ODENOS is implemented with Java, Python, and Ruby language.
It consists of following components.
You can control these components by REST-API

---

REST APIs

• ODENOS core Components

  • SystemManager
  • EventManager
  • ComponentManager
  • Network
  • data Classes

• Basic Logic Components

  • Aggregator
  • Slicer
  • Federator
  • LinkLayerizer
  • LearningSwitch

• Table of Typical Status Code

  • 200 -- OK
  • 201 -- Created
  • 204 -- No Content (DELETE)
  • 400 -- Bad Request
  • 403 -- Forbidden
  • 404 -- Not Found
  • 409 -- Conflict
    • If encounterd this error, repeat again from GET.
  • 500 -- Internal Server Error

---

Java APIs

API of java you can to document (javadoc) in the following command.
It will be output to the directory (./doc/java/).

   $ mvn javadoc:javadoc

API corresponding to REST to easily develop the controller is served.

• SystemManager equivalent API is SystemManagerIF.
• Network equivalent API is NetworkIF.
• Logic equivalent API is LogicIF.

---

Python APIs

API of Python you can to document (javadoc) in the following command.
It will be output to the directory (./doc/python).

   $ doxygen ./etc/Doxyfile.python 

API corresponding to REST to easily develop the controller is served.

• SystemManager equivalent API is system_manager_interface.
• Network equivalent API is network_interface.

---

Ruby APIs

API of Ruby you can to document (yardoc) in the following command.
It will be output to the directory (./doc/ruby/).

   $ cd  ./src/main/ruby
   $ yardoc org/o3project/odenos -o ../../../doc/ruby

API corresponding to REST to easily develop the controller is served.

• SystemManager equivalent API is system_manager_interface.
• Network equivalent API is network_interface.

---

ODENOS Architecture

---

ODENOS SystemConfiguration

---

---