Package org.apache.cxf.jaxrs.swagger

Class Swagger2Feature.Portable

java.lang.Object

org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature.Portable

org.apache.cxf.jaxrs.swagger.Swagger2Feature.Portable

All Implemented Interfaces:

AbstractPortableFeature, Feature, SwaggerProperties, SwaggerUiSupport

Enclosing class:

Swagger2Feature

public static class Swagger2Feature.Portable
extends AbstractSwaggerFeature.Portable
implements SwaggerUiSupport, SwaggerProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	Swagger2Feature.Portable.ReaderConfigFilter

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

SwaggerUiSupport.Registration

Field Summary

Fields inherited from class org.apache.cxf.jaxrs.swagger.AbstractSwaggerFeature.Portable

licenseWasSet

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

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

SUPPORT_UI_PROPERTY

Constructor Summary

Constructors

Constructor	Description
Portable()

Method Summary

Modifier and Type	Method	Description
protected void	addSwaggerResource(Server server, Bus bus)
protected void	calculateDefaultBasePath(Server server)
String	findSwaggerUiRoot()	Detects the Swagger UI in root with respect to properties and configuration provided.
Swagger2Customizer	getCustomizer()
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
protected 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()
protected 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)	Set SwaggerUI Maven group and artifact using the "groupId/artifactId" format.
void	setSwaggerUiMediaTypes(Map<String,String> swaggerUiMediaTypes)
void	setSwaggerUiVersion(String swaggerUiVersion)
void	setUsePathBasedConfig(Boolean usePathBasedConfig)

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

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

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.feature.AbstractPortableFeature

doInitializeProvider, initialize, initialize, initialize

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

getSwaggerProperties

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

checkSupportSwaggerUiProp, getSwaggerUi

Constructor Detail

Portable

public Portable()

Method Detail

calculateDefaultBasePath

protected void calculateDefaultBasePath(Server server)

Overrides:

calculateDefaultBasePath in class AbstractSwaggerFeature.Portable

addSwaggerResource

protected void addSwaggerResource(Server server,
                                  Bus bus)

Specified by:

addSwaggerResource in class AbstractSwaggerFeature.Portable

initBeanConfig

protected 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

protected void setBasePathByAddress(String address)

Specified by:

setBasePathByAddress in class AbstractSwaggerFeature.Portable

setSwaggerUiMavenGroupAndArtifact

public void setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)

Set SwaggerUI Maven group and artifact using the "groupId/artifactId" format.

Parameters:

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