dmaap-adaptor-java/README.md

   1 # O-RAN-SC Non-RealTime RIC DMaaP Information Producer
   2
   3 This product is a generic information producer (as defined by the Information Coordinator Service (ICS)). It can produce any information that can be retrieved from DMaaP. Its main tasks is to register information types and itself as a producer using the ICS Data Producer API.
   4
   5 A data consumer may create information jobs through the ICS Data Producer API.
   6
   7 This service will retrieve data from the DMaaP Message Router (MR) and distribute it further to the data consumers (information job owners).
   8
   9 The component is a springboot service and is configured as any springboot service through the file `config/application.yaml`. The component log can be retrieved and logging can be controled by means of REST call. See the API documentation (api/api.yaml).
  10
  11 The file `config/application_configuration.json` contains the configuration of job types that the producer will support.
  12
  13     {
  14        "types":
  15         [
  16           {
  17             "id": The ID of the job type, e.g. "STD_Fault_Messages",
  18             "dmaapTopicUrl": The topic URL to poll from DMaaP Message Router, e.g. "events/unauthenticated.SEC_FAULT_OUTPUT/dmaapmediatorproducer/STD_Fault_Messages"
  19           }
  20       ]
  21     }
  22
  23 The service producer will constantly poll MR for all configured job types. When receiving messages for a type, it will distribute these messages to all jobs registered for the type. If no jobs for that type are registered, the messages will be discarded. If a consumer is unavailable for distribution, the messages will be discarded for that consumer.
  24
  25 ## License
  26
  27 Copyright (C) 2021 Nordix Foundation.
  28 Licensed under the Apache License, Version 2.0 (the "License")
  29 you may not use this file except in compliance with the License.
  30 You may obtain a copy of the License at
  31
  32       http://www.apache.org/licenses/LICENSE-2.0
  33
  34 Unless required by applicable law or agreed to in writing, software
  35 distributed under the License is distributed on an "AS IS" BASIS,
  36 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  37 See the License for the specific language governing permissions and
  38 limitations under the License.
  39
  40 For more information about license please see the [LICENSE](LICENSE.txt) file for details.