org.springdoc.core

Class ActuatorProvider

java.lang.Object

org.springdoc.core.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

Fields

Modifier and Type	Field and Description
protected org.springframework.boot.web.server.WebServer	actuatorWebServer The Actuator web server.
protected org.springframework.boot.web.server.WebServer	applicationWebServer The Application web server.
protected org.springframework.context.ApplicationContext	managementApplicationContext The Management application context.
protected org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties	managementServerProperties The Management server properties.
protected org.springframework.boot.autoconfigure.web.ServerProperties	serverProperties The Server properties.
protected SpringDocConfigProperties	springDocConfigProperties The Spring doc config properties.
protected org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties	webEndpointProperties The Web endpoint properties.

Constructor Summary

Constructors

Constructor and Description

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.

Method Summary

Modifier and Type	Method and Description
String	getActuatorPath() Gets actuator path.
int	getActuatorPort() Gets actuator port.
int	getApplicationPort() Gets application port.
String	getBasePath() Gets base path.
String	getContextPath() Gets context path.
abstract Map	getMethods() Gets methods.
static io.swagger.v3.oas.models.tags.Tag	getTag() Gets tag.
boolean	isRestController(String operationPath, Class<?> controllerClass) Is rest controller boolean.
boolean	isUseManagementPort() 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

forPayload

Field Detail

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.

Constructor Detail

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 properties

webEndpointProperties - the web endpoint properties

serverProperties - the server properties

springDocConfigProperties - the spring doc config properties

Method Detail

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>

getTag

public static io.swagger.v3.oas.models.tags.Tag getTag()

Gets tag.

Returns:

the tag

isRestController

public boolean isRestController(String operationPath,
                                Class<?> controllerClass)

Is rest controller boolean.

Parameters:

operationPath - the operation path

controllerClass - the controller class

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