io.syndesis.server.api.generator.openapi

Class OpenApiParameterGenerator<T extends io.apicurio.datamodels.openapi.models.OasDocument>

java.lang.Object

io.syndesis.server.api.generator.openapi.OpenApiParameterGenerator<T>

Direct Known Subclasses:

Oas20ParameterGenerator, Oas30ParameterGenerator

public abstract class OpenApiParameterGenerator<T extends io.apicurio.datamodels.openapi.models.OasDocument>
extends Object

Generator creates configuration properties from OpenAPI document parameters. Created configuration properties are added to the connector builder. This is the abstract base class for specific 2.x and 3.x OpenAPI implementations.

Constructor Summary

Constructors

Constructor and Description
OpenApiParameterGenerator()

Method Summary

Modifier and Type	Method and Description
void	addGlobalParameters(Connector.Builder builder, T openApiDoc) Extract global parameters from OpenAPI document and generate configuration properties on given connector builder.
protected abstract Map<String,ConfigurationProperty>	createConfigurationProperties(T openApiDoc) Create configuration properties from global parameters on given OpenAPI document.
static ConfigurationProperty	createPropertyFromParameter(io.apicurio.datamodels.openapi.models.OasParameter parameter, String type, String javaType, Object defaultValue, List<String> enums) Creates a configuration property from given parameter.
protected boolean	shouldCreateProperty(io.apicurio.datamodels.openapi.models.OasParameter parameter) Checks if we should generate a configuration property for given global parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiParameterGenerator

public OpenApiParameterGenerator()

Method Detail

addGlobalParameters

public void addGlobalParameters(Connector.Builder builder,
                                T openApiDoc)

Extract global parameters from OpenAPI document and generate configuration properties on given connector builder.

Parameters:

builder - the connector builder to receive generated configuration properties.

openApiDoc - the OpenAPI document.

createConfigurationProperties

protected abstract Map<String,ConfigurationProperty> createConfigurationProperties(T openApiDoc)

Create configuration properties from global parameters on given OpenAPI document.

Parameters:

openApiDoc - the OpenAPI document.

Returns:

map of generated configuration properties where the key is the property name.

shouldCreateProperty

protected boolean shouldCreateProperty(io.apicurio.datamodels.openapi.models.OasParameter parameter)

Checks if we should generate a configuration property for given global parameter.

Parameters:

parameter - the parameter to check.

Returns:

true if parameter should generate a configuration property.

createPropertyFromParameter

public static ConfigurationProperty createPropertyFromParameter(io.apicurio.datamodels.openapi.models.OasParameter parameter,
                                                                String type,
                                                                String javaType,
                                                                Object defaultValue,
                                                                List<String> enums)

Creates a configuration property from given parameter. OpenAPI version specific information like type, default values and enum list are extracted by version specific subclass implementations.

Parameters:

parameter - the global parameter on the specification.

type - the parameter type (array, object, etc.)

javaType - the corresponding java type.

defaultValue - optional default value.

enums - optional list of allowed values as enumeration.

Returns:

generated configuration property that gets added to the connector builder.