Package org.apache.cxf.jaxrs.openapi
Class OpenApiFeature
java.lang.Object
jakarta.xml.ws.WebServiceFeature
org.apache.cxf.feature.AbstractFeature
org.apache.cxf.feature.DelegatingFeature<OpenApiFeature.Portable>
org.apache.cxf.jaxrs.openapi.OpenApiFeature
- 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
public class OpenApiFeature
extends org.apache.cxf.feature.DelegatingFeature<OpenApiFeature.Portable>
implements org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport, org.apache.cxf.jaxrs.common.openapi.SwaggerProperties
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
static class
protected static class
Nested classes/interfaces inherited from interface org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport.Registration
-
Field Summary
Fields inherited from class org.apache.cxf.feature.DelegatingFeature
delegate
Fields inherited from class jakarta.xml.ws.WebServiceFeature
enabled
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
-
Method Summary
Modifier and TypeMethodDescriptionstatic Properties
combine
(Properties primary, Properties secondary) io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource
io.swagger.v3.oas.models.info.Info
getInfo
(Properties properties) getOrFallback
(Boolean value, Properties properties, String property) getOrFallback
(String value, Properties properties, String property) getOrFallback
(Set<String> collection, Properties properties, String property) org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig
getTitle()
getUserProperties
(Map<String, Object> userDefinedOptions) boolean
boolean
boolean
boolean
isScan()
boolean
boolean
static Optional<io.swagger.v3.oas.models.Components>
registerComponents
(Map<String, io.swagger.v3.oas.models.security.SecurityScheme> securityDefinitions) void
registerOpenApiResources
(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Set<String> packages, io.swagger.v3.oas.integration.api.OpenAPIConfiguration config) void
registerServletConfigProvider
(org.apache.cxf.jaxrs.provider.ServerProviderFactory factory) void
registerSwaggerUiResources
(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Properties properties, org.apache.cxf.jaxrs.provider.ServerProviderFactory factory, org.apache.cxf.Bus bus) scanResourcePackages
(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb) 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) static void
setOrReplace
(Properties source, Properties destination) 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
void
setUseContextBasedConfig
(boolean useContextBasedConfig) void
setVersion
(String version) Methods inherited from class org.apache.cxf.feature.DelegatingFeature
getDelegate, 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.common.openapi.SwaggerProperties
getSwaggerProperties
Methods inherited from interface org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
checkSupportSwaggerUiProp, getSwaggerUi
-
Constructor Details
-
OpenApiFeature
public OpenApiFeature()
-
-
Method Details
-
isScan
public boolean isScan() -
setScan
public void setScan(boolean scan) -
getFilterClass
-
setFilterClass
-
getResourcePackages
-
setResourcePackages
-
getVersion
-
setVersion
-
getTitle
-
setTitle
-
getDescription
-
setDescription
-
getContactName
-
setContactName
-
getContactEmail
-
setContactEmail
-
getContactUrl
-
setContactUrl
-
getLicense
-
setLicense
-
getLicenseUrl
-
setLicenseUrl
-
getTermsOfServiceUrl
-
setTermsOfServiceUrl
-
isReadAllResources
public boolean isReadAllResources() -
setReadAllResources
public void setReadAllResources(boolean readAllResources) -
getResourceClasses
-
setResourceClasses
-
getIgnoredRoutes
-
setIgnoredRoutes
-
isPrettyPrint
public boolean isPrettyPrint() -
setPrettyPrint
public void setPrettyPrint(boolean prettyPrint) -
isRunAsFilter
public boolean isRunAsFilter() -
isSupportSwaggerUi
- Specified by:
isSupportSwaggerUi
in interfaceorg.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
-
setSupportSwaggerUi
-
getSwaggerUiVersion
-
setSwaggerUiVersion
-
getSwaggerUiMavenGroupAndArtifact
-
setSwaggerUiMavenGroupAndArtifact
-
getSwaggerUiMediaTypes
- Specified by:
getSwaggerUiMediaTypes
in interfaceorg.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
-
setSwaggerUiMediaTypes
-
getConfigLocation
-
setConfigLocation
-
getPropertiesLocation
-
setPropertiesLocation
-
setRunAsFilter
public void setRunAsFilter(boolean runAsFilter) -
getSecurityDefinitions
-
setSecurityDefinitions
-
getCustomizer
-
setCustomizer
-
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
-
setScannerClass
-
getSwaggerUiConfig
public org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig getSwaggerUiConfig()- Specified by:
getSwaggerUiConfig
in interfaceorg.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
-
findSwaggerUiRoot
- Specified by:
findSwaggerUiRoot
in interfaceorg.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport
-
getUserProperties
-
registerOpenApiResources
-
registerServletConfigProvider
public void registerServletConfigProvider(org.apache.cxf.jaxrs.provider.ServerProviderFactory factory) -
registerSwaggerUiResources
public void registerSwaggerUiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb, Properties properties, org.apache.cxf.jaxrs.provider.ServerProviderFactory factory, org.apache.cxf.Bus bus) -
getInfo
-
getOrFallback
-
getOrFallback
-
getOrFallback
-
scanResourcePackages
-
combine
-
setOrReplace
-
registerComponents
-
createOpenApiResource
public io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource createOpenApiResource()
-