Package org.infinispan.commons.configuration

Interface BasicConfiguration

All Known Implementing Classes:
Configuration, StringConfiguration, XMLStringConfiguration
public interface BasicConfiguration
BasicConfiguration provides the basis for concrete configurations.
Since:
9.2
Author:
Tristan Tarrant

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    toStringConfiguration(String name)
    Converts this configuration to an XML.
    String
    toStringConfiguration(String name, MediaType mediaType, boolean clearTextSecrets)
    Converts this configuration to a string representation.
    default String
    toXMLString()
    Deprecated, for removal: This API element is subject to removal in a future version.
    default String
    toXMLString(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • toXMLString

      @Deprecated(forRemoval=true) default String toXMLString()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • toXMLString

      @Deprecated(forRemoval=true) default String toXMLString(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Converts this configuration to its XML representation. The name of the configuration in the XML will be the one supplied in the argument.
      Returns:
      a String containing the XML representation of an Infinispan configuration using the Infinispan schema.

    • toStringConfiguration

      default String toStringConfiguration(String name)
      Converts this configuration to an XML.
      Parameters:
      name - The name of the configuration in the generated string.
      Returns:
      a String containing the representation of an Infinispan configuration using the Infinispan schema in XML.

    • toStringConfiguration

      String toStringConfiguration(String name, MediaType mediaType, boolean clearTextSecrets)
      Converts this configuration to a string representation.
      Parameters:
      name - The name of the configuration in the generated string.
      mediaType - The type of string to generate. Can be one of XML, JSON or YAML.
      clearTextSecrets - Whether secrets (e.g. passwords) should be included in clear text or masked.
      Returns:
      a String containing the representation of an Infinispan configuration using the Infinispan schema in one of the supported formats (XML, JSON, YAML).