Package org.springdoc.core.providers

Class ActuatorProvider

java.lang.Object
org.springdoc.core.providers.ActuatorProvider
All Implemented Interfaces:
EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.boot.web.context.WebServerInitializedEvent>
public abstract class ActuatorProvider extends Object implements org.springframework.context.ApplicationListener<org.springframework.boot.web.context.WebServerInitializedEvent>, org.springframework.context.ApplicationContextAware
The type Actuator provider.
Author:
bnasslahsen

  • Field Details

    • managementServerProperties

      protected org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties managementServerProperties
      The Management server properties.

    • webEndpointProperties

      protected org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointProperties
      The Web endpoint properties.

    • serverProperties

      protected org.springframework.boot.autoconfigure.web.ServerProperties serverProperties
      The Server properties.

    • springDocConfigProperties

      protected SpringDocConfigProperties springDocConfigProperties
      The Spring doc config properties.

    • actuatorWebServer

      protected org.springframework.boot.web.server.WebServer actuatorWebServer
      The Actuator web server.

    • applicationWebServer

      protected org.springframework.boot.web.server.WebServer applicationWebServer
      The Application web server.

    • managementApplicationContext

      protected org.springframework.context.ApplicationContext managementApplicationContext
      The Management application context.

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext
      The Application context.

  • Constructor Details

    • ActuatorProvider

      protected ActuatorProvider(Optional<org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties> managementServerProperties, Optional<org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties> webEndpointProperties, org.springframework.boot.autoconfigure.web.ServerProperties serverProperties, SpringDocConfigProperties springDocConfigProperties)
      Instantiates a new Actuator provider.
      Parameters:
      managementServerProperties - the management server properties
      webEndpointProperties - the web endpoint properties
      serverProperties - the server properties
      springDocConfigProperties - the spring doc config properties

  • Method Details

    • getTag

      public static io.swagger.v3.oas.models.tags.Tag getTag()
      Gets tag.
      Returns:
      the tag

    • onApplicationEvent

      public void onApplicationEvent(org.springframework.boot.web.context.WebServerInitializedEvent event)
      Specified by:
      onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.boot.web.context.WebServerInitializedEvent>

    • isRestController

      public boolean isRestController(String operationPath, org.springframework.web.method.HandlerMethod handlerMethod)
      Is rest controller boolean.
      Parameters:
      operationPath - the operation path
      handlerMethod - the handler method
      Returns:
      the boolean

    • isUseManagementPort

      public boolean isUseManagementPort()
      Is use management port boolean.
      Returns:
      the boolean

    • getBasePath

      public String getBasePath()
      Gets base path.
      Returns:
      the base path

    • getContextPath

      public String getContextPath()
      Gets context path.
      Returns:
      the context path

    • getActuatorPath

      public String getActuatorPath()
      Gets actuator path.
      Returns:
      the actuator path

    • getApplicationPort

      public int getApplicationPort()
      Gets application port.
      Returns:
      the application port

    • getActuatorPort

      public int getActuatorPort()
      Gets actuator port.
      Returns:
      the actuator port

    • getMethods

      public abstract Map getMethods()
      Gets methods.
      Returns:
      the methods

    • 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