org.apache.cxf.jaxrs.openapi

Class OpenApiFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

org.apache.cxf.feature.AbstractFeature

org.apache.cxf.jaxrs.openapi.OpenApiFeature

All Implemented Interfaces:

org.apache.cxf.feature.Feature, org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

public class OpenApiFeature
extends org.apache.cxf.feature.AbstractFeature
implements org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OpenApiFeature.DefaultApplication

Nested classes/interfaces inherited from interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

org.apache.cxf.jaxrs.swagger.SwaggerUiSupport.Registration

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTACT_PROPERTY
static String	DESCRIPTION_PROPERTY
static String	FILTER_CLASS_PROPERTY
static String	LICENSE_PROPERTY
static String	LICENSE_URL_PROPERTY
static String	PRETTY_PRINT_PROPERTY
static String	RESOURCE_PACKAGE_PROPERTY
static String	TERMS_URL_PROPERTY
static String	TITLE_PROPERTY
static String	VERSION_PROPERTY

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

Fields inherited from interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

SUPPORT_UI_PROPERTY

Constructor Summary

Constructors

Constructor and Description
OpenApiFeature()

Method Summary

Modifier and Type	Method and Description
String	findSwaggerUiRoot()
protected javax.ws.rs.core.Application	getApplicationOrDefault(org.apache.cxf.endpoint.Server server, org.apache.cxf.jaxrs.provider.ServerProviderFactory factory, org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, org.apache.cxf.Bus bus) Detects the application (if present) or creates the default application (in case the scan is disabled).
String	getConfigLocation()
String	getContactEmail()
String	getContactName()
String	getContactUrl()
OpenApiCustomizer	getCustomizer()
String	getDescription()
String	getFilterClass()
Collection<String>	getIgnoredRoutes()
String	getLicense()
String	getLicenseUrl()
String	getPropertiesLocation()
Set<String>	getResourceClasses()
Set<String>	getResourcePackages()
Map<String,io.swagger.v3.oas.models.security.SecurityScheme>	getSecurityDefinitions()
default Properties	getSwaggerProperties(String location, org.apache.cxf.Bus bus) Read the Swagger-specific properties from the property file (to seamlessly support the migration from older Swagger features).
org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig	getSwaggerUiConfig()
String	getSwaggerUiMavenGroupAndArtifact()
Map<String,String>	getSwaggerUiMediaTypes()
String	getSwaggerUiVersion()
String	getTermsOfServiceUrl()
String	getTitle()
protected Properties	getUserProperties(Map<String,Object> userDefinedOptions)
String	getVersion()
void	initialize(org.apache.cxf.endpoint.Server server, org.apache.cxf.Bus bus)
boolean	isPrettyPrint()
boolean	isReadAllResources()
boolean	isRunAsFilter()
boolean	isScan()
boolean	isScanKnownConfigLocations()
Boolean	isSupportSwaggerUi()
protected void	registerOpenApiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Set<String> packages, io.swagger.v3.oas.integration.api.OpenAPIConfiguration config)
protected void	registerSwaggerUiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Properties properties, org.apache.cxf.jaxrs.provider.ServerProviderFactory factory, org.apache.cxf.Bus bus)
void	setConfigLocation(String configLocation)
void	setContactEmail(String contactEmail)
void	setContactName(String contactName)
void	setContactUrl(String contactUrl)
void	setCustomizer(OpenApiCustomizer customizer)
void	setDescription(String description)
void	setFilterClass(String filterClass)
void	setIgnoredRoutes(Collection<String> ignoredRoutes)
void	setLicense(String license)
void	setLicenseUrl(String licenseUrl)
void	setPrettyPrint(boolean prettyPrint)
void	setPropertiesLocation(String propertiesLocation)
void	setReadAllResources(boolean readAllResources)
void	setResourceClasses(Set<String> resourceClasses)
void	setResourcePackages(Set<String> resourcePackages)
void	setRunAsFilter(boolean runAsFilter)
void	setScan(boolean scan)
void	setScanKnownConfigLocations(boolean scanKnownConfigLocations)
void	setSecurityDefinitions(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securityDefinitions)
void	setSupportSwaggerUi(Boolean supportSwaggerUi)
void	setSwaggerUiConfig(org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig swaggerUiConfig)
void	setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)
void	setSwaggerUiMediaTypes(Map<String,String> swaggerUiMediaTypes)
void	setSwaggerUiVersion(String swaggerUiVersion)
void	setTermsOfServiceUrl(String termsOfServiceUrl)
void	setTitle(String title)
void	setVersion(String version)

Methods inherited from class org.apache.cxf.feature.AbstractFeature

getActive, getID, initialize, initialize, initialize, initializeProvider

Methods inherited from class javax.xml.ws.WebServiceFeature

isEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

checkSupportSwaggerUiProp, getSwaggerUi

Field Detail

RESOURCE_PACKAGE_PROPERTY

public static final String RESOURCE_PACKAGE_PROPERTY

See Also:

Constant Field Values

TITLE_PROPERTY

public static final String TITLE_PROPERTY

See Also:

Constant Field Values

VERSION_PROPERTY

public static final String VERSION_PROPERTY

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

public static final String DESCRIPTION_PROPERTY

See Also:

Constant Field Values

CONTACT_PROPERTY

public static final String CONTACT_PROPERTY

See Also:

Constant Field Values

LICENSE_PROPERTY

public static final String LICENSE_PROPERTY

See Also:

Constant Field Values

LICENSE_URL_PROPERTY

public static final String LICENSE_URL_PROPERTY

See Also:

Constant Field Values

TERMS_URL_PROPERTY

public static final String TERMS_URL_PROPERTY

See Also:

Constant Field Values

PRETTY_PRINT_PROPERTY

public static final String PRETTY_PRINT_PROPERTY

See Also:

Constant Field Values

FILTER_CLASS_PROPERTY

public static final String FILTER_CLASS_PROPERTY

See Also:

Constant Field Values

Constructor Detail

OpenApiFeature

public OpenApiFeature()

Method Detail

initialize

public void initialize(org.apache.cxf.endpoint.Server server,
                       org.apache.cxf.Bus bus)

Specified by:

initialize in interface org.apache.cxf.feature.Feature

Overrides:

initialize in class org.apache.cxf.feature.AbstractFeature

isScan

public boolean isScan()

setScan

public void setScan(boolean scan)

getFilterClass

public String getFilterClass()

setFilterClass

public void setFilterClass(String filterClass)

getResourcePackages

public Set<String> getResourcePackages()

setResourcePackages

public void setResourcePackages(Set<String> resourcePackages)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getContactName

public String getContactName()

setContactName

public void setContactName(String contactName)

getContactEmail

public String getContactEmail()

setContactEmail

public void setContactEmail(String contactEmail)

getContactUrl

public String getContactUrl()

setContactUrl

public void setContactUrl(String contactUrl)

getLicense

public String getLicense()

setLicense

public void setLicense(String license)

getLicenseUrl

public String getLicenseUrl()

setLicenseUrl

public void setLicenseUrl(String licenseUrl)

getTermsOfServiceUrl

public String getTermsOfServiceUrl()

setTermsOfServiceUrl

public void setTermsOfServiceUrl(String termsOfServiceUrl)

isReadAllResources

public boolean isReadAllResources()

setReadAllResources

public void setReadAllResources(boolean readAllResources)

getResourceClasses

public Set<String> getResourceClasses()

setResourceClasses

public void setResourceClasses(Set<String> resourceClasses)

getIgnoredRoutes

public Collection<String> getIgnoredRoutes()

setIgnoredRoutes

public void setIgnoredRoutes(Collection<String> ignoredRoutes)

isPrettyPrint

public boolean isPrettyPrint()

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

isRunAsFilter

public boolean isRunAsFilter()

isSupportSwaggerUi

public Boolean isSupportSwaggerUi()

Specified by:

isSupportSwaggerUi in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

setSupportSwaggerUi

public void setSupportSwaggerUi(Boolean supportSwaggerUi)

getSwaggerUiVersion

public String getSwaggerUiVersion()

setSwaggerUiVersion

public void setSwaggerUiVersion(String swaggerUiVersion)

getSwaggerUiMavenGroupAndArtifact

public String getSwaggerUiMavenGroupAndArtifact()

setSwaggerUiMavenGroupAndArtifact

public void setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)

getSwaggerUiMediaTypes

public Map<String,String> getSwaggerUiMediaTypes()

Specified by:

getSwaggerUiMediaTypes in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

setSwaggerUiMediaTypes

public void setSwaggerUiMediaTypes(Map<String,String> swaggerUiMediaTypes)

getConfigLocation

public String getConfigLocation()

setConfigLocation

public void setConfigLocation(String configLocation)

getPropertiesLocation

public String getPropertiesLocation()

setPropertiesLocation

public void setPropertiesLocation(String propertiesLocation)

setRunAsFilter

public void setRunAsFilter(boolean runAsFilter)

getSecurityDefinitions

public Map<String,io.swagger.v3.oas.models.security.SecurityScheme> getSecurityDefinitions()

setSecurityDefinitions

public void setSecurityDefinitions(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securityDefinitions)

getCustomizer

public OpenApiCustomizer getCustomizer()

setCustomizer

public void setCustomizer(OpenApiCustomizer customizer)

setScanKnownConfigLocations

public void setScanKnownConfigLocations(boolean scanKnownConfigLocations)

isScanKnownConfigLocations

public boolean isScanKnownConfigLocations()

setSwaggerUiConfig

public void setSwaggerUiConfig(org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig swaggerUiConfig)

getSwaggerUiConfig

public org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig getSwaggerUiConfig()

Specified by:

getSwaggerUiConfig in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

findSwaggerUiRoot

public String findSwaggerUiRoot()

Specified by:

findSwaggerUiRoot in interface org.apache.cxf.jaxrs.swagger.SwaggerUiSupport

getUserProperties

protected Properties getUserProperties(Map<String,Object> userDefinedOptions)

registerOpenApiResources

protected void registerOpenApiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb,
                                        Set<String> packages,
                                        io.swagger.v3.oas.integration.api.OpenAPIConfiguration config)

registerSwaggerUiResources

protected void registerSwaggerUiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb,
                                          Properties properties,
                                          org.apache.cxf.jaxrs.provider.ServerProviderFactory factory,
                                          org.apache.cxf.Bus bus)

getApplicationOrDefault

protected javax.ws.rs.core.Application getApplicationOrDefault(org.apache.cxf.endpoint.Server server,
                                                               org.apache.cxf.jaxrs.provider.ServerProviderFactory factory,
                                                               org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb,
                                                               org.apache.cxf.Bus bus)

Detects the application (if present) or creates the default application (in case the scan is disabled).

getSwaggerProperties

public Properties getSwaggerProperties(String location,
                                       org.apache.cxf.Bus bus)

Read the Swagger-specific properties from the property file (to seamlessly support the migration from older Swagger features).

Parameters:

location - property file location

bus - bus instance

Returns:

the properties if available