Package org.apache.cxf.jaxrs.openapi
Class OpenApiFeature.Portable
- java.lang.Object
-
- org.apache.cxf.jaxrs.openapi.OpenApiFeature.Portable
-
- All Implemented Interfaces:
org.apache.cxf.feature.AbstractPortableFeature
,org.apache.cxf.feature.Feature
,org.apache.cxf.jaxrs.common.openapi.SwaggerProperties
,org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
- Enclosing class:
- OpenApiFeature
public static class OpenApiFeature.Portable extends Object implements org.apache.cxf.feature.AbstractPortableFeature, org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport, org.apache.cxf.jaxrs.common.openapi.SwaggerProperties
-
-
Field Summary
-
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 Description Portable()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
findSwaggerUiRoot()
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()
String
getScannerClass()
Map<String,io.swagger.v3.oas.models.security.SecurityScheme>
getSecurityDefinitions()
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()
boolean
isUseContextBasedConfig()
protected void
registerOpenApiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Set<String> packages, io.swagger.v3.oas.integration.api.OpenAPIConfiguration config)
protected void
registerServletConfigProvider(org.apache.cxf.jaxrs.provider.ServerProviderFactory factory)
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
setScannerClass(String scannerClass)
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
setUseContextBasedConfig(boolean useContextBasedConfig)
void
setVersion(String version)
-
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
-
-
-
-
Method Detail
-
initialize
public void initialize(org.apache.cxf.endpoint.Server server, org.apache.cxf.Bus bus)
- Specified by:
initialize
in interfaceorg.apache.cxf.feature.AbstractPortableFeature
- Specified by:
initialize
in interfaceorg.apache.cxf.feature.Feature
-
isScan
public boolean isScan()
-
setScan
public void setScan(boolean scan)
-
getFilterClass
public String getFilterClass()
-
setFilterClass
public void setFilterClass(String filterClass)
-
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)
-
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 interfaceorg.apache.cxf.jaxrs.swagger.ui.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 interfaceorg.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
-
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)
-
setUseContextBasedConfig
public void setUseContextBasedConfig(boolean useContextBasedConfig)
-
isUseContextBasedConfig
public boolean isUseContextBasedConfig()
-
getScannerClass
public String getScannerClass()
-
setScannerClass
public void setScannerClass(String scannerClass)
-
getSwaggerUiConfig
public org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig getSwaggerUiConfig()
- Specified by:
getSwaggerUiConfig
in interfaceorg.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
-
findSwaggerUiRoot
public String findSwaggerUiRoot()
- Specified by:
findSwaggerUiRoot
in interfaceorg.apache.cxf.jaxrs.swagger.ui.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)
-
registerServletConfigProvider
protected void registerServletConfigProvider(org.apache.cxf.jaxrs.provider.ServerProviderFactory factory)
-
registerSwaggerUiResources
protected void registerSwaggerUiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Properties properties, org.apache.cxf.jaxrs.provider.ServerProviderFactory factory, org.apache.cxf.Bus bus)
-
-