Package io.smallrye.openapi.mavenplugin

Class MavenConfig

java.lang.Object

io.smallrye.openapi.mavenplugin.MavenConfig

All Implemented Interfaces:

OpenApiConfig

public class MavenConfig
extends Object
implements OpenApiConfig

Implementation of the OpenApiConfig interface that gets config information from maven

Author:

Phillip Kruger (phillip.kruger@redhat.com)

Nested Class Summary

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

OpenApiConfig.DuplicateOperationIdBehavior, OpenApiConfig.OperationIdStrategy

Field Summary

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

DUPLICATE_OPERATION_ID_BEHAVIOR_DEFAULT, MAXIMUM_STATIC_FILE_SIZE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
MavenConfig(Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
boolean	applicationPathDisable()
String	customSchemaRegistryClass()
String	filter()
OpenApiConfig.DuplicateOperationIdBehavior	getDuplicateOperationIdBehavior()
String	getInfoContactEmail()
String	getInfoContactName()
String	getInfoContactUrl()
String	getInfoDescription()
String	getInfoLicenseName()
String	getInfoLicenseUrl()
String	getInfoTermsOfService()
String	getInfoTitle()
String	getInfoVersion()
Integer	getMaximumStaticFileSize()
String	getOpenApiVersion()
OpenApiConfig.OperationIdStrategy	getOperationIdStrategy()
Set<String>	getScanExcludeProfiles()
Set<String>	getScanProfiles()
Map<String,String>	getScanResourceClasses()
String	modelReader()
List<String>	operationServers(String operationId)
List<String>	pathServers(String path)
Set<String>	scanClasses()
boolean	scanDependenciesDisable()
boolean	scanDisable()
Set<String>	scanExcludeClasses()
Set<String>	scanExcludePackages()
Set<String>	scanPackages()
List<String>	servers()

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

allowNakedPathParameter, arrayReferencesEnable, asCsvList, asCsvSet, doAllowNakedPathParameter, getDefaultConsumes, getDefaultProduces, getSchemas, patternOf, patternOf, privatePropertiesEnable, propertyNamingStrategy, removeUnusedSchemas, scanBeanValidation, scanDependenciesJars, sortedPropertiesEnable

Constructor Detail

MavenConfig

public MavenConfig(Map<String,String> properties)

Method Detail

modelReader

public String modelReader()

Specified by:

modelReader in interface OpenApiConfig

filter

public String filter()

Specified by:

filter in interface OpenApiConfig

scanDisable

public boolean scanDisable()

Specified by:

scanDisable in interface OpenApiConfig

scanPackages

public Set<String> scanPackages()

Specified by:

scanPackages in interface OpenApiConfig

scanClasses

public Set<String> scanClasses()

Specified by:

scanClasses in interface OpenApiConfig

scanExcludePackages

public Set<String> scanExcludePackages()

Specified by:

scanExcludePackages in interface OpenApiConfig

scanExcludeClasses

public Set<String> scanExcludeClasses()

Specified by:

scanExcludeClasses in interface OpenApiConfig

servers

public List<String> servers()

Specified by:

servers in interface OpenApiConfig

pathServers

public List<String> pathServers(String path)

Specified by:

pathServers in interface OpenApiConfig

operationServers

public List<String> operationServers(String operationId)

Specified by:

operationServers in interface OpenApiConfig

scanDependenciesDisable

public boolean scanDependenciesDisable()

Specified by:

scanDependenciesDisable in interface OpenApiConfig

customSchemaRegistryClass

public String customSchemaRegistryClass()

Specified by:

customSchemaRegistryClass in interface OpenApiConfig

applicationPathDisable

public boolean applicationPathDisable()

Specified by:

applicationPathDisable 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

getDuplicateOperationIdBehavior

public OpenApiConfig.DuplicateOperationIdBehavior getDuplicateOperationIdBehavior()

Specified by:

getDuplicateOperationIdBehavior 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

getScanResourceClasses

public Map<String,String> getScanResourceClasses()

Specified by:

getScanResourceClasses in interface OpenApiConfig

getMaximumStaticFileSize

public Integer getMaximumStaticFileSize()

Specified by:

getMaximumStaticFileSize in interface OpenApiConfig