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	toStringConfiguration(String name, MediaType mediaType, boolean clearTextSecrets, ConfigurationSchemaVersion target)	Serializes this configuration as XML, omitting any element or attribute whose since is newer than target, so the emitted document stays parseable by an older cluster member's parser.

Method Details

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).

toStringConfiguration

default String toStringConfiguration(String name,
 MediaType mediaType,
 boolean clearTextSecrets,
 ConfigurationSchemaVersion target)

Serializes this configuration as XML, omitting any element or attribute whose since is newer than target, so the emitted document stays parseable by an older cluster member's parser.

Parameters:

name - the name under which the cache configuration is emitted

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.

target - the schema version the emitted document must stay compatible with, null includes all.

Returns:

the serialized configuration, with newer members omitted