org.opennms.netmgt.notifd

Class NotificationTask

java.lang.Object

java.lang.Thread

org.opennms.netmgt.notifd.NotificationTask

All Implemented Interfaces:

Runnable

public class NotificationTask
extends Thread

This class holds all the data and logic for sending out a notification Each notification that is sent will be accompanied by a row in the notifications table. All notifications in a group will be identified with a common groupId number.

Author:

Jason Johns , OpenNMS , Jeff Gehlbach Modification to pick an ExecuteStrategy based on the "binary" flag in notificationCommands.xml by:, David Hustace

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
NotificationTask(NotificationManager notificationManager, UserManager userManager, long sendTime, Map<String,String> someParams, List<NotificationTask> siblings, String autoNotify) Constructor, initializes some information

Method Summary

Modifier and Type	Method and Description
Command[]	getCommands() getCommands
String	getEmail() getEmail
int	getNotifyId() Returns the unique id used to insert the row in the database for this notification task.
long	getSendTime() getSendTime
String	getTuiPin() getTuiPin
User	getUser() getUser
boolean	isStarted() isStarted
void	run() run
void	setAutoNotify(String autoNotify) Sets the autoNotify info for the usersnotified table
void	setCommands(Command[] commands) This method will construct the command that will be issued to send the actual page.
void	setNoticeId(int anId) Sets the group id that will be inserted into the row in notifications table
void	setUser(User aUser) Sets the user that the page needs to be sent to.
void	start() start
String	toString() toString

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationTask

public NotificationTask(NotificationManager notificationManager,
                        UserManager userManager,
                        long sendTime,
                        Map<String,String> someParams,
                        List<NotificationTask> siblings,
                        String autoNotify)

Constructor, initializes some information

Parameters:

someParams - the parameters from Notify

notificationManager - a NotificationManager object.

userManager - a UserManager object.

sendTime - a long.

siblings - a List object.

autoNotify - a String object.

Method Detail

toString

public String toString()

toString

Overrides:

toString in class Thread

Returns:

a String object.

getSendTime

public long getSendTime()

getSendTime

Returns:

a long.

getNotifyId

public int getNotifyId()

Returns the unique id used to insert the row in the database for this notification task.

Returns:

int, the id of the row in notifications table

setUser

public void setUser(User aUser)

Sets the user that the page needs to be sent to.

Parameters:

aUser - the user info

getUser

public User getUser()

getUser

Returns:

a User object.

setAutoNotify

public void setAutoNotify(String autoNotify)

Sets the autoNotify info for the usersnotified table

Parameters:

autoNotify - a String object.

setNoticeId

public void setNoticeId(int anId)

Sets the group id that will be inserted into the row in notifications table

Parameters:

anId - the group id to set for the row

setCommands

public void setCommands(Command[] commands)

This method will construct the command that will be issued to send the actual page.

Parameters:

commands - the commands to call at the console.

getCommands

public Command[] getCommands()

getCommands

Returns:

an array of Command objects.

run

public void run()

run

Specified by:

run in interface Runnable

Overrides:

run in class Thread

getEmail

public String getEmail()
                throws IOException,
                       org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException

getEmail

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getTuiPin

public String getTuiPin()
                 throws org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException,
                        IOException

getTuiPin

Returns:

a String object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.

start

public void start()

start

Overrides:

start in class Thread

isStarted

public boolean isStarted()

isStarted

Returns:

a boolean.