Developers Guide
Total Page:16
File Type:pdf, Size:1020Kb
Developers Guide Copyright (c) 2015-2019 The OpenNMS Group, Inc. OpenNMS Meridian 2019.1.23, Last updated 2021-09-07 21:58:30 UTC Table of Contents 1. Setup a development system . 1 1.1. Operating System / Environment . 1 1.2. Installation . 1 1.3. Tooling. 3 1.4. Useful links. 3 1.4.1. General . 3 1.4.2. Installation / Setup . 3 2. Topology . 4 2.1. Info Panel Items . 4 2.1.1. Programmatic . 4 2.1.2. Scriptable . 5 2.2. GraphML . 9 2.2.1. Create/Update/Delete GraphML Topology. 10 2.2.2. Supported Attributes . 11 2.2.3. Focus Strategies . 12 2.2.4. Icons . 12 2.2.5. Vertex Status Provider . 13 2.2.6. Edge Status Provider . 13 2.2.7. Layers . 14 2.2.8. Breadcrumbs . 16 2.3. Topologies Updates. 20 2.3.1. OnmsTopologyUpdater . 20 2.3.2. OnmsTopologyRef. 20 2.3.3. OnmsTopologyMessage . 21 2.3.4. OnmsTopologyProtocol . 21 2.3.5. TopologyMessageStatus. 21 2.3.6. OnmsTopology. 21 2.3.7. OnmsTopologyVertex. 21 2.3.8. OnmsTopologyEdge . 21 2.3.9. OnmsTopologyPort . 22 2.3.10. OnmsTopologyConsumer . 22 3. CORS Support . 23 3.1. Why do I need CORS support?. 23 3.2. How can I enable CORS support? . 23 3.3. How can I configure CORS support? . 23 4. ReST API . 24 4.1. ReST URL. 24 4.2. Authentication. 24 4.3. Data format . 24 4.4. Standard Parameters . 24 4.5. Standard filter examples . 25 4.6. HTTP Return Codes . 26 4.7. Identifying Resources . 26 4.8. Expose ReST services via OSGi . 27 4.8.1. Define a ReST interface . 27 4.8.2. Implement a ReST interface . 28 4.8.3. Export the ReST service. 28 4.9. Currently Implemented Interfaces. 29 4.9.1. Acknowledgements . 29 4.9.2. Alarm Statistics . 30 4.9.3. Alarms . 30 4.9.4. Alarm History . ..