org.springframework.cloud.deployer.spi.app

Class AbstractActuatorTemplate

java.lang.Object

org.springframework.cloud.deployer.spi.app.AbstractActuatorTemplate

All Implemented Interfaces:

ActuatorOperations

public abstract class AbstractActuatorTemplate
extends Object
implements ActuatorOperations

Base class for ActuatorTemplate implementations.

Author:

David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
protected AppDeployer	appDeployer
protected org.apache.commons.logging.Log	logger
protected org.springframework.web.client.RestTemplate	restTemplate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractActuatorTemplate(org.springframework.web.client.RestTemplate restTemplate, AppDeployer appDeployer, AppAdmin appAdmin)

Method Summary

Modifier and Type	Method and Description
protected abstract String	actuatorUrlForInstance(AppInstanceStatus appInstanceStatus)
protected String	getActuatorUrl(AppInstanceStatus appInstanceStatus)
<T> T	getFromActuator(String deploymentId, String guid, String endpoint, Class<T> responseType, Optional<org.springframework.http.HttpHeaders> optionalRequestHeaders) Get a resource from an actuator path.
protected Optional<org.springframework.http.HttpHeaders>	httpHeadersForInstance(AppInstanceStatus appInstanceStatus) Hook to allow subclasses to add special headers derived AppInstanceStatus metadata if necessary.
<T,R> R	postToActuator(String deploymentId, String guid, String endpoint, T body, Class<R> responseType, Optional<org.springframework.http.HttpHeaders> optionalRequestHeaders) Post to resource on actuator path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.cloud.deployer.spi.app.ActuatorOperations

getFromActuator, getFromActuator, getFromActuator, postToActuator

Field Detail

logger

protected final org.apache.commons.logging.Log logger

restTemplate

protected final org.springframework.web.client.RestTemplate restTemplate

appDeployer

protected final AppDeployer appDeployer

Constructor Detail

AbstractActuatorTemplate

protected AbstractActuatorTemplate(org.springframework.web.client.RestTemplate restTemplate,
                                   AppDeployer appDeployer,
                                   AppAdmin appAdmin)

Method Detail

getFromActuator

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

Description copied from interface: ActuatorOperations

Get a resource from an actuator path.

Specified by:

getFromActuator in interface ActuatorOperations

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.

optionalRequestHeaders - optional request headers.

Returns:

the contents as the given type.

postToActuator

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

Description copied from interface: ActuatorOperations

Post to resource on actuator path.

Specified by:

postToActuator in interface ActuatorOperations

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.

optionalRequestHeaders - optional request headers.

Returns:

the result (response body).

getActuatorUrl

protected final String getActuatorUrl(AppInstanceStatus appInstanceStatus)

actuatorUrlForInstance

protected abstract String actuatorUrlForInstance(AppInstanceStatus appInstanceStatus)

httpHeadersForInstance

protected Optional<org.springframework.http.HttpHeaders> httpHeadersForInstance(AppInstanceStatus appInstanceStatus)

Hook to allow subclasses to add special headers derived AppInstanceStatus metadata if necessary.

Parameters:

appInstanceStatus - the AppInstanceStatus for the target instance.

Returns:

HttpHeaders