...
| API | URL | Description |
|---|---|---|
| DataProvider RPC | /rest | FCAPS function |
| About | /about | Version info (format in Markdown, rendered by aboutPage in ODLUX) |
GetYangSchema | /yang-schema | Provide collected yang specs (scheme-cache) Yang Download Service |
ReadyServlet | /ready | get GET /ready |
| mediator gateway | /ms | Proxy function to manage a Mediator Gateway |
| read-inventory-tree | /tree | Analysis of inventory data. See Get device Inventory data from database |
| userdata | /userdata | See: ODLUX DB API Extension for Userdata |
DataProvider RPC
The bundle data-provider is the Web-API for our Database to read, write, update and delete data. The reason for this is the abstraction and exchangeability of the database (currently elasticsearch). Its provided data is specified in the data-provider.yang in the submodule data-provider-model. Each datatype is so called Entity.
...
- connectionlog
- faultcurrent
- faultlog
- eventlog
- historicalperformance15min
- historicalperformance24h
- mediator-server
- networkelement-connection
- inventoryequipment
- maintenancemode
- guicutthrough (Move GUI cut through into server)
Guidance for data-provider.yang → onap gerrit ccsdk/features sdnr/wt/data-provider/provider/src/../yang
...
The entrypoint for the data-provider is the DataProviderImpl class (org.onap.ccsdk.features.sdnr.wt.dataprovider.impl.DataProviderImpl). Its just handling all the nested services and other provided servlets. The most important part is the DataProviderServiceImpl (org.onap.ccsdk.features.sdnr.wt.dataprovider.impl.DataProviderServiceImpl). This is implementing the Service for the rpc-requests defined by the data-provider.yang so the handler for all our webrequests for the database.
Ready Service
GET /ready
| response | description |
|---|---|
| 200 | no bundle in failure state, everything up and running |
| !200 | at least one bundle is in failure state or not all bundles are in Active or Resolved state |
Mediator Gateway Service
Reverse proxy functionality which forwards e.g.
GET /ms/{ms-server-db-id}/api/?task=getconfig
to
{mediator-server-url}/api/?task=getconfig
and forwards response from the server.