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 java.lang.String	CONFIG_DEFAULT
protected static java.lang.String	CONFIG_ENUM
protected static java.lang.String	CONFIG_SERVER
protected static java.lang.String	CONFIG_SERVER_DESCRIPTION
protected static java.lang.String	CONFIG_SERVER_URL
protected static java.lang.String	CONFIG_SERVERS
protected static java.lang.String	CONFIG_TEMPLATES
protected static java.lang.String	EXT_SERVERS
protected static java.util.regex.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(java.util.Map<java.lang.String,java.lang.Object> templateEntries, java.lang.String configPrefix, java.lang.String serverName, java.lang.String urlPlaceholderName)
protected void	addTemplateDescriptionToMap(java.util.Map<java.lang.String,java.lang.Object> templateEntries, java.lang.String configPrefix, java.lang.String serverName, java.lang.String urlPlaceholderName)
protected void	addTemplateEnumToMap(java.util.Map<java.lang.String,java.lang.Object> templateEntries, java.lang.String configPrefix, java.lang.String serverName, java.lang.String urlPlaceholderName)
protected java.lang.String	getServerConfigValue(java.lang.String configPrefix, java.lang.String serverName, java.lang.String relativeConfigKey)
protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getServers(java.lang.String configPrefix)
protected java.lang.String[]	getServersNames(java.lang.String configPrefix)
protected java.lang.String	getServerTemplatesConfigValue(java.lang.String configPrefix, java.lang.String serverName, java.lang.String urlPlaceholder, java.lang.String relativeConfigKey)
protected java.util.Map<java.lang.String,java.lang.Object>	getTemplates(java.lang.String configPrefix, java.lang.String serverName, java.lang.String serverUrl)
java.util.List<springfox.documentation.service.VendorExtension>	getVendorExtensions(java.lang.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 Detail

EXT_SERVERS

protected static final java.lang.String EXT_SERVERS

See Also:

Constant Field Values

CONFIG_SERVER

protected static final java.lang.String CONFIG_SERVER

See Also:

Constant Field Values

CONFIG_SERVER_URL

protected static final java.lang.String CONFIG_SERVER_URL

See Also:

Constant Field Values

CONFIG_SERVER_DESCRIPTION

protected static final java.lang.String CONFIG_SERVER_DESCRIPTION

See Also:

Constant Field Values

CONFIG_TEMPLATES

protected static final java.lang.String CONFIG_TEMPLATES

See Also:

Constant Field Values

CONFIG_DEFAULT

protected static final java.lang.String CONFIG_DEFAULT

See Also:

Constant Field Values

CONFIG_ENUM

protected static final java.lang.String CONFIG_ENUM

See Also:

Constant Field Values

CONFIG_SERVERS

protected static final java.lang.String CONFIG_SERVERS

See Also:

Constant Field Values

SERVER_URL_PLACEHOLDER_PATTERN

protected static final java.util.regex.Pattern SERVER_URL_PLACEHOLDER_PATTERN

Constructor Detail

ServerApiVendorExtensionStrategy

public ServerApiVendorExtensionStrategy()

Method Detail

getVendorExtensions

public java.util.List<springfox.documentation.service.VendorExtension> getVendorExtensions(java.lang.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 java.lang.String getServerConfigValue(java.lang.String configPrefix,
                                                java.lang.String serverName,
                                                java.lang.String relativeConfigKey)

getServerTemplatesConfigValue

protected java.lang.String getServerTemplatesConfigValue(java.lang.String configPrefix,
                                                         java.lang.String serverName,
                                                         java.lang.String urlPlaceholder,
                                                         java.lang.String relativeConfigKey)

getServersNames

protected java.lang.String[] getServersNames(java.lang.String configPrefix)

getServers

protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getServers(java.lang.String configPrefix)

getTemplates

protected java.util.Map<java.lang.String,java.lang.Object> getTemplates(java.lang.String configPrefix,
                                                                              java.lang.String serverName,
                                                                              java.lang.String serverUrl)

addTemplateDescriptionToMap

protected void addTemplateDescriptionToMap(java.util.Map<java.lang.String,java.lang.Object> templateEntries,
                                           java.lang.String configPrefix,
                                           java.lang.String serverName,
                                           java.lang.String urlPlaceholderName)

addTemplateDefaultToMap

protected void addTemplateDefaultToMap(java.util.Map<java.lang.String,java.lang.Object> templateEntries,
                                       java.lang.String configPrefix,
                                       java.lang.String serverName,
                                       java.lang.String urlPlaceholderName)

addTemplateEnumToMap

protected void addTemplateEnumToMap(java.util.Map<java.lang.String,java.lang.Object> templateEntries,
                                    java.lang.String configPrefix,
                                    java.lang.String serverName,
                                    java.lang.String urlPlaceholderName)