org.thales.punch.platform.api

Interface IResolver

All Known Implementing Classes:

ResolverImpl

public interface IResolver

The IResolver is in charge of resolving sone logical addresses, i.e. the one from an elasticsearch or kafka cluster, into a detailed list of node ip, port and other security or advanced settings.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
ISettingsMap	resolve(File file, String runtime) Resolve the provided file.
ISettingsMap	resolve(ISettingsMap input, ISettingsMap fileMetaInfo, String fileName) Resolve the provided input without matching any rule to only resolve tags and environment variables.
ISettingsMap	resolve(ISettingsMap settings, String runtime, String fileName) Resolve the provided settings map.

Method Detail

resolve

ISettingsMap resolve(ISettingsMap settings,
                     String runtime,
                     String fileName)
              throws InvalidResolverKeyConfigurationException,
                     ConfigurationException

Resolve the provided settings map.

Parameters:

settings - the input settings.

runtime - runtime.

fileName - the configuration file name to be enriched

Returns:

the resolved one

Throws:

ConfigurationException

InvalidResolverKeyConfigurationException

resolve

ISettingsMap resolve(File file,
                     String runtime)
              throws IOException,
                     InvalidResolverKeyConfigurationException,
                     ConfigurationException

Resolve the provided file.

Parameters:

file - your input file

runtime - runtime

Returns:

the resolved settings map

Throws:

IOException - if it cannot be read

InvalidResolverKeyConfigurationException

ConfigurationException

resolve

ISettingsMap resolve(ISettingsMap input,
                     ISettingsMap fileMetaInfo,
                     String fileName)
              throws InvalidResolverKeyConfigurationException,
                     ConfigurationException

Resolve the provided input without matching any rule to only resolve tags and environment variables. Use it with precaution.

Parameters:

file - your input file

fileMetaInfo - meta info about file (tenant, channel, runtime)

fileName - the configuration file name to be enriched

Returns:

the resolved settings map

Throws:

ConfigurationException

InvalidResolverKeyConfigurationException