Package org.sentrysoftware.metricshub.engine.configuration

Interface IConfiguration

All Known Subinterfaces:
IWinConfiguration
public interface IConfiguration
This interface represents the generic configuration that's used and implemented by various protocol configurations like HttpConfiguration, IpmiConfiguration, etc ...

  • Method Summary

    Modifier and Type
    Method
    Description
    IConfiguration
    copy()
    Creates and returns a deep copy of the current IConfiguration instance.
    String
    getHostname()
    Retrieves the declared hostname of the IConfiguration.
    void
    setHostname(String hostname)
    Replaces the IConfiguration's hostname value by the hostname parameter's value.
    void
    validateConfiguration(String resourceKey)
    Validates the current configuration for the given configured resource key.

  • Method Details

    • getHostname

      String getHostname()
      Retrieves the declared hostname of the IConfiguration.
      Returns:
      the IConfiguration hostname value.

    • setHostname

      void setHostname(String hostname)
      Replaces the IConfiguration's hostname value by the hostname parameter's value.
      Parameters:
      hostname - the hostname of the local or remote device.

    • validateConfiguration

      void validateConfiguration(String resourceKey) throws InvalidConfigurationException
      Validates the current configuration for the given configured resource key. This method ensures that the configuration meets all required criteria. Criteria may include checking for necessary fields, verifying values against allowed ranges or formats, and ensuring compatibility with the resource's requirements.
      Parameters:
      resourceKey - A String representing the unique identifier for the resource used for logging purpose.
      Throws:
      InvalidConfigurationException - if the provided configuration does not meet the necessary criteria.

    • copy

      IConfiguration copy()
      Creates and returns a deep copy of the current IConfiguration instance. The returned instance will have the same attribute values as the original, but modifications to either instance will not affect the other.
      Returns:
      a new IConfiguration instance that is a deep copy of the original.