org.opennms.netmgt.alarmd.api.support

Class AbstractNorthbounder

java.lang.Object

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

All Implemented Interfaces:

Runnable, Northbounder, StatusFactory<NorthboundAlarm>

Direct Known Subclasses:

AlarmNorthbounder, BSFNorthbounder, DroolsNorthbounder, EmailNorthbounder, HttpNorthbounder, JmsNorthbounder, NCSNorthbounder, SnmpTrapNorthbounder, SyslogNorthbounder

public abstract class AbstractNorthbounder
extends Object
implements Northbounder, Runnable, StatusFactory<NorthboundAlarm>

AbstractNorthBounder

The purpose of this class is manage the queue of alarms that need to be forward and receive queries to/from a Southbound Interface.

It passes Alarms on to the forwardAlarms method implemented by base classes in batches as they are added to the queue. The forwardAlarms method does the actual work of sending them to the Southbound Interface.

Preserve, accept and discard are called to add the Alarms to the queue as appropriate.

Author:

David Hustace, Alejandro Galue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNorthbounder(String name) Instantiates a new abstract northbounder.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	accepts(NorthboundAlarm alarm) Accepts.
protected Map<String,Object>	createMapping(NorthboundAlarm alarm, String dateFormat) Creates the mapping.
NorthboundAlarm	createSyncLostMessage() Creates a new Status object.
protected void	discard(NorthboundAlarm alarm) Discard.
abstract void	forwardAlarms(List<NorthboundAlarm> alarms) Forward alarms.
String	getName() Gets the name.
void	onAlarm(NorthboundAlarm alarm) On alarm.
protected void	onPostStart() Override this to perform actions after startup.
protected void	onPreStart() Override this to perform actions before startup.
protected void	onStop() Override this to perform actions when stopping.
protected void	preserve(NorthboundAlarm alarm) Preserve.
void	reloadConfig() Override this to perform actions when reloading the configuration.
void	run()
void	setMaxBatchSize(int maxBatchSize) Sets the max batch size.
void	setMaxPreservedAlarms(int maxPreservedAlarms) Sets the max preserved alarms.
void	setNaglesDelay(long delay) Sets the nagles delay.
void	setRetryInterval(int retryInterval) Sets the retry interval.
void	start() Start.
void	stop() Stop.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.netmgt.alarmd.api.Northbounder

isReady

Constructor Detail

AbstractNorthbounder

protected AbstractNorthbounder(String name)

Instantiates a new abstract northbounder.

Parameters:

name - the name

Method Detail

getName

public String getName()

Description copied from interface: Northbounder

Gets the name.

Specified by:

getName in interface Northbounder

Returns:

the name

setNaglesDelay

public void setNaglesDelay(long delay)

Sets the nagles delay.

Parameters:

delay - the new nagles delay

setRetryInterval

public void setRetryInterval(int retryInterval)

Sets the retry interval.

Parameters:

retryInterval - the new retry interval

setMaxBatchSize

public void setMaxBatchSize(int maxBatchSize)

Sets the max batch size.

Parameters:

maxBatchSize - the new max batch size

setMaxPreservedAlarms

public void setMaxPreservedAlarms(int maxPreservedAlarms)

Sets the max preserved alarms.

Parameters:

maxPreservedAlarms - the new max preserved alarms

onPreStart

protected void onPreStart()

Override this to perform actions before startup.

onPostStart

protected void onPostStart()

Override this to perform actions after startup.

start

public final void start()
                 throws NorthbounderException

Description copied from interface: Northbounder

Start.

Specified by:

start in interface Northbounder

Throws:

NorthbounderException - the northbounder exception

onAlarm

public final void onAlarm(NorthboundAlarm alarm)
                   throws NorthbounderException

Description copied from interface: Northbounder

On alarm.

Specified by:

onAlarm in interface Northbounder

Parameters:

alarm - the alarm

Throws:

NorthbounderException - the northbounder exception

accepts

protected abstract boolean accepts(NorthboundAlarm alarm)

Accepts.

Parameters:

alarm - the alarm

Returns:

true, if successful

preserve

protected void preserve(NorthboundAlarm alarm)
                 throws NorthbounderException

Preserve.

Parameters:

alarm - the alarm

Throws:

NorthbounderException - the northbounder exception

discard

protected void discard(NorthboundAlarm alarm)
                throws NorthbounderException

Discard.

Parameters:

alarm - the alarm

Throws:

NorthbounderException - the northbounder exception

onStop

protected void onStop()

Override this to perform actions when stopping.

reloadConfig

public void reloadConfig()

Override this to perform actions when reloading the configuration.

Specified by:

reloadConfig in interface Northbounder

stop

public final void stop()
                throws NorthbounderException

Description copied from interface: Northbounder

Stop.

Specified by:

stop in interface Northbounder

Throws:

NorthbounderException - the northbounder exception

run

public void run()

Specified by:

run in interface Runnable

createSyncLostMessage

public NorthboundAlarm createSyncLostMessage()

Description copied from interface: StatusFactory

Creates a new Status object.

Specified by:

createSyncLostMessage in interface StatusFactory<NorthboundAlarm>

Returns:

the generic type object

forwardAlarms

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

Forward alarms.

Parameters:

alarms - the alarms

Throws:

NorthbounderException - the northbounder exception

createMapping

protected Map<String,Object> createMapping(NorthboundAlarm alarm,
                                           String dateFormat)

Creates the mapping.

Parameters:

alarmMappings - the alarm mappings

alarm - the northbound alarm

Returns:

the mapping object