org.springframework.cloud.deployer.spi.app

Interface ActuatorOperations

All Known Implementing Classes:

AbstractActuatorTemplate

public interface ActuatorOperations

Deployers may implement this extension to invoke actuator endpoints of deployed app instances.

Author:

David Turanski

Method Summary

Modifier and Type	Method and Description
default String	getFromActuator(String deploymentId, String guid, String endpoint) Get a resource from an actuator path.
default <T> T	getFromActuator(String deploymentId, String guid, String endpoint, Class<T> responseType) Get a resource from an actuator path.
<T> T	getFromActuator(String deploymentId, String guid, String endpoint, Class<T> responseType, Optional<org.springframework.http.HttpHeaders> requestHeaders) Get a resource from an actuator path.
default String	getFromActuator(String deploymentId, String guid, String endpoint, Optional<org.springframework.http.HttpHeaders> requestHeaders) Get a resource from an actuator path.
default <T,R> R	postToActuator(String deploymentId, String guid, String endpoint, T body, Class<R> responseType) Post to resource on actuator path.
<T,R> R	postToActuator(String deploymentId, String guid, String endpoint, T body, Class<R> responseType, Optional<org.springframework.http.HttpHeaders> requestHeaders) Post to resource on actuator path.

Method Detail

getFromActuator

<T> T getFromActuator(String deploymentId,
                      String guid,
                      String endpoint,
                      Class<T> responseType,
                      Optional<org.springframework.http.HttpHeaders> requestHeaders)

Get a resource from an actuator path.

Type Parameters:

T - type of the response.

Parameters:

deploymentId - the deployment ID of the deployed app.

guid - unique id for the app instance.

endpoint - the endpoint path relative to the base actuator URL for the instance, with or without preceding '/'.

responseType - the expected response type.

requestHeaders - optional request headers.

Returns:

the contents as the given type.

getFromActuator

default <T> T getFromActuator(String deploymentId,
                              String guid,
                              String endpoint,
                              Class<T> responseType)

Get a resource from an actuator path.

Type Parameters:

T - type of the response

Parameters:

deploymentId - the deployment ID of the deployed app.

guid - unique id for the app instance.

endpoint - the endpoint path relative to the base actuator URL for the instance, with or without preceding '/'.

responseType - the expected response type.

Returns:

the contents as the given type.

getFromActuator

default String getFromActuator(String deploymentId,
                               String guid,
                               String endpoint,
                               Optional<org.springframework.http.HttpHeaders> requestHeaders)

Get a resource from an actuator path.

Parameters:

deploymentId - the deployment ID of the deployed app.

guid - unique id for the app instance.

endpoint - the endpoint path relative to the base actuator URL for the instance, with or without preceding '/'.

requestHeaders - optional request headers.

Returns:

the contents as a String.

getFromActuator

default String getFromActuator(String deploymentId,
                               String guid,
                               String endpoint)

Get a resource from an actuator path.

Parameters:

deploymentId - the deployment ID of the deployed app.

guid - unique id for the app instance.

endpoint - the endpoint path relative to the base actuator URL for the instance, with or without preceding '/'.

Returns:

the contents as a String.

postToActuator

<T,R> R postToActuator(String deploymentId,
                       String guid,
                       String endpoint,
                       T body,
                       Class<R> responseType,
                       Optional<org.springframework.http.HttpHeaders> requestHeaders)

Post to resource on actuator path.

Type Parameters:

T - type of the body.

R - type of the response.

Parameters:

deploymentId - the deployment ID of the deployed app.

guid - unique id for the app instance.

endpoint - the endpoint path relative to the base actuator URL for the instance, with or without preceding '/'.

body - the request body.

responseType - the expected response type.

requestHeaders - optional request headers.

Returns:

the result (response body).

postToActuator

default <T,R> R postToActuator(String deploymentId,
                               String guid,
                               String endpoint,
                               T body,
                               Class<R> responseType)

Post to resource on actuator path.

Type Parameters:

R - the type of the response.

T - the type of the body.

Parameters:

deploymentId - the deployment ID of the deployed app.

guid - unique id for the app instance.

endpoint - the endpoint path relative to the base actuator URL for the instance, with or without preceding '/'.

body - the request body.

responseType - the expected response type.

Returns:

the result (response body).