Package org.opennms.netmgt.alarmd.northbounder.syslog

Class SyslogNorthbounder

java.lang.Object

org.opennms.netmgt.alarmd.api.support.AbstractNorthbounder

org.opennms.netmgt.alarmd.northbounder.syslog.SyslogNorthbounder

All Implemented Interfaces:

Runnable, Northbounder, StatusFactory<NorthboundAlarm>, org.springframework.beans.factory.InitializingBean

public class SyslogNorthbounder
extends AbstractNorthbounder
implements org.springframework.beans.factory.InitializingBean

Forwards alarms via Syslog.

Author:

David Hustace

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	NBI_NAME	The Constant NBI_NAME.

Constructor Summary

Constructors

Constructor	Description
SyslogNorthbounder(SyslogNorthbounderConfigDao configDao, String destination)	Instantiates a new Syslog northbounder.

Method Summary

Modifier and Type	Method	Description
boolean	accepts(NorthboundAlarm alarm)	The abstraction makes a call here to determine if the alarm should be placed on the queue of alarms to be sent northerly.
void	afterPropertiesSet()
void	forwardAlarms(List<NorthboundAlarm> alarms)	Each implementation of the AbstractNorthbounder has a nice queue (Nagle's algorithmic) and the worker thread that processes the queue calls this method to send alarms to the northern NMS.
SyslogNorthbounderConfig	getConfig()	Gets the Syslog configuration.
boolean	isReady()	Used to determine if the northbounder is ready to accept alarms.

Methods inherited from class org.opennms.netmgt.alarmd.api.support.AbstractNorthbounder

createMapping, createSyncLostMessage, discard, getName, onAlarm, onPostStart, onPreStart, onStop, preserve, reloadConfig, run, setMaxBatchSize, setMaxPreservedAlarms, setNaglesDelay, setRetryInterval, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NBI_NAME

protected static final String NBI_NAME

The Constant NBI_NAME.

See Also:

Constant Field Values

Constructor Detail

SyslogNorthbounder

public SyslogNorthbounder(SyslogNorthbounderConfigDao configDao,
                          String destination)

Instantiates a new Syslog northbounder.

Parameters:

configDao - the Syslog configuration DAO

destination - the destination

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

accepts

public boolean accepts(NorthboundAlarm alarm)

The abstraction makes a call here to determine if the alarm should be placed on the queue of alarms to be sent northerly.

Specified by:

accepts in class AbstractNorthbounder

Parameters:

alarm - the alarm

Returns:

true, if successful

isReady

public boolean isReady()

Description copied from interface: Northbounder

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.

Specified by:

isReady in interface Northbounder

Returns:

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

forwardAlarms

public void forwardAlarms(List<NorthboundAlarm> alarms)
                   throws NorthbounderException

Each implementation of the AbstractNorthbounder has a nice queue (Nagle's algorithmic) and the worker thread that processes the queue calls this method to send alarms to the northern NMS.

Specified by:

forwardAlarms in class AbstractNorthbounder

Parameters:

alarms - the alarms

Throws:

NorthbounderException - the northbounder exception

getConfig

public SyslogNorthbounderConfig getConfig()

Gets the Syslog configuration.

Returns:

the Syslog configuration