org.thales.punch.libraries.utils.api

Class UtilVersion

java.lang.Object

org.thales.punch.libraries.utils.api.UtilVersion

public class UtilVersion
extends Object

Properly dealing with version number and backward compatibility issues.

The punch use "6.0" two digits version identifiers. We do not expect to have tons of them.

This class also provide generic conversion and checking method to deal with missing properties and backward compatibility.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	boltConvertor5xTo6x
static Map<String,String>	spoutConvertor5xTo6x
static Integer	V5
static Integer	V6

Method Summary

Modifier and Type	Method and Description
static ISettingsMap	channelStructure5To6(ISettingsMap channelStructure)
static ISettingsMap	checkAndConvertChannelStructure(ISettingsMap structure) Check the channel structure format and return this version compatible format.
static ISettingsMap	checkAndConvertPlan(ISettingsMap settings)
static ISettingsMap	checkAndConvertPlan(ISettingsMap plan, String tenantName, String channelName, String punchlineName)
static ISettingsMap	checkAndConvertPunchline(ISettingsMap settings) This function expects a plan, a channel structure or a punchline file.
static ISettingsMap	checkAndConvertPunchline(ISettingsMap punchline, String tenantName, String channelName, String punchlineName)
static boolean	isVersionGte(ISettingsMap settings, int major) Check if a punchline, plan channel structure or whatever json file is of a major version greater than what you expect.
static void	warnDeprecated(String componentType, String deprecatedField, String newField)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

V5

public static final Integer V5

V6

public static final Integer V6

spoutConvertor5xTo6x

public static Map<String,String> spoutConvertor5xTo6x

boltConvertor5xTo6x

public static Map<String,String> boltConvertor5xTo6x

Method Detail

isVersionGte

public static boolean isVersionGte(ISettingsMap settings,
                                   int major)

Check if a punchline, plan channel structure or whatever json file is of a major version greater than what you expect.

Parameters:

major - the major version number.

Returns:

true if the file version is of version greater than or equal to what you provide

channelStructure5To6

public static ISettingsMap channelStructure5To6(ISettingsMap channelStructure)

checkAndConvertPunchline

public static ISettingsMap checkAndConvertPunchline(ISettingsMap settings)

This function expects a plan, a channel structure or a punchline file. If there is in there a version string greater or equal to 6.x, nothing is changed but for adding the default channel or tenant.

Otherwise it converts the old style plan, pml or topology settings map to the new format.

Parameters:

settings -

Returns:

the converted settings

checkAndConvertPlan

public static ISettingsMap checkAndConvertPlan(ISettingsMap settings)

Parameters:

settings -

Returns:

the updated plan

checkAndConvertChannelStructure

public static ISettingsMap checkAndConvertChannelStructure(ISettingsMap structure)

Check the channel structure format and return this version compatible format.

Parameters:

structure -

Returns:

the updated structure.

checkAndConvertPunchline

public static ISettingsMap checkAndConvertPunchline(ISettingsMap punchline,
                                                    String tenantName,
                                                    String channelName,
                                                    String punchlineName)

checkAndConvertPlan

public static ISettingsMap checkAndConvertPlan(ISettingsMap plan,
                                               String tenantName,
                                               String channelName,
                                               String punchlineName)

warnDeprecated

public static void warnDeprecated(String componentType,
                                  String deprecatedField,
                                  String newField)