Class OpenApiConfiguration
- java.lang.Object
-
- fish.payara.microprofile.openapi.impl.config.OpenApiConfiguration
-
public class OpenApiConfiguration extends Object
-
-
Constructor Summary
Constructors Constructor Description OpenApiConfiguration(ClassLoader applicationClassLoader)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
getExcludeClasses()
List<String>
getExcludePackages()
Class<? extends org.eclipse.microprofile.openapi.OASFilter>
getFilter()
Class<? extends org.eclipse.microprofile.openapi.OASModelReader>
getModelReader()
Map<String,Set<String>>
getOperationServerMap()
Map<String,Set<String>>
getPathServerMap()
List<String>
getScanClasses()
boolean
getScanDisable()
boolean
getScanLib()
List<String>
getScanPackages()
Map<String,SchemaImpl>
getSchemaMap()
List<String>
getServers()
Set<org.glassfish.hk2.classmodel.reflect.Type>
getValidClasses(Collection<org.glassfish.hk2.classmodel.reflect.Type> types)
-
-
-
Constructor Detail
-
OpenApiConfiguration
public OpenApiConfiguration(ClassLoader applicationClassLoader)
-
-
Method Detail
-
getModelReader
public Class<? extends org.eclipse.microprofile.openapi.OASModelReader> getModelReader()
- Returns:
- the
OASModelReader
class provided by the application.
-
getFilter
public Class<? extends org.eclipse.microprofile.openapi.OASFilter> getFilter()
- Returns:
- the
OASFilter
class provided by the application.
-
getScanDisable
public boolean getScanDisable()
- Returns:
- whether to disable application scanning.
-
getScanLib
public boolean getScanLib()
- Returns:
- whether to disable packaged libraries scanning.
-
getScanPackages
public List<String> getScanPackages()
- Returns:
- a whitelist of packages to scan in the application.
-
getScanClasses
public List<String> getScanClasses()
- Returns:
- a whitelist of classes to scan in the application.
-
getExcludePackages
public List<String> getExcludePackages()
- Returns:
- a blacklist of packages to not scan in the application.
-
getExcludeClasses
public List<String> getExcludeClasses()
- Returns:
- a blacklist of classes to not scan in the application.
-
getPathServerMap
public Map<String,Set<String>> getPathServerMap()
- Returns:
- a map of paths to the servers it contains.
-
getOperationServerMap
public Map<String,Set<String>> getOperationServerMap()
- Returns:
- a map of operation ids to the servers it contains.
-
getSchemaMap
public Map<String,SchemaImpl> getSchemaMap()
- Returns:
- a map of schema objects
-
getValidClasses
public Set<org.glassfish.hk2.classmodel.reflect.Type> getValidClasses(Collection<org.glassfish.hk2.classmodel.reflect.Type> types)
- Parameters:
types
- the list of classes to filter.- Returns:
- a filtered list of classes, using
getScanClasses()
,getExcludeClasses()
,getScanPackages()
andgetExcludePackages()
.
-
-