Package com.centralnicreseller.apiconnector

Class ResponseTemplateManager

java.lang.Object

com.centralnicreseller.apiconnector.ResponseTemplateManager

public final class ResponseTemplateManager
extends Object

ResponseTemplateManager covers functionality to manage response TEMPLATES_DATA.

Since:

2.0

Version:

%I%, %G%

Author:

Kai Schwarz

Method Summary

Modifier and Type	Method	Description
static Class<ResponseTemplateManager>	addTemplate(String id, String plain)	Add a response template to the template container.
static Class<ResponseTemplateManager>	addTemplate(String id, String code, String descr)	Add a response template to the template container.
static String	generateTemplate(String code, String description)	Generate API response template string for a given code and description.
static Response	getTemplate(String id)	Get a response template instance from the template container.
static Map<String,Response>	getTemplates()	Return all available response TEMPLATES_DATA.
static Map<String,String>	getTemplatesMap()	Retrieves a copy of the current API response templates map.
static boolean	hasTemplate(String id)	Check if a given template exists in the template container.
static boolean	isTemplateMatchHash(Map<String,Object> tpl2, String id)	Check if a given API response hash matches a given template by code and description.
static boolean	isTemplateMatchPlain(String plain, String id)	Check if a given API plain response matches a given template by code and description.

Methods inherited from class java.lang.Object

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

Method Details

generateTemplate

public static String generateTemplate(String code,
 String description)

Generate API response template string for a given code and description.

Parameters:

code - API response code.

description - API response description.

Returns:

Generated response template string.

addTemplate

public static Class<ResponseTemplateManager> addTemplate(String id,
 String plain)

Add a response template to the template container.

Parameters:

id - Template ID.

plain - API plain response.

Returns:

ResponseTemplateManager class for method chaining.

addTemplate

public static Class<ResponseTemplateManager> addTemplate(String id,
 String code,
 String descr)

Add a response template to the template container.

Parameters:

id - Template ID.

code - Data provided for generating a new template to use.

descr - Data provided for generating a new template to use.

Returns:

ResponseTemplateManager class for method chaining.

getTemplate

public static Response getTemplate(String id)

Get a response template instance from the template container.

Parameters:

id - Template ID.

Returns:

Template instance.

getTemplates

public static Map<String,Response> getTemplates()

Return all available response TEMPLATES_DATA.

Returns:

All available response template instances.

hasTemplate

public static boolean hasTemplate(String id)

Check if a given template exists in the template container.

Parameters:

id - Template ID.

Returns:

Boolean result.

isTemplateMatchHash

public static boolean isTemplateMatchHash(Map<String,Object> tpl2,
 String id)

Check if a given API response hash matches a given template by code and description.

Parameters:

tpl2 - API response hash.

id - Template ID.

Returns:

Boolean result.

isTemplateMatchPlain

public static boolean isTemplateMatchPlain(String plain,
 String id)

Check if a given API plain response matches a given template by code and description.

Parameters:

plain - API plain response.

id - Template ID.

Returns:

Boolean result.

getTemplatesMap

public static Map<String,String> getTemplatesMap()

Retrieves a copy of the current API response templates map.

This method returns a new HashMap containing the entries from the TEMPLATES_DATA map. The returned map is a shallow copy, meaning modifications to the returned map will not affect the original TEMPLATES_DATA map.

Returns:

A new Map containing the API response templates. The map's keys are template identifiers, and the values are the corresponding response template strings.