Package net.solarnetwork.domain

Class BasicIdentifiableConfiguration

java.lang.Object
net.solarnetwork.domain.BasicIdentifiableConfiguration
All Implemented Interfaces:
Serializable, IdentifiableConfiguration
public class BasicIdentifiableConfiguration extends Object implements IdentifiableConfiguration, Serializable
Basic implementation of IdentifiableConfiguration.
Since:
1.42
Version:
1.2
Author:
matt
See Also:

  • Constructor Details

    • BasicIdentifiableConfiguration

      public BasicIdentifiableConfiguration()
      Default constructor.

    • BasicIdentifiableConfiguration

      public BasicIdentifiableConfiguration(IdentifiableConfiguration other)
      Copy constructor.
      Parameters:
      other - the configuration to copy

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getName

      public String getName()
      Get a name for this configuration

      This is meant to be configurable by end users.

      Specified by:
      getName in interface IdentifiableConfiguration
      Returns:
      the configuration name

    • setName

      public void setName(String name)
      Set the configuration name.
      Parameters:
      name - the name to use

    • getServiceIdentifier

      public String getServiceIdentifier()
      Get the unique identifier for the service this configuration is associated with.
      Specified by:
      getServiceIdentifier in interface IdentifiableConfiguration
      Returns:
      the identifier of the service

    • setServiceIdentifier

      public void setServiceIdentifier(String serviceIdentifier)
      Set the unique identifier for the service this configuration is associated with.
      Parameters:
      serviceIdentifier - the identifier of the service to use

    • getServiceProperties

      public Map<String,?> getServiceProperties()
      Description copied from interface: IdentifiableConfiguration
      Get a map of properties to pass to the service in order to perform actions.

      It is expected this map would contain user-supplied runtime configuration such as credentials to use, host name, etc.

      Specified by:
      getServiceProperties in interface IdentifiableConfiguration
      Returns:
      the runtime properties to pass to the service

    • getServiceProps

      public Map<String,Object> getServiceProps()
      Get the service properties.
      Returns:
      the properties

    • setServiceProps

      public void setServiceProps(Map<String,Object> serviceProps)
      Set the service properties.
      Parameters:
      serviceProps - the properties to set