Package org.opennms.netmgt.alarmd.api

Interface Northbounder

All Known Implementing Classes:

AbstractNorthbounder, AlarmNorthbounder, BSFNorthbounder, BSFNorthbounderManager, DroolsNorthbounder, DroolsNorthbounderManager, EmailNorthbounder, EmailNorthbounderManager, HttpNorthbounder, JmsNorthbounder, JmsNorthbounderManager, SnmpTrapNorthbounder, SnmpTrapNorthbounderManager, SyslogNorthbounder, SyslogNorthbounderManager

public interface Northbounder

North bound Interface API.

Author:

David Hustace

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Gets the name.
boolean	isReady()	Used to determine if the northbounder is ready to accept alarms.
void	onAlarm(NorthboundAlarm alarm)	On alarm.
void	reloadConfig()	Reloads configuration.
void	start()	Start.
void	stop()	Stop.

Method Detail

start

void start()
    throws NorthbounderException

Start.

Throws:

NorthbounderException - the northbounder exception

isReady

boolean isReady()

Used to determine if the northbounder is ready to accept alarms. If no northbounders are ready, the caller can save resources by not creating and initializing the NorthboundAlarms. This method is called once after northbounder is registered and started. If the status were to change sometime after, the northbounder must re-register itself.

Returns:

true if the northbounder is ready to accept alarms, false otherwise.

onAlarm

void onAlarm(NorthboundAlarm alarm)
      throws NorthbounderException

On alarm.

Parameters:

alarm - the alarm

Throws:

NorthbounderException - the northbounder exception

stop

void stop()
   throws NorthbounderException

Stop.

Throws:

NorthbounderException - the northbounder exception

getName

java.lang.String getName()

Gets the name.

Returns:

the name

reloadConfig

void reloadConfig()
           throws NorthbounderException

Reloads configuration.

Throws:

NorthbounderException