Package org.eclipse.ditto.wot.integration.config

Interface ToThingDescriptionConfig

@Immutable public interface ToThingDescriptionConfig
Provides configuration settings for WoT (Web of Things) integration regarding the Thing Description transformation from Thing Models.
Since:
2.4.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    ToThingDescriptionConfig.ConfigValue
    An enumeration of the known config path expressions and their associated default values for ToThingDescriptionConfig.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addCreated()
    Returns whether to add "created" to each TD reflecting the created timestamp of the Thing.
    boolean
    addModified()
    Returns whether to add "modified" to each TD reflecting the last modified timestamp of the Thing.
    String
    getBasePrefix()
    Returns the URI prefix of the WoT "base" to inject in generated TDs.
    org.eclipse.ditto.json.JsonObject
    getJsonTemplate()
    Returns the JSON object template to additionally add to generated WoT TDs, e.g.
    Map<String,org.eclipse.ditto.json.JsonValue>
    getPlaceholders()
    Returns the map containing placeholder constants to use in order to resolve WoT TM placeholders.

  • Method Details

    • getBasePrefix

      String getBasePrefix()
      Returns the URI prefix of the WoT "base" to inject in generated TDs. Will be prepended to "/api/2/things/<thing:id>.
      Returns:
      the URI prefix of the WoT "base" to inject in generated TDs.

    • getJsonTemplate

      org.eclipse.ditto.json.JsonObject getJsonTemplate()
      Returns the JSON object template to additionally add to generated WoT TDs, e.g. containing additional "securityDefinitions".
      Returns:
      the JSON object template to additionally add to generated WoT TDs.

    • getPlaceholders

      Map<String,org.eclipse.ditto.json.JsonValue> getPlaceholders()
      Returns the map containing placeholder constants to use in order to resolve WoT TM placeholders.
      Returns:
      the map containing placeholder constants to use in order to resolve WoT TM placeholders.

    • addCreated

      boolean addCreated()
      Returns whether to add "created" to each TD reflecting the created timestamp of the Thing.
      Returns:
      whether to add "created" to each TD.

    • addModified

      boolean addModified()
      Returns whether to add "modified" to each TD reflecting the last modified timestamp of the Thing.
      Returns:
      whether to add "modified" to each TD.