org.apache.cxf.jaxrs.swagger

Class Swagger2Feature

java.lang.Object

javax.xml.ws.WebServiceFeature

org.apache.cxf.feature.AbstractFeature

org.apache.cxf.feature.DelegatingFeature<T>

org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature<Swagger2Feature.Portable>

org.apache.cxf.jaxrs.swagger.Swagger2Feature

All Implemented Interfaces:

AbstractPortableFeature, Feature, SwaggerProperties, SwaggerUiSupport

public class Swagger2Feature
extends AbstractSwaggerFeature<Swagger2Feature.Portable>
implements SwaggerUiSupport, SwaggerProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Swagger2Feature.Portable
protected static class	Swagger2Feature.SwaggerContainerRequestFilter

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

SwaggerUiSupport.Registration

Field Summary

Fields inherited from class org.apache.cxf.feature.DelegatingFeature

delegate

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

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

SUPPORT_UI_PROPERTY

Fields inherited from interface org.apache.cxf.jaxrs.common.openapi.SwaggerProperties

CONTACT_PROPERTY, DEFAULT_LICENSE_URL, DEFAULT_LICENSE_VALUE, DEFAULT_PROPS_LOCATION, DESCRIPTION_PROPERTY, FILTER_CLASS_PROPERTY, LICENSE_PROPERTY, LICENSE_URL_PROPERTY, PRETTY_PRINT_PROPERTY, RESOURCE_PACKAGE_PROPERTY, TERMS_URL_PROPERTY, TITLE_PROPERTY, VERSION_PROPERTY

Constructor Summary

Constructors

Constructor and Description
Swagger2Feature()

Method Summary

Modifier and Type	Method and Description
void	addSwaggerResource(Server server, Bus bus)
void	calculateDefaultBasePath(Server server)
String	findSwaggerUiRoot() Detects the Swagger UI in root with respect to properties and configuration provided.
Swagger2Customizer	getCustomizer()
protected Swagger2Feature.Portable	getDelegate()
String	getHost()
String	getIgnoreRoutes()
String	getPropertiesLocation()
String[]	getSchemes()
SwaggerUiConfig	getSwaggerUiConfig() Returns Swagger UI configuration parameters.
Map<String,String>	getSwaggerUiMediaTypes() Returns media types supported by Swagger UI
void	initBeanConfig(io.swagger.jaxrs.config.BeanConfig beanConfig, Properties props)
Boolean	isPrettyPrint()
boolean	isScan()
boolean	isScanAllResources()
Boolean	isSupportSwaggerUi() Checks if Swagger UI support is available or not.
Boolean	isUsePathBasedConfig()
void	setBasePathByAddress(String address)
void	setCustomizer(Swagger2Customizer customizer)
void	setHost(String host)
void	setIgnoreRoutes(String ignoreRoutes)
void	setPrettyPrint(Boolean prettyPrint)
void	setPropertiesLocation(String propertiesLocation)
void	setScan(boolean scan)
void	setScanAllResources(boolean scanAllResources)
void	setSchemes(String[] schemes)
void	setSecurityDefinitions(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> securityDefinitions)
void	setSupportSwaggerUi(boolean supportSwaggerUi)
void	setSwaggerUiConfig(SwaggerUiConfig swaggerUiConfig)
void	setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)
void	setSwaggerUiMediaTypes(Map<String,String> swaggerUiMediaTypes)
void	setSwaggerUiVersion(String swaggerUiVersion)
void	setUsePathBasedConfig(Boolean usePathBasedConfig)

Methods inherited from class org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature

calculateDefaultResourcePackage, getBasePath, getContact, getDescription, getFilterClass, getLicense, getLicenseUrl, getResourcePackage, getTermsOfServiceUrl, getTitle, getVersion, isActivateOnlyIfJaxrsSupported, isRunAsFilter, isSwaggerJaxRsAvailable, setActivateOnlyIfJaxrsSupported, setBasePath, setContact, setDescription, setFilterClass, setLicense, setLicenseUrl, setResourcePackage, setRunAsFilter, setTermsOfServiceUrl, setTitle, setVersion

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

initialize, initialize, initialize, initialize, initializeProvider, setDelegate

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

doInitializeProvider, getActive, getID, 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.ui.SwaggerUiSupport

checkSupportSwaggerUiProp, getSwaggerUi

Methods inherited from interface org.apache.cxf.jaxrs.common.openapi.SwaggerProperties

getSwaggerProperties

Constructor Detail

Swagger2Feature

public Swagger2Feature()

Method Detail

getDelegate

protected Swagger2Feature.Portable getDelegate()

Overrides:

getDelegate in class DelegatingFeature<Swagger2Feature.Portable>

calculateDefaultBasePath

public void calculateDefaultBasePath(Server server)

Overrides:

calculateDefaultBasePath in class AbstractSwaggerFeature<Swagger2Feature.Portable>

addSwaggerResource

public void addSwaggerResource(Server server,
                               Bus bus)

Overrides:

addSwaggerResource in class AbstractSwaggerFeature<Swagger2Feature.Portable>

initBeanConfig

public void initBeanConfig(io.swagger.jaxrs.config.BeanConfig beanConfig,
                           Properties props)

isUsePathBasedConfig

public Boolean isUsePathBasedConfig()

setUsePathBasedConfig

public void setUsePathBasedConfig(Boolean usePathBasedConfig)

getHost

public String getHost()

setHost

public void setHost(String host)

getSchemes

public String[] getSchemes()

setSchemes

public void setSchemes(String[] schemes)

isPrettyPrint

public Boolean isPrettyPrint()

setPrettyPrint

public void setPrettyPrint(Boolean prettyPrint)

getCustomizer

public Swagger2Customizer getCustomizer()

setCustomizer

public void setCustomizer(Swagger2Customizer customizer)

isScanAllResources

public boolean isScanAllResources()

setScanAllResources

public void setScanAllResources(boolean scanAllResources)

getIgnoreRoutes

public String getIgnoreRoutes()

setIgnoreRoutes

public void setIgnoreRoutes(String ignoreRoutes)

setBasePathByAddress

public void setBasePathByAddress(String address)

Overrides:

setBasePathByAddress in class AbstractSwaggerFeature<Swagger2Feature.Portable>

setSwaggerUiMavenGroupAndArtifact

public void setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)

setSwaggerUiVersion

public void setSwaggerUiVersion(String swaggerUiVersion)

setSupportSwaggerUi

public void setSupportSwaggerUi(boolean supportSwaggerUi)

isSupportSwaggerUi

public Boolean isSupportSwaggerUi()

Description copied from interface: SwaggerUiSupport

Checks if Swagger UI support is available or not.

Specified by:

isSupportSwaggerUi in interface SwaggerUiSupport

Returns:

"true" if Swagger UI support is available, "false" otherwise

setSwaggerUiMediaTypes

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

getSwaggerUiMediaTypes

public Map<String,String> getSwaggerUiMediaTypes()

Description copied from interface: SwaggerUiSupport

Returns media types supported by Swagger UI

Specified by:

getSwaggerUiMediaTypes in interface SwaggerUiSupport

Returns:

media types supported by Swagger UI

setSecurityDefinitions

public void setSecurityDefinitions(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> securityDefinitions)

getPropertiesLocation

public String getPropertiesLocation()

setPropertiesLocation

public void setPropertiesLocation(String propertiesLocation)

isScan

public boolean isScan()

setScan

public void setScan(boolean scan)

setSwaggerUiConfig

public void setSwaggerUiConfig(SwaggerUiConfig swaggerUiConfig)

getSwaggerUiConfig

public SwaggerUiConfig getSwaggerUiConfig()

Description copied from interface: SwaggerUiSupport

Returns Swagger UI configuration parameters.

Specified by:

getSwaggerUiConfig in interface SwaggerUiSupport

Returns:

Swagger UI configuration parameters or "null" if not available

findSwaggerUiRoot

public String findSwaggerUiRoot()

Description copied from interface: SwaggerUiSupport

Detects the Swagger UI in root with respect to properties and configuration provided.

Specified by:

findSwaggerUiRoot in interface SwaggerUiSupport

Returns:

Swagger UI in root or "null" if not available