org.opennms.netmgt.poller.pollables

Interface PollContext

All Known Implementing Classes:

DefaultPollContext

public interface PollContext

Represents a PollContext

Version:

$Id: $

Author:

Mathew Brozowski

Method Summary

Modifier and Type	Method and Description
Event	createEvent(String uei, int nodeId, InetAddress address, String svcName, Date date, String reason) createEvent
String	getCriticalServiceName() getCriticalServiceName
boolean	isNodeProcessingEnabled() isNodeProcessingEnabled
boolean	isPollingAllIfCritServiceUndefined() isPollingAllIfCritServiceUndefined
boolean	isServiceUnresponsiveEnabled() isServiceUnresponsiveEnabled
void	openOutage(PollableService pSvc, PollEvent svcLostEvent) openOutage
void	resolveOutage(PollableService pSvc, PollEvent svcRegainEvent) resolveOutage
PollEvent	sendEvent(Event event) sendEvent
void	trackPoll(PollableService service, PollStatus result)

Method Detail

getCriticalServiceName

String getCriticalServiceName()

getCriticalServiceName

Returns:

a String object.

isNodeProcessingEnabled

boolean isNodeProcessingEnabled()

isNodeProcessingEnabled

Returns:

a boolean.

isPollingAllIfCritServiceUndefined

boolean isPollingAllIfCritServiceUndefined()

isPollingAllIfCritServiceUndefined

Returns:

a boolean.

sendEvent

PollEvent sendEvent(Event event)

sendEvent

Parameters:

event - the event to send

Returns:

the same event

createEvent

Event createEvent(String uei,
                  int nodeId,
                  InetAddress address,
                  String svcName,
                  Date date,
                  String reason)

createEvent

Parameters:

uei - a String object.

nodeId - a int.

address - a InetAddress object.

svcName - a String object.

date - a Date object.

reason - a String object.

Returns:

a Event object.

openOutage

void openOutage(PollableService pSvc,
                PollEvent svcLostEvent)

openOutage

Parameters:

pSvc - a PollableService object.

svcLostEvent - a PollEvent object.

resolveOutage

void resolveOutage(PollableService pSvc,
                   PollEvent svcRegainEvent)

resolveOutage

Parameters:

pSvc - a PollableService object.

svcRegainEvent - a PollEvent object.

isServiceUnresponsiveEnabled

boolean isServiceUnresponsiveEnabled()

isServiceUnresponsiveEnabled

Returns:

a boolean.

trackPoll

void trackPoll(PollableService service,
               PollStatus result)