Class CommerceOpenApiWebMvcResource

java.lang.Object
io.swagger.v3.core.filter.SpecFilter
org.springdoc.api.AbstractOpenApiResource
org.springdoc.webmvc.api.OpenApiResource
org.springdoc.webmvc.api.OpenApiWebMvcResource
de.hybris.platform.swaggerintegration.config.CommerceOpenApiWebMvcResource
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class CommerceOpenApiWebMvcResource extends org.springdoc.webmvc.api.OpenApiWebMvcResource implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
Commerce implementation of interface OpenApiResource. AbstractOpenApiResource.isRestController(Map, HandlerMethod, String) is overridden such that the controller beans are searched from the parent context because controllers of OCC extensions are imported into the parent context of the servlet context.
Since:
2211
  • Field Summary

    Fields inherited from class org.springdoc.api.AbstractOpenApiResource

    groupName, openAPIService, springDocConfigProperties, springDocProviders
  • Constructor Summary

    Constructors
    Constructor
    Description
    CommerceOpenApiWebMvcResource(String groupName, org.springframework.beans.factory.ObjectFactory<org.springdoc.core.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.AbstractRequestService requestBuilder, org.springdoc.core.GenericResponseService responseBuilder, org.springdoc.core.OperationService operationParser, List<org.springdoc.core.customizers.OperationCustomizer> operationCustomizers, List<org.springdoc.core.customizers.OpenApiCustomiser> openApiCustomisers, List<org.springdoc.core.filters.OpenApiMethodFilter> methodFilters, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SpringDocProviders springDocProviders)
     
    CommerceOpenApiWebMvcResource(org.springframework.beans.factory.ObjectFactory<org.springdoc.core.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.AbstractRequestService requestBuilder, org.springdoc.core.GenericResponseService responseBuilder, org.springdoc.core.OperationService operationParser, List<org.springdoc.core.customizers.OperationCustomizer> operationCustomizers, List<org.springdoc.core.customizers.OpenApiCustomiser> openApiCustomisers, List<org.springdoc.core.filters.OpenApiMethodFilter> methodFilters, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SpringDocProviders springDocProviders)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    protected boolean
     
    protected boolean
    isRestController(Map<String,Object> restControllers, org.springframework.web.method.HandlerMethod handlerMethod, String operationPath)
    Is rest controller boolean.
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     

    Methods inherited from class org.springdoc.webmvc.api.OpenApiWebMvcResource

    getServerUrl, openapiJson, openapiYaml

    Methods inherited from class org.springdoc.webmvc.api.OpenApiResource

    calculatePath, calculateServerUrl, getPaths

    Methods inherited from class org.springdoc.api.AbstractOpenApiResource

    addHiddenRestControllers, addHiddenRestControllers, addRestControllers, calculatePath, calculatePath, calculatePath, calculatePath, containsResponseBody, customiseOperation, decode, getActuatorURI, getDefaultAllowedHttpMethods, getOpenApi, getRouterFunctionPaths, initOpenAPIBuilder, isActuatorRestController, isAdditionalRestController, isConditionToMatch, isFilterCondition, isHiddenRestControllers, isMethodToFilter, isPackageToScan, isPathToMatch, mergeRouters, setModelAndViewClass, writeJsonValue, writeYamlValue

    Methods inherited from class io.swagger.v3.core.filter.SpecFilter

    filter, filterComponentsSchema, filterOpenAPI, filterOperation, filterParameter, filterPathItem, filterRequestBody, filterResponse, locateReferencedDefinitions, removeBrokenReferenceDefinitions, resolveAllNestedRefs

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • CommerceOpenApiWebMvcResource

      public CommerceOpenApiWebMvcResource(String groupName, org.springframework.beans.factory.ObjectFactory<org.springdoc.core.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.AbstractRequestService requestBuilder, org.springdoc.core.GenericResponseService responseBuilder, org.springdoc.core.OperationService operationParser, List<org.springdoc.core.customizers.OperationCustomizer> operationCustomizers, List<org.springdoc.core.customizers.OpenApiCustomiser> openApiCustomisers, List<org.springdoc.core.filters.OpenApiMethodFilter> methodFilters, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SpringDocProviders springDocProviders)
    • CommerceOpenApiWebMvcResource

      public CommerceOpenApiWebMvcResource(org.springframework.beans.factory.ObjectFactory<org.springdoc.core.OpenAPIService> openAPIBuilderObjectFactory, org.springdoc.core.AbstractRequestService requestBuilder, org.springdoc.core.GenericResponseService responseBuilder, org.springdoc.core.OperationService operationParser, List<org.springdoc.core.customizers.OperationCustomizer> operationCustomizers, List<org.springdoc.core.customizers.OpenApiCustomiser> openApiCustomisers, List<org.springdoc.core.filters.OpenApiMethodFilter> methodFilters, org.springdoc.core.SpringDocConfigProperties springDocConfigProperties, org.springdoc.core.SpringDocProviders springDocProviders)
  • Method Details

    • isRestController

      protected boolean isRestController(Map<String,Object> restControllers, org.springframework.web.method.HandlerMethod handlerMethod, String operationPath)
      Is rest controller boolean.
      Overrides:
      isRestController in class org.springdoc.api.AbstractOpenApiResource
      Parameters:
      restControllers - the rest controllers
      handlerMethod - the handler method
      operationPath - the operation path
      Returns:
      the boolean
    • isInParentControllers

      protected boolean isInParentControllers(String beanName)
    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception
    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Throws:
      org.springframework.beans.BeansException