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:
AbstractPortableFeature, Feature, SwaggerProperties, SwaggerUiSupport
public class OpenApiFeature extends DelegatingFeature<OpenApiFeature.Portable> implements SwaggerUiSupport, SwaggerProperties

  • Constructor Details

    • OpenApiFeature

      public OpenApiFeature()

  • Method Details

    • 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()
      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

    • 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()
      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

    • 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(SwaggerUiConfig swaggerUiConfig)

    • setUseContextBasedConfig

      public void setUseContextBasedConfig(boolean useContextBasedConfig)

    • isUseContextBasedConfig

      public boolean isUseContextBasedConfig()

    • getScannerClass

      public String getScannerClass()

    • setScannerClass

      public void setScannerClass(String scannerClass)

    • 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

    • getUserProperties

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

    • registerOpenApiResources

      public void registerOpenApiResources(JAXRSServiceFactoryBean sfb, Set<String> packages, io.swagger.v3.oas.integration.api.OpenAPIConfiguration config)

    • registerServletConfigProvider

      public void registerServletConfigProvider(ServerProviderFactory factory)

    • registerSwaggerUiResources

      public void registerSwaggerUiResources(JAXRSServiceFactoryBean sfb, Properties properties, ServerProviderFactory factory, Bus bus)

    • getInfo

      public io.swagger.v3.oas.models.info.Info getInfo(Properties properties)

    • getOrFallback

      public String getOrFallback(String value, Properties properties, String property)

    • getOrFallback

      public Boolean getOrFallback(Boolean value, Properties properties, String property)

    • getOrFallback

      public Set<String> getOrFallback(Set<String> collection, Properties properties, String property)

    • scanResourcePackages

      public Collection<String> scanResourcePackages(JAXRSServiceFactoryBean sfb)

    • combine

      public static Properties combine(Properties primary, Properties secondary)

    • setOrReplace

      public static void setOrReplace(Properties source, Properties destination)

    • registerComponents

      public static Optional<io.swagger.v3.oas.models.Components> registerComponents(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> securityDefinitions)

    • createOpenApiResource

      public io.swagger.v3.jaxrs2.integration.resources.BaseOpenApiResource createOpenApiResource()