org.openoss.opennms.spring.qosd
Interface AlarmListConnectionManager

All Known Implementing Classes:

AlarmListConnectionManagerJ2eeImpl, AlarmListConnectionManagerSpringImpl, AlarmListJ2eeConnectionManagerThread

public interface AlarmListConnectionManager

AlarmListConnectionManager interface.

Version:

$Id: $

Author:

ranger

Field Summary

static int	CONNECTED Constant CONNECTED=0
static int	DISCONNECTED Constant DISCONNECTED=1
static int	REBUILD Constant REBUILD=2
static int	SEND Constant SEND=0
static int	SENT Constant SENT=1
static int	STOP Constant STOP=2

Method Summary

int	getStatus() returns the threads current status states for status: CONNECTED = 0; DISCONNECTED = 1; STOP = 2;
void	init(PropertiesLoader props, Properties env) Initialises the ConnectionManagerThread
void	kill() Stops the ConnectionManagerThread
javax.oss.fm.monitor.AlarmValue	makeAlarmValue() Makes a new empty alarm value object NOTE THIS IS A PATCH to proxy for JVTAlarmMonitorSession.makeAlarmValue()
javax.oss.fm.monitor.AlarmValue	makeAlarmValueFromSpec() Makes a new alarm value object pre-populated with internal objects which have been made from a local invarient specification.
void	reset_list(String _rebuilt_message) this method resets the alarm list in the AlarmMonitorBean and causes an alarmlist rebuilt event to be sent.
void	run() Starts the ConnectionManagerThread
void	send(Hashtable<AlarmKey,AlarmValue> alarmList) Sends the AlarmList to the AlarmMonitorBean
void	setApplicationContext(org.springframework.context.support.ClassPathXmlApplicationContext m_context) Used by jmx mbean QoSD to pass in Spring Application context
void	start() Causes the thread supporting the connection Manager to start

Field Detail

CONNECTED

static final int CONNECTED

Constant CONNECTED=0

See Also:

Constant Field Values

DISCONNECTED

static final int DISCONNECTED

Constant DISCONNECTED=1

See Also:

Constant Field Values

STOP

static final int STOP

Constant STOP=2

See Also:

Constant Field Values

SEND

static final int SEND

Constant SEND=0

See Also:

Constant Field Values

SENT

static final int SENT

Constant SENT=1

See Also:

Constant Field Values

REBUILD

static final int REBUILD

Constant REBUILD=2

See Also:

Constant Field Values

Method Detail

reset_list

void reset_list(String _rebuilt_message)

this method resets the alarm list in the AlarmMonitorBean and causes an alarmlist rebuilt event to be sent.

Parameters:

_rebuilt_message - message to include in the NotifyAlarmListRebuiltEvent

send

void send(Hashtable<AlarmKey,AlarmValue> alarmList)

Sends the AlarmList to the AlarmMonitorBean

Parameters:

alarmList - a Hashtable object.

run

void run()
         throws IllegalStateException

Starts the ConnectionManagerThread

Throws:

IllegalStateException - if any.

init

void init(PropertiesLoader props,
          Properties env)

Initialises the ConnectionManagerThread

Parameters:

props - The PropertiesLoader method which reads the Qosd.properties file

env - the returned properties for setting up the connections to the AlarmMonitorBean

kill

void kill()

Stops the ConnectionManagerThread

getStatus

int getStatus()

returns the threads current status states for status: CONNECTED = 0; DISCONNECTED = 1; STOP = 2;

Returns:

a int.

start

void start()

Causes the thread supporting the connection Manager to start

makeAlarmValue

javax.oss.fm.monitor.AlarmValue makeAlarmValue()

Makes a new empty alarm value object NOTE THIS IS A PATCH to proxy for JVTAlarmMonitorSession.makeAlarmValue()

Returns:

a javax$oss$fm$monitor$AlarmValue object.

makeAlarmValueFromSpec

javax.oss.fm.monitor.AlarmValue makeAlarmValueFromSpec()

Makes a new alarm value object pre-populated with internal objects which have been made from a local invarient specification. NOTE THIS IS A PATCH to proxy for JVTAlarmMonitorSession

Returns:

a javax$oss$fm$monitor$AlarmValue 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