Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.autoinventory
Class ScanConfigurationCore

java.lang.Object
  extended by org.hyperic.hq.autoinventory.ScanConfigurationCore
All Implemented Interfaces:
java.io.Serializable

public class ScanConfigurationCore
extends java.lang.Object
implements java.io.Serializable

This class just encapsulates the "raw data" part of the scan configuration, without any utility methods or other flim-flam. It exists to make it easy to move scan configurations across SOAP and other network transports.

See Also:
Serialized Form

Constructor Summary
ScanConfigurationCore()
           
 
Method Summary
 void addScanMethodConfig(ScanMethod method, ConfigResponse configResponse)
           
static ScanConfigurationCore decode(java.lang.String data)
           
static ScanConfigurationCore deserialize(byte[] data)
           
 java.lang.String encode()
           
 boolean equals(java.lang.Object o)
           
 ScanMethodConfig findScanMethodConfig(ScanMethod method)
           
 ScanMethodConfig findScanMethodConfig(java.lang.String methodClass)
           
static ScanConfigurationCore fromAgentRemoteValue(java.lang.String keyName, AgentRemoteValue arv)
          Read the contents of an AgentRemoteValue object and create a scan configuration.
 ConfigResponse getConfigResponse()
           
 ScanMethodConfig[] getScanMethodConfigs()
          Get the scan method configs to use in this scan.
 ServerSignature[] getServerSignatures()
          Get the server signatures to scan for in this scan.
 byte[] serialize()
           
 void setConfigResponse(ConfigResponse configResponse)
           
 void setScanMethodConfigs(ScanMethodConfig[] configs)
          Set the scan method configs to use in this scan.
 void setServerSignatures(ScanMethodConfig[] configs)
          Set the scan method configurations for this scan.
 void setServerSignatures(ServerSignature[] serverSigs)
          Set the server signatures to scan for in this scan.
 void toAgentRemoteValue(java.lang.String keyName, AgentRemoteValue arv)
          Write the contents of this scan configuration to an AgentRemoteValue object.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScanConfigurationCore

public ScanConfigurationCore()
Method Detail

getScanMethodConfigs

public ScanMethodConfig[] getScanMethodConfigs()
Get the scan method configs to use in this scan.

Returns:
An array of ScanMethodConfig objects.

setScanMethodConfigs

public void setScanMethodConfigs(ScanMethodConfig[] configs)
Set the scan method configs to use in this scan.

Parameters:
configs - An array of ScanMethodConfig objects.

addScanMethodConfig

public void addScanMethodConfig(ScanMethod method,
                                ConfigResponse configResponse)

setServerSignatures

public void setServerSignatures(ScanMethodConfig[] configs)
Set the scan method configurations for this scan.

Parameters:
serverTypes - An array of ScanMethodConfig objects.

getServerSignatures

public ServerSignature[] getServerSignatures()
Get the server signatures to scan for in this scan.

Returns:
An array of ServerSignature objects indicating which servers to scan for.

setServerSignatures

public void setServerSignatures(ServerSignature[] serverSigs)
Set the server signatures to scan for in this scan.

Parameters:
serverTypes - An array of ServerSignature objects indicating which server types to scan for.

findScanMethodConfig

public ScanMethodConfig findScanMethodConfig(ScanMethod method)

findScanMethodConfig

public ScanMethodConfig findScanMethodConfig(java.lang.String methodClass)

serialize

public byte[] serialize()
                 throws AutoinventoryException
Throws:
AutoinventoryException

encode

public java.lang.String encode()
                        throws AutoinventoryException
Throws:
AutoinventoryException

deserialize

public static ScanConfigurationCore deserialize(byte[] data)
                                         throws AutoinventoryException
Throws:
AutoinventoryException

decode

public static ScanConfigurationCore decode(java.lang.String data)
                                    throws AutoinventoryException
Throws:
AutoinventoryException

toAgentRemoteValue

public void toAgentRemoteValue(java.lang.String keyName,
                               AgentRemoteValue arv)
                        throws AutoinventoryException
Write the contents of this scan configuration to an AgentRemoteValue object.

Parameters:
keyName - The key name to use when populating the AgentRemoteValue with data.
arv - The AgentRemoteValue to write.
Throws:
AutoinventoryException - If a problem occurs populating the AgentRemoteValue with data.

fromAgentRemoteValue

public static ScanConfigurationCore fromAgentRemoteValue(java.lang.String keyName,
                                                         AgentRemoteValue arv)
                                                  throws AutoinventoryException
Read the contents of an AgentRemoteValue object and create a scan configuration.

Parameters:
keyName - The key name to use when reading data from the AgentRemoteValue.
arv - The AgentRemoteValue to read.
Returns:
A ScanConfiguration object read from the AgentRemoteValue.
Throws:
AutoinventoryException - If a problem occurs reading data from the AgentRemoteValue.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

getConfigResponse

public ConfigResponse getConfigResponse()

setConfigResponse

public void setConfigResponse(ConfigResponse configResponse)

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.