org.aselect.system.sam.agent
Interface ISAMPollingMethod

All Known Implementing Classes:
SAMAPIPollingMethod, SAMICMPPollingMethod

public interface ISAMPollingMethod

The interface for polling methods.

Description:
The interface for polling methods that can be used by the SAMAgent .
Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 void init(java.lang.Object oResourceConfigSection, java.lang.Object oPollingMethodConfigSection, ConfigManager oConfigManager, SystemLogger oSystemLogger)
          Initialization method for the SAM polling methods.
 boolean poll()
          Will poll a resource.
 

Method Detail

init

void init(java.lang.Object oResourceConfigSection,
          java.lang.Object oPollingMethodConfigSection,
          ConfigManager oConfigManager,
          SystemLogger oSystemLogger)
          throws ASelectSAMException
Initialization method for the SAM polling methods.

Description:
Reads the configuration used by the polling method.

Concurrency issues:
-

Preconditions:
-

Postconditions:
-

Parameters:
oResourceConfigSection - the config section of the resource which has to be polled
oPollingMethodConfigSection - The config section of the polling method config section
oConfigManager - The config manager used to resolve the configuration
oSystemLogger - the logger used for system logging
Throws:
ASelectSAMException - if the poller could not be initialized

poll

boolean poll()
Will poll a resource.

Description:
Checks the availability of the resource by the configured interval.

Concurrency issues:
-

Preconditions:
-

Postconditions:
-

Returns:
TRUE if the resource is available, FALSE if the resource is unavailable.


Copyright © 2008 SURFnet BV. All Rights Reserved.