Interface AppConfiguration

All Known Implementing Classes:
SimpleAppConfiguration

public interface AppConfiguration
API for common application configuration elements.
Since:
1.35
  • Field Details

    • SOLARUSER_SERVICE_NAME

      static final String SOLARUSER_SERVICE_NAME
      Service URL name for the SolarUser app.
      See Also:
    • SOLARQUERY_SERVICE_NAME

      static final String SOLARQUERY_SERVICE_NAME
      Service URL name for the SolarQuery app.
      See Also:
    • SOALRNODE_DASHBAORD_SERVICE_NAME

      static final String SOALRNODE_DASHBAORD_SERVICE_NAME
      Service URL name for a user-facing "dashboard" specific to a single SolarNode.

      This URL can reasonably be expected to support a nodeId variable.

      See Also:
    • SOLARNDOE_DATAVIEW_SERVICE_NAME

      static final String SOLARNDOE_DATAVIEW_SERVICE_NAME
      Service URL name for a user-facing "dashboard" specific to a single SolarNode.

      This URL can reasonably be expected to support a nodeId variable.

      See Also:
  • Method Details

    • getServiceUrls

      Map<String,String> getServiceUrls()
      Get a mapping of named service URLs.

      The keys of the returned maps represent logical names for the associated URL values. The keys will be application-dependent, and should include values for well-defined application services. For example a URL to the application terms of service might be included under a key tos.

      URL values are permitted to contain variables in the form {var} that consumers of the URLs can replace with appropriate values. The variable names must be named so their intended use is obvious, for example nodeId for a SolarNode ID.

      Some common service URL names are defined as constants on this interface. Implementations are recommended to use these keys when it makes sense, and to add any other values needed by the application.

      Returns:
      named service URLs, never null