Skip to content
A stable Java API for interfacing with and extending OpenNMS
Branch: master
Clone or download
cgorantla Merge pull request #16 from OpenNMS/jira/OIA-19
OIA-19: Fix Ticketing API to return Ticket Id
Latest commit 8cf879d Jun 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
api
common OIA-19: Fix Ticketing Plugin to return Ticket Id Jun 25, 2019
config
karaf-features OIA-19: Fix Ticketing Plugin to return Ticket Id Jun 25, 2019
sample OIA-19: Fix Ticketing Plugin to return Ticket Id Jun 25, 2019
test-api
.circleci.settings.xml Initial commit. Oct 3, 2018
.gitignore 0.1.0 -> 0.1.1-SNAPSHOT Apr 23, 2019
DEVEL.md Documentation updates. Apr 15, 2019
LICENSE.md
README.md aim Apr 25, 2019
pom.xml OIA-19: Fix Ticketing Plugin to return Ticket Id Jun 25, 2019

README.md

OpenNMS Integration API CircleCI

This project aims to make it easier to write plugins and extensions to OpenNMS by introducing a stable interface against which these can be written. Versions of OpenNMS and Meridian will then implement at least one major version of the API.

Features

Users for the API can currently take advantage of the following features and interfaces. See the interfaces defined in the api module for a complete list.

Extend

  • Event configuration
  • Syslog configuration (message to event mappings)

Consume

  • Runtime information
    • Version - major,minor,patch,snapshot
    • Container type - OpenNMS vs Minion vs Sentinel
  • Alarm lifecycle callbacks
  • DAOs
    • Node
    • SNMP Interface
  • Coordination API
  • Events

Expose

  • Health checks
    • Provide custom health checks to verify the sanity of your plugin
  • Alarm persister extensions
    • Mangle alarms before they are persisted
  • Service monitors
  • Service collectors
  • Provisiond detectors
  • Ticketers

Versioning

Given that the API is fairly new, we expect that we will need to make changes and improvements over the next few releases of OpenNMS Horizon. In order to make sure that your plugins or extensions do not break within minor and patch releases:

  • Do not implement, or extend interfaces marked with the @Consumable annotation as we reserve the right to add new method signatures to these.
  • Do not implement, or extend interfaces marked with the @Model annotation as we reserve the right to add new method signatures to these.
    • Use the provided builders for these interfaces in the common module instead.

Once stabilized, we are aiming to follow Semantic Versioning.

You can’t perform that action at this time.