Package net.hexonet.apiconnector

Class ResponseTemplateManager

java.lang.Object

net.hexonet.apiconnector.ResponseTemplateManager

public final class ResponseTemplateManager
extends Object

ResponseTemplateManager covers functionality to manage response tempaltes

Since:

2.0

Version:

%I%, %G%

Author:

Kai Schwarz

Field Summary

Fields

Modifier and Type	Field	Description
static Map<String,String>	templates	backend system entity

Constructor Summary

Constructors

Constructor	Description
ResponseTemplateManager()

Method Summary

Modifier and Type	Method	Description
static Class<ResponseTemplateManager>	addTemplate(String id, String plain)	Add response template to template container
static Class<ResponseTemplateManager>	addTemplate(String id, String code, String descr)	Add response template to template container
static String	generateTemplate(String code, String description)	Generate API response template string for given code and description
static Response	getTemplate(String id)	Get response template instance from template container
static Map<String,Response>	getTemplates()	Return all available response templates
static boolean	hasTemplate(String id)	Check if given template exists in template container
static boolean	isTemplateMatchHash(Map<String,Object> tpl2, String id)	Check if given API response hash matches a given template by code and description
static boolean	isTemplateMatchPlain(String plain, String id)	Check if 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

Field Details

templates

public static Map<String,String> templates

backend system entity

Constructor Details

ResponseTemplateManager

public ResponseTemplateManager()

Method Details

generateTemplate

public static String generateTemplate(String code,
 String description)

Generate API response template string for 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 response template to 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 response template to 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:

Response Instance

getTemplate

public static Response getTemplate(String id)

Get response template instance from template container

Parameters:

id - template id

Returns:

template instance

getTemplates

public static Map<String,Response> getTemplates()

Return all available response templates

Returns:

all available response template instances

hasTemplate

public static boolean hasTemplate(String id)

Check if given template exists in template container

Parameters:

id - template id

Returns:

boolean result

isTemplateMatchHash

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

Check if 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 given API plain response matches a given template by code and description

Parameters:

plain - API plain response

id - template id

Returns:

boolean result