fish.payara.microprofile.openapi.impl.config

Class OpenApiConfiguration

java.lang.Object

fish.payara.microprofile.openapi.impl.config.OpenApiConfiguration

public class OpenApiConfiguration
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenApiConfiguration(ClassLoader applicationClassLoader)

Method Summary

Modifier and Type	Method and Description
List<Class<?>>	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<Class<?>>	getScanClasses()
boolean	getScanDisable()
List<String>	getScanPackages()
List<String>	getServers()
Set<Class<?>>	getValidClasses(Set<Class<?>> classes)

Methods inherited from class java.lang.Object

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

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.

getScanPackages

public List<String> getScanPackages()

Returns:

a whitelist of packages to scan in the application.

getScanClasses

public List<Class<?>> 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<Class<?>> getExcludeClasses()

Returns:

a blacklist of classes to not scan in the application.

getServers

public List<String> getServers()

Returns:

a list of servers to add to the root document.

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.

getValidClasses

public Set<Class<?>> getValidClasses(Set<Class<?>> classes)

Parameters:

classes - the list of classes to filter.

Returns:

a filtered list of classes, using getScanClasses(), getExcludeClasses(), getScanPackages() and getExcludePackages().