Package io.smallrye.openapi.api

Class OpenApiConfigImpl

java.lang.Object

io.smallrye.openapi.api.OpenApiConfigImpl

All Implemented Interfaces:

OpenApiConfig

public class OpenApiConfigImpl
extends Object
implements OpenApiConfig

Implementation of the OpenApiConfig interface that gets config information from a standard MP Config object.

Author:

[email protected]

Nested Class Summary

Nested classes/interfaces inherited from interface io.smallrye.openapi.api.OpenApiConfig

OpenApiConfig.OperationIdStrategy

Constructor Summary

Constructors

Constructor	Description
OpenApiConfigImpl(org.eclipse.microprofile.config.Config config)	Constructor.

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	allowNakedPathParameter()
boolean	applicationPathDisable()
boolean	arrayReferencesEnable()
String	customSchemaRegistryClass()
void	doAllowNakedPathParameter()
String	filter()
static OpenApiConfig	fromConfig(org.eclipse.microprofile.config.Config config)
protected org.eclipse.microprofile.config.Config	getConfig()
Optional<String[]>	getDefaultConsumes()
Optional<String[]>	getDefaultProduces()
String	getInfoContactEmail()
String	getInfoContactName()
String	getInfoContactUrl()
String	getInfoDescription()
String	getInfoLicenseName()
String	getInfoLicenseUrl()
String	getInfoTermsOfService()
String	getInfoTitle()
String	getInfoVersion()
String	getOpenApiVersion()
OpenApiConfig.OperationIdStrategy	getOperationIdStrategy()
Set<String>	getScanExcludeProfiles()
Set<String>	getScanProfiles()
Map<String,String>	getSchemas()
String	modelReader()
Set<String>	operationServers(String operationId)
Set<String>	pathServers(String path)
boolean	privatePropertiesEnable()
String	propertyNamingStrategy()
boolean	removeUnusedSchemas()
Pattern	scanClasses()
boolean	scanDependenciesDisable()
Set<String>	scanDependenciesJars()
boolean	scanDisable()
Pattern	scanExcludeClasses()
Pattern	scanExcludePackages()
Pattern	scanPackages()
Set<String>	servers()
void	setAllowNakedPathParameter(Boolean allowNakedPathParameter)
boolean	sortedPropertiesEnable()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.smallrye.openapi.api.OpenApiConfig

asCsvSet, patternOf, patternOf

Constructor Detail

OpenApiConfigImpl

public OpenApiConfigImpl(org.eclipse.microprofile.config.Config config)

Constructor.

Parameters:

config - MicroProfile Config instance

Method Detail

fromConfig

public static OpenApiConfig fromConfig(org.eclipse.microprofile.config.Config config)

getConfig

protected org.eclipse.microprofile.config.Config getConfig()

Returns:

the MP config instance

modelReader

public String modelReader()

Specified by:

modelReader in interface OpenApiConfig

See Also:

OpenApiConfig.modelReader()

filter

public String filter()

Specified by:

filter in interface OpenApiConfig

See Also:

OpenApiConfig.filter()

scanDisable

public boolean scanDisable()

Specified by:

scanDisable in interface OpenApiConfig

See Also:

OpenApiConfig.scanDisable()

scanPackages

public Pattern scanPackages()

Specified by:

scanPackages in interface OpenApiConfig

See Also:

OpenApiConfig.scanPackages()

scanClasses

public Pattern scanClasses()

Specified by:

scanClasses in interface OpenApiConfig

See Also:

OpenApiConfig.scanClasses()

scanExcludePackages

public Pattern scanExcludePackages()

Specified by:

scanExcludePackages in interface OpenApiConfig

See Also:

OpenApiConfig.scanExcludePackages()

scanExcludeClasses

public Pattern scanExcludeClasses()

Specified by:

scanExcludeClasses in interface OpenApiConfig

See Also:

OpenApiConfig.scanExcludeClasses()

servers

public Set<String> servers()

Specified by:

servers in interface OpenApiConfig

See Also:

OpenApiConfig.servers()

pathServers

public Set<String> pathServers(String path)

Specified by:

pathServers in interface OpenApiConfig

See Also:

OpenApiConfig.pathServers(java.lang.String)

operationServers

public Set<String> operationServers(String operationId)

Specified by:

operationServers in interface OpenApiConfig

See Also:

OpenApiConfig.operationServers(java.lang.String)

scanDependenciesDisable

public boolean scanDependenciesDisable()

Specified by:

scanDependenciesDisable in interface OpenApiConfig

See Also:

OpenApiConfig.scanDependenciesDisable()

scanDependenciesJars

public Set<String> scanDependenciesJars()

Specified by:

scanDependenciesJars in interface OpenApiConfig

See Also:

OpenApiConfig.scanDependenciesJars()

arrayReferencesEnable

public boolean arrayReferencesEnable()

Specified by:

arrayReferencesEnable in interface OpenApiConfig

customSchemaRegistryClass

public String customSchemaRegistryClass()

Specified by:

customSchemaRegistryClass in interface OpenApiConfig

applicationPathDisable

public boolean applicationPathDisable()

Specified by:

applicationPathDisable in interface OpenApiConfig

privatePropertiesEnable

public boolean privatePropertiesEnable()

Specified by:

privatePropertiesEnable in interface OpenApiConfig

propertyNamingStrategy

public String propertyNamingStrategy()

Specified by:

propertyNamingStrategy in interface OpenApiConfig

sortedPropertiesEnable

public boolean sortedPropertiesEnable()

Specified by:

sortedPropertiesEnable in interface OpenApiConfig

getSchemas

public Map<String,String> getSchemas()

Specified by:

getSchemas in interface OpenApiConfig

getOpenApiVersion

public String getOpenApiVersion()

Specified by:

getOpenApiVersion in interface OpenApiConfig

getInfoTitle

public String getInfoTitle()

Specified by:

getInfoTitle in interface OpenApiConfig

getInfoVersion

public String getInfoVersion()

Specified by:

getInfoVersion in interface OpenApiConfig

getInfoDescription

public String getInfoDescription()

Specified by:

getInfoDescription in interface OpenApiConfig

getInfoTermsOfService

public String getInfoTermsOfService()

Specified by:

getInfoTermsOfService in interface OpenApiConfig

getInfoContactEmail

public String getInfoContactEmail()

Specified by:

getInfoContactEmail in interface OpenApiConfig

getInfoContactName

public String getInfoContactName()

Specified by:

getInfoContactName in interface OpenApiConfig

getInfoContactUrl

public String getInfoContactUrl()

Specified by:

getInfoContactUrl in interface OpenApiConfig

getInfoLicenseName

public String getInfoLicenseName()

Specified by:

getInfoLicenseName in interface OpenApiConfig

getInfoLicenseUrl

public String getInfoLicenseUrl()

Specified by:

getInfoLicenseUrl in interface OpenApiConfig

getOperationIdStrategy

public OpenApiConfig.OperationIdStrategy getOperationIdStrategy()

Specified by:

getOperationIdStrategy in interface OpenApiConfig

getDefaultProduces

public Optional<String[]> getDefaultProduces()

Specified by:

getDefaultProduces in interface OpenApiConfig

allowNakedPathParameter

public Optional<Boolean> allowNakedPathParameter()

Specified by:

allowNakedPathParameter in interface OpenApiConfig

doAllowNakedPathParameter

public void doAllowNakedPathParameter()

Specified by:

doAllowNakedPathParameter in interface OpenApiConfig

setAllowNakedPathParameter

public void setAllowNakedPathParameter(Boolean allowNakedPathParameter)

getDefaultConsumes

public Optional<String[]> getDefaultConsumes()

Specified by:

getDefaultConsumes in interface OpenApiConfig

getScanProfiles

public Set<String> getScanProfiles()

Specified by:

getScanProfiles in interface OpenApiConfig

getScanExcludeProfiles

public Set<String> getScanExcludeProfiles()

Specified by:

getScanExcludeProfiles in interface OpenApiConfig

removeUnusedSchemas

public boolean removeUnusedSchemas()

Specified by:

removeUnusedSchemas in interface OpenApiConfig