Package io.swagger.v3.oas.integration

Class GenericOpenApiContext<T extends GenericOpenApiContext>

java.lang.Object

io.swagger.v3.oas.integration.GenericOpenApiContext<T>

All Implemented Interfaces:

OpenApiContext

public class GenericOpenApiContext<T extends GenericOpenApiContext>
extends Object
implements OpenApiContext

Field Summary

Fields

Modifier and Type	Field	Description
protected String	configLocation
protected String	id
protected OpenApiContext	parent
protected Set<String>	resourceClasses
protected Set<String>	resourcePackages

Fields inherited from interface io.swagger.v3.oas.integration.api.OpenApiContext

OPENAPI_CONTEXT_ID_DEFAULT, OPENAPI_CONTEXT_ID_KEY, OPENAPI_CONTEXT_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
GenericOpenApiContext()

Method Summary

Modifier and Type	Method	Description
protected Set<ModelConverter>	buildModelConverters(OpenAPIConfiguration openApiConfiguration)
protected ObjectMapperProcessor	buildObjectMapperProcessor(OpenAPIConfiguration openApiConfiguration)
protected OpenApiReader	buildReader(OpenAPIConfiguration openApiConfiguration)
protected OpenApiScanner	buildScanner(OpenAPIConfiguration openApiConfiguration)
T	cacheTTL(long cacheTTL)
T	configLocation(String configLocation)
T	convertToOpenAPI31(Boolean convertToOpenAPI31)
long	getCacheTTL()
String	getConfigLocation()
String	getId()
protected List<org.apache.commons.lang3.tuple.ImmutablePair<String,String>>	getKnownLocations()
protected Map<String,OpenApiConfigurationLoader>	getLocationLoaders()
Set<ModelConverter>	getModelConverters()
ObjectMapperProcessor	getObjectMapperProcessor()
OpenAPIConfiguration	getOpenApiConfiguration()
OpenApiReader	getOpenApiReader()
OpenApiScanner	getOpenApiScanner()
com.fasterxml.jackson.databind.ObjectMapper	getOutputJsonMapper()
com.fasterxml.jackson.databind.ObjectMapper	getOutputYamlMapper()
OpenApiContext	getParent()
Set<String>	getResourceClasses()
Set<String>	getResourcePackages()
T	id(String id)
T	init()
Boolean	isConvertToOpenAPI31()
Boolean	isOpenAPI31()
protected OpenAPIConfiguration	loadConfiguration()
T	modelConverters(Set<ModelConverter> modelConverters)
T	objectMapperProcessor(ObjectMapperProcessor objectMapperProcessor)
T	openAPI31(Boolean openAPI31)
T	openApiConfiguration(OpenAPIConfiguration openApiConfiguration)
T	openApiReader(OpenApiReader openApiReader)
T	openApiScanner(OpenApiScanner openApiScanner)
T	outputJsonMapper(com.fasterxml.jackson.databind.ObjectMapper outputJsonMapper)
T	outputYamlMapper(com.fasterxml.jackson.databind.ObjectMapper outputYamlMapper)
T	parent(OpenApiContext parent)
OpenAPI	read()
protected void	register()
protected void	resetReader()
T	resourceClasses(Set<String> resourceClasses)
T	resourcePackages(Set<String> resourcePackages)
void	setCacheTTL(long cacheTTL)
void	setConfigLocation(String configLocation)
void	setConvertToOpenAPI31(Boolean convertToOpenAPI31)
void	setId(String id)
void	setModelConverters(Set<ModelConverter> modelConverters)
void	setObjectMapperProcessor(ObjectMapperProcessor objectMapperProcessor)
void	setOpenAPI31(Boolean v)
void	setOpenApiConfiguration(OpenAPIConfiguration openApiConfiguration)
void	setOpenApiReader(OpenApiReader openApiReader)
void	setOpenApiScanner(OpenApiScanner openApiScanner)
void	setOutputJsonMapper(com.fasterxml.jackson.databind.ObjectMapper outputJsonMapper)
void	setOutputYamlMapper(com.fasterxml.jackson.databind.ObjectMapper outputYamlMapper)
void	setParent(OpenApiContext parent)
void	setResourceClasses(Set<String> resourceClasses)
void	setResourcePackages(Set<String> resourcePackages)

Methods inherited from class java.lang.Object

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

Field Detail

resourcePackages

protected Set<String> resourcePackages

resourceClasses

protected Set<String> resourceClasses

id

protected String id

parent

protected OpenApiContext parent

configLocation

protected String configLocation

Constructor Detail

GenericOpenApiContext

public GenericOpenApiContext()

Method Detail

getCacheTTL

public long getCacheTTL()

setCacheTTL

public void setCacheTTL(long cacheTTL)

cacheTTL

public T cacheTTL(long cacheTTL)

getOpenApiReader

public OpenApiReader getOpenApiReader()

setOpenApiReader

public void setOpenApiReader(OpenApiReader openApiReader)

Specified by:

setOpenApiReader in interface OpenApiContext

getOpenApiScanner

public OpenApiScanner getOpenApiScanner()

setOpenApiScanner

public void setOpenApiScanner(OpenApiScanner openApiScanner)

Specified by:

setOpenApiScanner in interface OpenApiContext

openApiReader

public final T openApiReader(OpenApiReader openApiReader)

openApiScanner

public final T openApiScanner(OpenApiScanner openApiScanner)

getResourcePackages

public Set<String> getResourcePackages()

setResourcePackages

public void setResourcePackages(Set<String> resourcePackages)

resourcePackages

public T resourcePackages(Set<String> resourcePackages)

getResourceClasses

public Set<String> getResourceClasses()

setResourceClasses

public void setResourceClasses(Set<String> resourceClasses)

resourceClasses

public T resourceClasses(Set<String> resourceClasses)

openApiConfiguration

public T openApiConfiguration(OpenAPIConfiguration openApiConfiguration)

getConfigLocation

public String getConfigLocation()

Specified by:

getConfigLocation in interface OpenApiContext

setConfigLocation

public void setConfigLocation(String configLocation)

configLocation

public final T configLocation(String configLocation)

getId

public String getId()

Specified by:

getId in interface OpenApiContext

setId

public void setId(String id)

id

public final T id(String id)

getParent

public OpenApiContext getParent()

Specified by:

getParent in interface OpenApiContext

setParent

public void setParent(OpenApiContext parent)

parent

public final T parent(OpenApiContext parent)

getObjectMapperProcessor

public ObjectMapperProcessor getObjectMapperProcessor()

Since:

2.0.6

setObjectMapperProcessor

public void setObjectMapperProcessor(ObjectMapperProcessor objectMapperProcessor)

Specified by:

setObjectMapperProcessor in interface OpenApiContext

Since:

2.0.6

objectMapperProcessor

public final T objectMapperProcessor(ObjectMapperProcessor objectMapperProcessor)

Since:

2.0.6

getModelConverters

public Set<ModelConverter> getModelConverters()

Since:

2.0.6

setModelConverters

public void setModelConverters(Set<ModelConverter> modelConverters)

Specified by:

setModelConverters in interface OpenApiContext

Since:

2.0.6

modelConverters

public final T modelConverters(Set<ModelConverter> modelConverters)

Since:

2.0.6

getOutputJsonMapper

public com.fasterxml.jackson.databind.ObjectMapper getOutputJsonMapper()

Specified by:

getOutputJsonMapper in interface OpenApiContext

Since:

2.1.6

setOutputJsonMapper

public void setOutputJsonMapper(com.fasterxml.jackson.databind.ObjectMapper outputJsonMapper)

Specified by:

setOutputJsonMapper in interface OpenApiContext

Since:

2.1.6

outputJsonMapper

public final T outputJsonMapper(com.fasterxml.jackson.databind.ObjectMapper outputJsonMapper)

Since:

2.1.6

getOutputYamlMapper

public com.fasterxml.jackson.databind.ObjectMapper getOutputYamlMapper()

Specified by:

getOutputYamlMapper in interface OpenApiContext

Since:

2.1.6

setOutputYamlMapper

public void setOutputYamlMapper(com.fasterxml.jackson.databind.ObjectMapper outputYamlMapper)

Specified by:

setOutputYamlMapper in interface OpenApiContext

Since:

2.1.6

outputYamlMapper

public final T outputYamlMapper(com.fasterxml.jackson.databind.ObjectMapper outputYamlMapper)

Since:

2.1.6

isOpenAPI31

public Boolean isOpenAPI31()

Since:

2.1.8

setOpenAPI31

public void setOpenAPI31(Boolean v)

Since:

2.1.8

openAPI31

public T openAPI31(Boolean openAPI31)

Since:

2.1.8

isConvertToOpenAPI31

public Boolean isConvertToOpenAPI31()

Since:

2.2.12

setConvertToOpenAPI31

public void setConvertToOpenAPI31(Boolean convertToOpenAPI31)

Since:

2.2.12

convertToOpenAPI31

public T convertToOpenAPI31(Boolean convertToOpenAPI31)

Since:

2.2.12

register

protected void register()

getOpenApiConfiguration

public OpenAPIConfiguration getOpenApiConfiguration()

Specified by:

getOpenApiConfiguration in interface OpenApiContext

setOpenApiConfiguration

public void setOpenApiConfiguration(OpenAPIConfiguration openApiConfiguration)

buildReader

protected OpenApiReader buildReader(OpenAPIConfiguration openApiConfiguration)
                             throws Exception

Throws:

Exception

buildScanner

protected OpenApiScanner buildScanner(OpenAPIConfiguration openApiConfiguration)
                               throws Exception

Throws:

Exception

buildObjectMapperProcessor

protected ObjectMapperProcessor buildObjectMapperProcessor(OpenAPIConfiguration openApiConfiguration)
                                                    throws Exception

Throws:

Exception

buildModelConverters

protected Set<ModelConverter> buildModelConverters(OpenAPIConfiguration openApiConfiguration)
                                            throws Exception

Throws:

Exception

getKnownLocations

protected List<org.apache.commons.lang3.tuple.ImmutablePair<String,String>> getKnownLocations()

getLocationLoaders

protected Map<String,OpenApiConfigurationLoader> getLocationLoaders()

loadConfiguration

protected OpenAPIConfiguration loadConfiguration()
                                          throws OpenApiConfigurationException

Throws:

OpenApiConfigurationException

init

public T init()
       throws OpenApiConfigurationException

Specified by:

init in interface OpenApiContext

Throws:

OpenApiConfigurationException

read

public OpenAPI read()

Specified by:

read in interface OpenApiContext

resetReader

protected void resetReader()