org.openoss.opennms.spring.qosd
Interface QoSD

All Known Implementing Classes:

QoSDimpl2

public interface QoSD

QoSD interface.

Version:

$Id: $

Author:

ranger

Field Summary

static String

NAME Constant NAME="OpenOSS.QoSD"

Method Summary

String	getName() Returns the Log category name
String	getStats() not used but needed for initialisation
int	getStatus() lets OpenNMS know what state the daemon is in
void	init() Method to set up the fiber Note - not used in Spring activation
void	onEvent(Event event) The OpenNMS event listener runs this routine when a new event is detected.
void	pause() Pause method of fiber, called by OpenNMS to put the fiber in a suspended state until it can be later resumed.
void	registerListener() Registers an OpenNMS event listener with this class.
void	resume() Resume method of fiber, called by OpenNMS to start the fiber up from a paused state.
void	sendAlarms() A method to request an alarm list from the OpenNMS database and send the "unacked" alarms to the remote AlarmMonitor bean
void	setAlarmDao(AlarmDao alarmDao) Used by Spring Application context to pass in alarmDao
void	setAlarmListConnectionManager(AlarmListConnectionManager alcm) Used by Spring Application context to pass in AlarmListConnectionManager
void	setApplicationContext(org.springframework.context.support.ClassPathXmlApplicationContext m_context) Used by jmx mbean QoSD to pass in Spring Application context
void	setAssetRecordDao(AssetRecordDao ar) Used by Spring Application context to pass in AssetRecordDao
void	setEventIpcManager(EventIpcManager eventIpcManager) Used by Spring Application context to pass in EventIpcManager
void	setNodeDao(NodeDao nodedao) Used by Spring Application context to pass in NodeDaof
void	setOnmsAlarmOssjMapper(OnmsAlarmOssjMapper _onmsAlarmOssjMapper) Used by Spring Application context to pass in OnmsAlarmOssjMapper The OnmsAlarmOssjMapper class maps OpenNMS alarms to OSS/J alarms and events
void	setOssDao(OssDao _ossDao) provides an interface to OpenNMS which provides a unified api
void	start() The start() method loads the configuration for the QosD daemon and registers for events
void	stop() Stop method of fiber, called by OpenNMS when fiber execution is to finish.
void	unregisterListener() Stops OpenNMS calling the onEvent method of this object when an event occurs.

Field Detail

NAME

static final String NAME

Constant NAME="OpenOSS.QoSD"

See Also:

Constant Field Values

Method Detail

setOssDao

void setOssDao(OssDao _ossDao)

provides an interface to OpenNMS which provides a unified api

Parameters:

_ossDao - the ossDao to set

setOnmsAlarmOssjMapper

void setOnmsAlarmOssjMapper(OnmsAlarmOssjMapper _onmsAlarmOssjMapper)

Used by Spring Application context to pass in OnmsAlarmOssjMapper The OnmsAlarmOssjMapper class maps OpenNMS alarms to OSS/J alarms and events

Parameters:

_onmsAlarmOssjMapper - the onmsAlarmOssjMapper to set

setAssetRecordDao

void setAssetRecordDao(AssetRecordDao ar)

Used by Spring Application context to pass in AssetRecordDao

Parameters:

ar - a AssetRecordDao object.

setNodeDao

void setNodeDao(NodeDao nodedao)

Used by Spring Application context to pass in NodeDaof

Parameters:

nodedao - a NodeDao object.

setEventIpcManager

void setEventIpcManager(EventIpcManager eventIpcManager)

Used by Spring Application context to pass in EventIpcManager

Parameters:

eventIpcManager - a EventIpcManager object.

setAlarmDao

void setAlarmDao(AlarmDao alarmDao)

Used by Spring Application context to pass in alarmDao

Parameters:

alarmDao - a AlarmDao object.

setAlarmListConnectionManager

void setAlarmListConnectionManager(AlarmListConnectionManager alcm)

Used by Spring Application context to pass in AlarmListConnectionManager

Parameters:

alcm - a AlarmListConnectionManager object.

setApplicationContext

void setApplicationContext(org.springframework.context.support.ClassPathXmlApplicationContext m_context)

Used by jmx mbean QoSD to pass in Spring Application context

Parameters:

m_context - - application context for this bean to use

init

void init()

Method to set up the fiber Note - not used in Spring activation

start

void start()

The start() method loads the configuration for the QosD daemon and registers for events

stop

void stop()

Stop method of fiber, called by OpenNMS when fiber execution is to finish. Its purpose is to clean everything up, e.g. close any JNDI or database connections, before the fiber's execution is ended.

resume

void resume()

Resume method of fiber, called by OpenNMS to start the fiber up from a paused state.

pause

void pause()

Pause method of fiber, called by OpenNMS to put the fiber in a suspended state until it can be later resumed.

getName

String getName()

Returns the Log category name

Returns:

a String object.

getStatus

int getStatus()

lets OpenNMS know what state the daemon is in

Returns:

a int.

onEvent

void onEvent(Event event)

The OpenNMS event listener runs this routine when a new event is detected. This can be run on any event but only needs to run on uei.opennms.org/vacuumd/alarmListChanged

Parameters:

event - a Event object.

registerListener

void registerListener()

Registers an OpenNMS event listener with this class. When an event occurs, OpenNMS will call the onEvent() method of this object.

unregisterListener

void unregisterListener()

Stops OpenNMS calling the onEvent method of this object when an event occurs.

getStats

String getStats()

not used but needed for initialisation

Returns:

stats

sendAlarms

void sendAlarms()

A method to request an alarm list from the OpenNMS database and send the "unacked" alarms to the remote AlarmMonitor bean