Package org.springdoc.core.providers
Class ActuatorProvider
java.lang.Object
org.springdoc.core.providers.ActuatorProvider
- All Implemented Interfaces:
EventListener
,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>
The type Actuator provider.
- Author:
- bnasslahsen
-
Field Summary
Modifier and TypeFieldDescriptionprotected org.springframework.boot.web.server.WebServer
The Actuator web server.protected org.springframework.boot.web.server.WebServer
The Application web server.protected org.springframework.context.ApplicationContext
The Management application context.protected org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties
The Management server properties.protected org.springframework.boot.autoconfigure.web.ServerProperties
The Server properties.protected SpringDocConfigProperties
The Spring doc config properties.protected org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties
The Web endpoint properties. -
Constructor Summary
ConstructorDescriptionActuatorProvider
(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. -
Method Summary
Modifier and TypeMethodDescriptionGets actuator path.int
Gets actuator port.int
Gets application port.Gets base path.Gets context path.abstract Map
Gets methods.static io.swagger.v3.oas.models.tags.Tag
getTag()
Gets tag.boolean
isRestController
(String operationPath, org.springframework.web.method.HandlerMethod handlerMethod) Is rest controller boolean.boolean
Is use management port boolean.void
onApplicationEvent
(org.springframework.boot.web.context.WebServerInitializedEvent event) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.context.ApplicationListener
supportsAsyncExecution
-
Field Details
-
managementServerProperties
protected org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties managementServerPropertiesThe Management server properties. -
webEndpointProperties
protected org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties webEndpointPropertiesThe Web endpoint properties. -
serverProperties
protected org.springframework.boot.autoconfigure.web.ServerProperties serverPropertiesThe Server properties. -
springDocConfigProperties
The Spring doc config properties. -
actuatorWebServer
protected org.springframework.boot.web.server.WebServer actuatorWebServerThe Actuator web server. -
applicationWebServer
protected org.springframework.boot.web.server.WebServer applicationWebServerThe Application web server. -
managementApplicationContext
protected org.springframework.context.ApplicationContext managementApplicationContextThe Management application context.
-
-
Constructor Details
-
ActuatorProvider
public 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 propertieswebEndpointProperties
- the web endpoint propertiesserverProperties
- the server propertiesspringDocConfigProperties
- 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 interfaceorg.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 pathhandlerMethod
- the handler method- Returns:
- the boolean
-
isUseManagementPort
public boolean isUseManagementPort()Is use management port boolean.- Returns:
- the boolean
-
getBasePath
Gets base path.- Returns:
- the base path
-
getContextPath
Gets context path.- Returns:
- the context path
-
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
Gets methods.- Returns:
- the methods
-