Package org.sentrysoftware.metricshub.engine.strategy.detection

Class CriterionProcessor

java.lang.Object

org.sentrysoftware.metricshub.engine.strategy.detection.CriterionProcessor

All Implemented Interfaces:

ICriterionProcessor

public class CriterionProcessor
extends Object
implements ICriterionProcessor

The `CriterionProcessor` class is responsible for processing various criteria, facilitating detection operations related to different aspects such as IPMI, HTTP, SNMP, etc.

This class integrates with ClientsExecutor and TelemetryManager to execute criterion-specific tests and log relevant information. It also utilizes a WqlDetectionHelper for Windows Management Instrumentation (WMI) queries.

The class includes methods for processing different types of criteria, such as IpmiCriterion, HttpCriterion, DeviceTypeCriterion.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CriterionProcessor.TestResult	A test result class containing a message, success status, and CSV table.

Constructor Summary

Constructors

Constructor	Description
CriterionProcessor(ClientsExecutor clientsExecutor, TelemetryManager telemetryManager, String connectorId)	Constructor for the CriterionProcessor class.

Method Summary

Modifier and Type	Method	Description
String	buildIpmiCommand(DeviceKind hostType, String hostname, SshConfiguration sshConfiguration, OsCommandConfiguration osCommandConfiguration, int defaultTimeout)	Check the OS type and version and build the correct IPMI command.
String	getIpmiCommandForSolaris(String ipmitoolCommand, String hostname, String solarisOsVersion)	Get IPMI command based on Solaris version.
boolean	isDeviceKindIncluded(List<DeviceKind> deviceKindList, DeviceTypeCriterion deviceTypeCriterion)	Return true if the deviceKind in the deviceKindList is included in the DeviceTypeCriterion detection.
CriterionTestResult	process(DeviceTypeCriterion deviceTypeCriterion)	Process the given DeviceTypeCriterion and return the CriterionTestResult
CriterionTestResult	process(HttpCriterion httpCriterion)	Process the given HttpCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(IpmiCriterion ipmiCriterion)	Process the given IpmiCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(OsCommandCriterion osCommandCriterion)	Process the given OsCommandCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(ProcessCriterion processCriterion)	Process the given ProcessCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(ProductRequirementsCriterion productRequirementsCriterion)	Process the given ProductRequirementsCriterion and return the CriterionTestResult.
CriterionTestResult	process(ServiceCriterion serviceCriterion)	Process the given ServiceCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(SnmpGetCriterion snmpGetCriterion)	Process the given SnmpGetCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(SnmpGetNextCriterion snmpGetNextCriterion)	Process the given SnmpGetNextCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(WbemCriterion wbemCriterion)	Process the given WbemCriterion through Client and return the CriterionTestResult
CriterionTestResult	process(WmiCriterion wmiCriterion)	Process the given WmiCriterion through Client and return the CriterionTestResult

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CriterionProcessor

public CriterionProcessor(ClientsExecutor clientsExecutor,
 TelemetryManager telemetryManager,
 String connectorId)

Constructor for the CriterionProcessor class.

Parameters:

clientsExecutor - The ClientsExecutor instance.

telemetryManager - The TelemetryManager instance.

connectorId - The connector ID.

Method Details

process

public CriterionTestResult process(DeviceTypeCriterion deviceTypeCriterion)

Process the given DeviceTypeCriterion and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

deviceTypeCriterion - The DeviceTypeCriterion to process.

Returns:

New CriterionTestResult instance.

isDeviceKindIncluded

public boolean isDeviceKindIncluded(List<DeviceKind> deviceKindList,
 DeviceTypeCriterion deviceTypeCriterion)

Return true if the deviceKind in the deviceKindList is included in the DeviceTypeCriterion detection.

Parameters:

deviceKindList - The list of DeviceKind values to check.

deviceTypeCriterion - The DeviceTypeCriterion for detection.

Returns:

True if the deviceKind in the deviceKindList is included; otherwise, false.

process

public CriterionTestResult process(HttpCriterion httpCriterion)

Process the given HttpCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

httpCriterion - The HTTP criterion to process.

Returns:

New CriterionTestResult instance.

process

public CriterionTestResult process(IpmiCriterion ipmiCriterion)

Process the given IpmiCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

ipmiCriterion - The IPMI criterion to process.

Returns:

CriterionTestResult instance.

buildIpmiCommand

public String buildIpmiCommand(DeviceKind hostType,
 String hostname,
 SshConfiguration sshConfiguration,
 OsCommandConfiguration osCommandConfiguration,
 int defaultTimeout)

Check the OS type and version and build the correct IPMI command. If the process fails, return the corresponding error.

Parameters:

hostType - The type of the host.

hostname - The hostname.

sshConfiguration - The SSH configuration.

osCommandConfiguration - The OS command configuration.

defaultTimeout - The default timeout.

Returns:

String : The IPMI Command.

getIpmiCommandForSolaris

public String getIpmiCommandForSolaris(String ipmitoolCommand,
 String hostname,
 String solarisOsVersion)
                                throws IpmiCommandForSolarisException

Get IPMI command based on Solaris version. If version == 9, then use 'lipmi'. If version > 9, then use 'bmc'. Otherwise, return an error.

Parameters:

ipmitoolCommand - The base IPMI tool command.

hostname - The hostname.

solarisOsVersion - The Solaris OS version.

Returns:

String : IPMI command for Solaris.

Throws:

IpmiCommandForSolarisException - If an error occurs while determining the IPMI command.

process

public CriterionTestResult process(OsCommandCriterion osCommandCriterion)

Process the given OsCommandCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

osCommandCriterion - The OsCommandCriterion to process.

Returns:

CriterionTestResult instance.

process

public CriterionTestResult process(ProcessCriterion processCriterion)

Process the given ProcessCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

processCriterion - The ProcessCriterion to process.

Returns:

CriterionTestResult instance.

process

public CriterionTestResult process(ProductRequirementsCriterion productRequirementsCriterion)

Process the given ProductRequirementsCriterion and return the CriterionTestResult.

Specified by:

process in interface ICriterionProcessor

Parameters:

productRequirementsCriterion - The ProductRequirementsCriterion to process.

Returns:

CriterionTestResult instance.

process

public CriterionTestResult process(ServiceCriterion serviceCriterion)

Process the given ServiceCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

serviceCriterion - The ServiceCriterion to process.

Returns:

CriterionTestResult instance.

process

public CriterionTestResult process(SnmpGetCriterion snmpGetCriterion)

Process the given SnmpGetCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

snmpGetCriterion - The SNMP Get criterion to process.

Returns:

The result of the criterion test.

process

public CriterionTestResult process(SnmpGetNextCriterion snmpGetNextCriterion)

Process the given SnmpGetNextCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

snmpGetNextCriterion - The SNMP GetNext criterion to process.

Returns:

The result of the criterion test.

process

public CriterionTestResult process(WmiCriterion wmiCriterion)

Process the given WmiCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

wmiCriterion - The WMI criterion to process.

Returns:

The result of the criterion test processing.

process

public CriterionTestResult process(WbemCriterion wbemCriterion)

Process the given WbemCriterion through Client and return the CriterionTestResult

Specified by:

process in interface ICriterionProcessor

Parameters:

wbemCriterion - The WBEM criterion to process.

Returns:

The result of the criterion test processing.