Package de.hybris.platform.webservicescommons.swagger.strategies.impl

Class ServerApiVendorExtensionStrategy

java.lang.Object

de.hybris.platform.webservicescommons.swagger.strategies.ConfigApiVendorExtensionStrategy

de.hybris.platform.webservicescommons.swagger.strategies.impl.ServerApiVendorExtensionStrategy

All Implemented Interfaces:

ApiVendorExtensionStrategy

public class ServerApiVendorExtensionStrategy
extends ConfigApiVendorExtensionStrategy

Implementation of ApiVendorExtensionStrategy.

It provides extension for configuring server settings. The result list includes "x-server" extensions.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIG_DEFAULT
protected static final String	CONFIG_ENUM
protected static final String	CONFIG_SERVER
protected static final String	CONFIG_SERVER_DESCRIPTION
protected static final String	CONFIG_SERVER_URL
protected static final String	CONFIG_SERVERS
protected static final String	CONFIG_TEMPLATES
protected static final String	EXT_SERVERS
protected static final Pattern	SERVER_URL_PLACEHOLDER_PATTERN

Fields inherited from class de.hybris.platform.webservicescommons.swagger.strategies.ConfigApiVendorExtensionStrategy

CONFIG_ARRAY_DELIMITER, CONFIG_DELIMITER

Constructor Summary

Constructors

Constructor	Description
ServerApiVendorExtensionStrategy()

Method Summary

Modifier and Type	Method	Description
protected void	addTemplateDefaultToMap(Map<String,Object> templateEntries, String configPrefix, String serverName, String urlPlaceholderName)
protected void	addTemplateDescriptionToMap(Map<String,Object> templateEntries, String configPrefix, String serverName, String urlPlaceholderName)
protected void	addTemplateEnumToMap(Map<String,Object> templateEntries, String configPrefix, String serverName, String urlPlaceholderName)
protected String	getServerConfigValue(String configPrefix, String serverName, String relativeConfigKey)
protected List<Map<String,Object>>	getServers(String configPrefix)
protected String[]	getServersNames(String configPrefix)
protected String	getServerTemplatesConfigValue(String configPrefix, String serverName, String urlPlaceholder, String relativeConfigKey)
protected Map<String,Object>	getTemplates(String configPrefix, String serverName, String serverUrl)
List<springfox.documentation.service.VendorExtension>	getVendorExtensions(String configPrefix)	Provides a list of vendor extensions for the API based on the configuration prefix.

Methods inherited from class de.hybris.platform.webservicescommons.swagger.strategies.ConfigApiVendorExtensionStrategy

getConfigArray, getConfigKey, getConfigValue, setConfigurationService

Methods inherited from class java.lang.Object

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

Field Details

EXT_SERVERS

protected static final String EXT_SERVERS

See Also:

• Constant Field Values

CONFIG_SERVER

protected static final String CONFIG_SERVER

See Also:

• Constant Field Values

CONFIG_SERVER_URL

protected static final String CONFIG_SERVER_URL

See Also:

• Constant Field Values

CONFIG_SERVER_DESCRIPTION

protected static final String CONFIG_SERVER_DESCRIPTION

See Also:

• Constant Field Values

CONFIG_TEMPLATES

protected static final String CONFIG_TEMPLATES

See Also:

• Constant Field Values

CONFIG_DEFAULT

protected static final String CONFIG_DEFAULT

See Also:

• Constant Field Values

CONFIG_ENUM

protected static final String CONFIG_ENUM

See Also:

• Constant Field Values

CONFIG_SERVERS

protected static final String CONFIG_SERVERS

See Also:

• Constant Field Values

SERVER_URL_PLACEHOLDER_PATTERN

protected static final Pattern SERVER_URL_PLACEHOLDER_PATTERN

Constructor Details

ServerApiVendorExtensionStrategy

public ServerApiVendorExtensionStrategy()

Method Details

getVendorExtensions

public List<springfox.documentation.service.VendorExtension> getVendorExtensions(String configPrefix)

Description copied from interface: ApiVendorExtensionStrategy

Provides a list of vendor extensions for the API based on the configuration prefix.

Parameters:

configPrefix - configuration prefix

Returns:

list of vendor extension

getServerConfigValue

protected String getServerConfigValue(String configPrefix,
 String serverName,
 String relativeConfigKey)

getServerTemplatesConfigValue

protected String getServerTemplatesConfigValue(String configPrefix,
 String serverName,
 String urlPlaceholder,
 String relativeConfigKey)

getServersNames

protected String[] getServersNames(String configPrefix)

getServers

protected List<Map<String,Object>> getServers(String configPrefix)

getTemplates

protected Map<String,Object> getTemplates(String configPrefix,
 String serverName,
 String serverUrl)

addTemplateDescriptionToMap

protected void addTemplateDescriptionToMap(Map<String,Object> templateEntries,
 String configPrefix,
 String serverName,
 String urlPlaceholderName)

addTemplateDefaultToMap

protected void addTemplateDefaultToMap(Map<String,Object> templateEntries,
 String configPrefix,
 String serverName,
 String urlPlaceholderName)

addTemplateEnumToMap

protected void addTemplateEnumToMap(Map<String,Object> templateEntries,
 String configPrefix,
 String serverName,
 String urlPlaceholderName)