SpringCloud/spring-cloud-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update to new Boot 2 actuator @Endpoint.

Browse Source 
Some tests are still broken.

Fixes gh-238
This commit is contained in:
Spencer Gibb
2017-09-07 21:21:37 -06:00
parent 752148fea5
commit f8d9e18fb9
20 changed files with 219 additions and 399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-cloud-commons/src/main/java/org/springframework/cloud/client/CommonsClientAutoConfiguration.java
View File

@@ -20,7 +20,7 @@ import java.util.ArrayList;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.endpoint.Endpoint;
import org.springframework.boot.actuate.autoconfigure.endpoint.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.health.HealthAggregator;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.boot.autoconfigure.AutoConfigureOrder;
@@ -29,6 +29,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.cloud.client.actuator.FeaturesEndpoint;
import org.springframework.cloud.client.actuator.HasFeatures;
import org.springframework.cloud.client.discovery.DiscoveryClient;
@@ -85,6 +86,7 @@ public class CommonsClientAutoConfiguration {
private List<HasFeatures> hasFeatures = new ArrayList<>();
@Bean
@ConditionalOnEnabledEndpoint
public FeaturesEndpoint featuresEndpoint() {
return new FeaturesEndpoint(this.hasFeatures);
}

13
spring-cloud-commons/src/main/java/org/springframework/cloud/client/actuator/FeaturesEndpoint.java
View File

@@ -21,8 +21,8 @@ import java.util.List;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.boot.actuate.endpoint.AbstractEndpoint;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.boot.endpoint.ReadOperation;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
@@ -30,15 +30,14 @@ import org.springframework.context.ApplicationContextAware;
/**
* @author Spencer Gibb
*/
@ConfigurationProperties(prefix = "endpoints.features", ignoreUnknownFields = false)
public class FeaturesEndpoint extends AbstractEndpoint<FeaturesEndpoint.Features>
@Endpoint(id = "features")
public class FeaturesEndpoint
implements ApplicationContextAware {
private final List<HasFeatures> hasFeaturesList;
private ApplicationContext context;
public FeaturesEndpoint(List<HasFeatures> hasFeaturesList) {
super("features", false);
this.hasFeaturesList = hasFeaturesList;
}
@@ -47,8 +46,8 @@ public class FeaturesEndpoint extends AbstractEndpoint<FeaturesEndpoint.Features
this.context = context;
}
@Override
public Features invoke() {
@ReadOperation
public Features features() {
Features features = new Features();
for (HasFeatures hasFeatures : this.hasFeaturesList) {

6
spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/ManagementServerPortUtils.java
View File

@@ -18,12 +18,12 @@ package org.springframework.cloud.client.discovery;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.boot.actuate.autoconfigure.ManagementServerProperties;
import org.springframework.boot.actuate.autoconfigure.web.ManagementServerProperties;
import org.springframework.boot.autoconfigure.web.ServerProperties;
import org.springframework.web.context.WebApplicationContext;
/**
*
* FIXME:
* @author Spencer Gibb
*/
public class ManagementServerPortUtils {
@@ -31,7 +31,7 @@ public class ManagementServerPortUtils {
static {
boolean hasClass;
try {
Class.forName("org.springframework.boot.actuate.autoconfigure.ManagementServerProperties");
Class.forName("org.springframework.boot.endpoint.Endpoint");
hasClass = true;
} catch (ClassNotFoundException e) {
hasClass = false;

4
spring-cloud-commons/src/main/java/org/springframework/cloud/client/serviceregistry/ServiceRegistryAutoConfiguration.java
View File

@@ -1,9 +1,10 @@
package org.springframework.cloud.client.serviceregistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.endpoint.Endpoint;
import org.springframework.boot.actuate.autoconfigure.endpoint.ConditionalOnEnabledEndpoint;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.cloud.client.serviceregistry.endpoint.ServiceRegistryEndpoint;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@@ -21,6 +22,7 @@ public class ServiceRegistryAutoConfiguration {
private Registration registration;
@Bean
@ConditionalOnEnabledEndpoint
public ServiceRegistryEndpoint serviceRegistryEndpoint(ServiceRegistry serviceRegistry) {
ServiceRegistryEndpoint endpoint = new ServiceRegistryEndpoint(serviceRegistry);
endpoint.setRegistration(registration);

40
spring-cloud-commons/src/main/java/org/springframework/cloud/client/serviceregistry/endpoint/ServiceRegistryEndpoint.java
View File

@@ -17,29 +17,23 @@
package org.springframework.cloud.client.serviceregistry.endpoint;
import org.springframework.boot.actuate.endpoint.Endpoint;
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.boot.endpoint.ReadOperation;
import org.springframework.boot.endpoint.WriteOperation;
import org.springframework.cloud.client.serviceregistry.Registration;
import org.springframework.cloud.client.serviceregistry.ServiceRegistry;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.jmx.export.annotation.ManagedAttribute;
import org.springframework.jmx.export.annotation.ManagedOperation;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.util.Assert;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* Endpoint to display and set the service instance status using the service registry.
*
* @author Spencer Gibb
*/
@ManagedResource(description = "Can be used to display and set the service instance status using the service registry")
@SuppressWarnings("unchecked")
public class ServiceRegistryEndpoint implements MvcEndpoint {
@Endpoint(id = "service-registry")
public class ServiceRegistryEndpoint {
private final ServiceRegistry serviceRegistry;
@@ -53,10 +47,8 @@ public class ServiceRegistryEndpoint implements MvcEndpoint {
this.registration = registration;
}
@RequestMapping(path = "instance-status", method = RequestMethod.POST)
@ResponseBody
@ManagedOperation
public ResponseEntity<?> setStatus(@RequestBody String status) {
@WriteOperation
public ResponseEntity<?> setStatus(String status) {
Assert.notNull(status, "status may not by null");
if (this.registration == null) {
@@ -67,9 +59,7 @@ public class ServiceRegistryEndpoint implements MvcEndpoint {
return ResponseEntity.ok().build();
}
@RequestMapping(path = "instance-status", method = RequestMethod.GET)
@ResponseBody
@ManagedAttribute
@ReadOperation
public ResponseEntity getStatus() {
if (this.registration == null) {
return ResponseEntity.status(HttpStatus.NOT_FOUND).body("no registration found");
@@ -78,18 +68,4 @@ public class ServiceRegistryEndpoint implements MvcEndpoint {
return ResponseEntity.ok().body(this.serviceRegistry.getStatus(this.registration));
}
@Override
public String getPath() {
return "/service-registry";
}
@Override
public boolean isSensitive() {
return true;
}
@Override
public Class<? extends Endpoint<?>> getEndpointType() {
return null;
}
}

2
spring-cloud-commons/src/test/java/org/springframework/cloud/client/actuator/FeaturesEndpointTests.java
View File

@@ -43,7 +43,7 @@ public class FeaturesEndpointTests {
@Test
public void invokeWorks() {
FeaturesEndpoint.Features features = this.context.getBean(FeaturesEndpoint.class)
.invoke();
.features();
assertThat(features, is(notNullValue()));
assertThat(features.getEnabled().size(), is(equalTo(2)));
assertThat(features.getDisabled().size(), is(equalTo(1)));

2
spring-cloud-commons/src/test/java/org/springframework/cloud/client/serviceregistry/AbstractAutoServiceRegistrationTests.java
View File

@@ -5,7 +5,7 @@ import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.autoconfigure.LocalManagementPort;
import org.springframework.boot.actuate.web.server.LocalManagementPort;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort;

4
spring-cloud-commons/src/test/java/org/springframework/cloud/client/serviceregistry/endpoint/ServiceRegistryEndpointNoRegistrationTests.java
View File

@@ -4,7 +4,7 @@ import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.autoconfigure.EndpointWebMvcAutoConfiguration;
import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration;
import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration;
import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
@@ -52,7 +52,7 @@ public class ServiceRegistryEndpointNoRegistrationTests {
@Import({JacksonAutoConfiguration.class,
HttpMessageConvertersAutoConfiguration.class,
EndpointWebMvcAutoConfiguration.class, WebMvcAutoConfiguration.class,
EndpointAutoConfiguration.class, WebMvcAutoConfiguration.class,
// ManagementServerPropertiesAutoConfiguration.class
})
@Configuration

4
spring-cloud-commons/src/test/java/org/springframework/cloud/client/serviceregistry/endpoint/ServiceRegistryEndpointTests.java
View File

@@ -4,7 +4,7 @@ import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.autoconfigure.EndpointWebMvcAutoConfiguration;
import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration;
import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration;
import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
@@ -64,7 +64,7 @@ public class ServiceRegistryEndpointTests {
@Import({JacksonAutoConfiguration.class,
HttpMessageConvertersAutoConfiguration.class,
EndpointWebMvcAutoConfiguration.class, WebMvcAutoConfiguration.class,
EndpointAutoConfiguration.class, WebMvcAutoConfiguration.class,
// ManagementServerPropertiesAutoConfiguration.class
})
@Configuration

43
spring-cloud-context/src/main/java/org/springframework/cloud/autoconfigure/LifecycleMvcEndpointAutoConfiguration.java
View File

@@ -15,21 +15,15 @@
*/
package org.springframework.cloud.autoconfigure;
import org.springframework.boot.actuate.condition.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.autoconfigure.endpoint.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.endpoint.EnvironmentEndpoint;
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
import org.springframework.cloud.context.environment.EnvironmentManager;
import org.springframework.cloud.context.environment.EnvironmentManagerMvcEndpoint;
import org.springframework.cloud.context.restart.RestartEndpoint;
import org.springframework.cloud.context.restart.RestartMvcEndpoint;
import org.springframework.cloud.endpoint.GenericPostableMvcEndpoint;
import org.springframework.cloud.endpoint.RefreshEndpoint;
import org.springframework.cloud.context.environment.EnvironmentWebEndpointExtension;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@@ -44,41 +38,16 @@ import org.springframework.context.annotation.Configuration;
@Configuration
@ConditionalOnClass(EnvironmentEndpoint.class)
@ConditionalOnWebApplication
//TODO: support reactive
@AutoConfigureAfter({ WebMvcAutoConfiguration.class,
RefreshEndpointAutoConfiguration.class })
public class LifecycleMvcEndpointAutoConfiguration {
@Bean
@ConditionalOnBean(EnvironmentEndpoint.class)
@ConditionalOnEnabledEndpoint(value = "env.post")
public EnvironmentManagerMvcEndpoint environmentManagerEndpoint(
EnvironmentEndpoint delegate, EnvironmentManager environment) {
return new EnvironmentManagerMvcEndpoint(delegate, environment);
}
@Bean
@ConditionalOnBean(RefreshEndpoint.class)
public MvcEndpoint refreshMvcEndpoint(RefreshEndpoint endpoint) {
return new GenericPostableMvcEndpoint(endpoint);
}
@Bean
@ConditionalOnBean(RestartEndpoint.class)
public RestartMvcEndpoint restartMvcEndpoint(RestartEndpoint restartEndpoint) {
return new RestartMvcEndpoint(restartEndpoint);
}
@Bean
@ConditionalOnBean(RestartEndpoint.PauseEndpoint.class)
public MvcEndpoint pauseMvcEndpoint(RestartEndpoint.PauseEndpoint pauseEndpoint) {
return new GenericPostableMvcEndpoint(pauseEndpoint);
}
@Bean
@ConditionalOnBean(RestartEndpoint.ResumeEndpoint.class)
public MvcEndpoint resumeMvcEndpoint(RestartEndpoint.ResumeEndpoint resumeEndpoint) {
return new GenericPostableMvcEndpoint(resumeEndpoint);
@ConditionalOnEnabledEndpoint
public EnvironmentWebEndpointExtension environmentWebEndpointExtension(
EnvironmentManager environment) {
return new EnvironmentWebEndpointExtension(environment);
}
}

123
spring-cloud-context/src/main/java/org/springframework/cloud/autoconfigure/RefreshEndpointAutoConfiguration.java
View File

@@ -17,16 +17,15 @@
package org.springframework.cloud.autoconfigure;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.autoconfigure.ConditionalOnEnabledHealthIndicator;
import org.springframework.boot.actuate.autoconfigure.EndpointAutoConfiguration;
import org.springframework.boot.actuate.condition.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.endpoint.Endpoint;
import org.springframework.boot.actuate.autoconfigure.endpoint.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration;
import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.cloud.bootstrap.config.PropertySourceBootstrapConfiguration;
import org.springframework.cloud.context.properties.ConfigurationPropertiesRebinder;
import org.springframework.cloud.context.refresh.ContextRefresher;
@@ -36,6 +35,7 @@ import org.springframework.cloud.endpoint.RefreshEndpoint;
import org.springframework.cloud.health.RefreshScopeHealthIndicator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.integration.monitor.IntegrationMBeanExporter;
/**
@@ -46,6 +46,9 @@ import org.springframework.integration.monitor.IntegrationMBeanExporter;
@Configuration
@ConditionalOnClass(Endpoint.class)
@AutoConfigureAfter(EndpointAutoConfiguration.class)
@Import({ RestartEndpointWithIntegrationConfiguration.class,
RestartEndpointWithoutIntegrationConfiguration.class,
PauseResumeEndpointsConfiguration.class })
public class RefreshEndpointAutoConfiguration {
@ConditionalOnMissingBean
@@ -56,67 +59,71 @@ public class RefreshEndpointAutoConfiguration {
return new RefreshScopeHealthIndicator(scope, rebinder);
}
@ConditionalOnClass(IntegrationMBeanExporter.class)
@ConditionalOnEnabledEndpoint(value = "restart", enabledByDefault = false)
protected static class RestartEndpointWithIntegration {
@Autowired(required = false)
private IntegrationMBeanExporter exporter;
@Bean
@ConditionalOnMissingBean
public RestartEndpoint restartEndpoint() {
RestartEndpoint endpoint = new RestartEndpoint();
if (this.exporter != null) {
endpoint.setIntegrationMBeanExporter(this.exporter);
}
return endpoint;
}
}
@ConditionalOnMissingClass("org.springframework.integration.monitor.IntegrationMBeanExporter")
@ConditionalOnEnabledEndpoint(value = "restart", enabledByDefault = false)
protected static class RestartEndpointWithoutIntegration {
@Bean
@ConditionalOnMissingBean
public RestartEndpoint restartEndpointWithoutIntegration() {
return new RestartEndpoint();
}
}
@ConditionalOnEnabledEndpoint(value = "restart", enabledByDefault = false)
protected static class PauseResumeEndpoints {
@Bean
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint("pause")
public RestartEndpoint.PauseEndpoint pauseEndpoint(RestartEndpoint restartEndpoint) {
return restartEndpoint.getPauseEndpoint();
}
@Bean
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint("resume")
public RestartEndpoint.ResumeEndpoint resumeEndpoint(RestartEndpoint restartEndpoint) {
return restartEndpoint.getResumeEndpoint();
}
}
@Configuration
@ConditionalOnEnabledEndpoint("refresh")
@ConditionalOnBean(PropertySourceBootstrapConfiguration.class)
protected static class RefreshEndpointConfiguration {
@Bean
@ConditionalOnEnabledEndpoint
@ConditionalOnMissingBean
public RefreshEndpoint refreshEndpoint(ContextRefresher contextRefresher) {
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
return endpoint;
return new RefreshEndpoint(contextRefresher);
}
}
}
@Configuration
@ConditionalOnClass(IntegrationMBeanExporter.class)
class RestartEndpointWithIntegrationConfiguration {
@Autowired(required = false)
private IntegrationMBeanExporter exporter;
@Bean
@ConditionalOnEnabledEndpoint
@ConditionalOnMissingBean
public RestartEndpoint restartEndpoint() {
RestartEndpoint endpoint = new RestartEndpoint();
if (this.exporter != null) {
endpoint.setIntegrationMBeanExporter(this.exporter);
}
return endpoint;
}
}
@Configuration
@ConditionalOnMissingClass("org.springframework.integration.monitor.IntegrationMBeanExporter")
class RestartEndpointWithoutIntegrationConfiguration {
@Bean
@ConditionalOnEnabledEndpoint
@ConditionalOnMissingBean
public RestartEndpoint restartEndpointWithoutIntegration() {
return new RestartEndpoint();
}
}
@Configuration
class PauseResumeEndpointsConfiguration {
@Bean
@ConditionalOnBean(RestartEndpoint.class)
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint
public RestartEndpoint.PauseEndpoint pauseEndpoint(RestartEndpoint restartEndpoint) {
return restartEndpoint.getPauseEndpoint();
}
@Bean
@ConditionalOnBean(RestartEndpoint.class)
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint
public RestartEndpoint.ResumeEndpoint resumeEndpoint(
RestartEndpoint restartEndpoint) {
return restartEndpoint.getResumeEndpoint();
}
}

40
spring-cloud-context/src/main/java/org/springframework/cloud/context/environment/EnvironmentManagerMvcEndpoint.java → spring-cloud-context/src/main/java/org/springframework/cloud/context/environment/EnvironmentWebEndpointExtension.java
View File

@@ -17,13 +17,10 @@ package org.springframework.cloud.context.environment;
import java.util.Map;
import org.springframework.boot.actuate.endpoint.Endpoint;
import org.springframework.boot.actuate.endpoint.EnvironmentEndpoint;
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.boot.endpoint.DeleteOperation;
import org.springframework.boot.endpoint.WriteOperation;
import org.springframework.boot.endpoint.web.WebEndpointExtension;
/**
* MVC endpoint for the {@link EnvironmentManager} providing a POST to /env as a simple
@@ -32,28 +29,24 @@ import org.springframework.web.bind.annotation.ResponseBody;
* @author Dave Syer
*
*/
public class EnvironmentManagerMvcEndpoint implements MvcEndpoint {
@WebEndpointExtension(endpoint = EnvironmentEndpoint.class)
public class EnvironmentWebEndpointExtension {
private EnvironmentManager environment;
private EnvironmentEndpoint delegate;
public EnvironmentManagerMvcEndpoint(EnvironmentEndpoint delegate,
EnvironmentManager enviroment) {
this.delegate = delegate;
public EnvironmentWebEndpointExtension(EnvironmentManager enviroment) {
environment = enviroment;
}
@RequestMapping(value = "", method = RequestMethod.POST)
@ResponseBody
public Object value(@RequestParam Map<String, String> params) {
@WriteOperation
public Object write(Map<String, String> params) {
for (String name : params.keySet()) {
environment.setProperty(name, params.get(name));
}
return params;
}
@RequestMapping(value = "reset", method = RequestMethod.POST)
@ResponseBody
@DeleteOperation
public Map<String, Object> reset() {
return environment.reset();
}
@@ -62,19 +55,4 @@ public class EnvironmentManagerMvcEndpoint implements MvcEndpoint {
this.environment = environment;
}
@Override
public String getPath() {
return "/" + this.delegate.getId();
}
@Override
public boolean isSensitive() {
return this.delegate.isSensitive();
}
@Override
@SuppressWarnings("rawtypes")
public Class<? extends Endpoint> getEndpointType() {
return this.delegate.getClass();
}
}

71
spring-cloud-context/src/main/java/org/springframework/cloud/context/restart/RestartEndpoint.java
View File

@@ -19,38 +19,31 @@ package org.springframework.cloud.context.restart;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.actuate.endpoint.AbstractEndpoint;
import org.springframework.boot.context.event.ApplicationPreparedEvent;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.boot.endpoint.WriteOperation;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.integration.monitor.IntegrationMBeanExporter;
import org.springframework.jmx.export.annotation.ManagedAttribute;
import org.springframework.jmx.export.annotation.ManagedOperation;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.util.ClassUtils;
/**
* An endpoint that restarts the application context. Install as a bean and also register
* a {@link RestartListener} with the {@link SpringApplication} that starts the context.
* Those two components communicate via an {@link ApplicationEvent} and set up the state
* needed to restart the context.
* needed to doRestart the context.
*
* @author Dave Syer
*
*/
@ConfigurationProperties("endpoints.restart")
@ManagedResource
public class RestartEndpoint extends AbstractEndpoint<Boolean>
@Endpoint(id = "restart", enabledByDefault = false)
public class RestartEndpoint
implements ApplicationListener<ApplicationPreparedEvent> {
private static Log logger = LogFactory.getLog(RestartEndpoint.class);
public RestartEndpoint() {
super("restart", true, false);
}
private ConfigurableApplicationContext context;
private SpringApplication application;
@@ -63,7 +56,7 @@ public class RestartEndpoint extends AbstractEndpoint<Boolean>
private long timeout;
@ManagedAttribute
// @ManagedAttribute
public long getTimeout() {
return this.timeout;
}
@@ -88,19 +81,20 @@ public class RestartEndpoint extends AbstractEndpoint<Boolean>
}
}
@Override
public Boolean invoke() {
@WriteOperation
//FIXME: map with "message: Restarting" or couldn't restart
public Boolean restart() {
try {
restart();
doRestart();
logger.info("Restarted");
return true;
}
catch (Exception e) {
if (logger.isDebugEnabled()) {
logger.info("Could not restart", e);
logger.info("Could not doRestart", e);
}
else {
logger.info("Could not restart: " + e.getMessage());
logger.info("Could not doRestart: " + e.getMessage());
}
return false;
}
@@ -114,42 +108,35 @@ public class RestartEndpoint extends AbstractEndpoint<Boolean>
return new ResumeEndpoint();
}
@ConfigurationProperties("endpoints.pause")
public class PauseEndpoint extends AbstractEndpoint<Boolean> {
@Endpoint(id = "pause")
public class PauseEndpoint {
public PauseEndpoint() {
super("pause", true);
}
@Override
public Boolean invoke() {
@WriteOperation
public Boolean pause() {
if (isRunning()) {
pause();
doPause();
return true;
}
return false;
}
}
@Endpoint(id = "resume")
@ConfigurationProperties("endpoints.resume")
public class ResumeEndpoint extends AbstractEndpoint<Boolean> {
public class ResumeEndpoint {
public ResumeEndpoint() {
super("resume", true);
}
@Override
public Boolean invoke() {
@WriteOperation
public Boolean resume() {
if (!isRunning()) {
resume();
doResume();
return true;
}
return false;
}
}
@ManagedOperation
public synchronized ConfigurableApplicationContext restart() {
// @ManagedOperation
public synchronized ConfigurableApplicationContext doRestart() {
if (this.context != null) {
if (this.integrationShutdown != null) {
this.integrationShutdown.stop(this.timeout);
@@ -164,7 +151,7 @@ public class RestartEndpoint extends AbstractEndpoint<Boolean>
return this.context;
}
@ManagedAttribute
// @ManagedAttribute
public boolean isRunning() {
if (this.context != null) {
return this.context.isRunning();
@@ -172,15 +159,15 @@ public class RestartEndpoint extends AbstractEndpoint<Boolean>
return false;
}
@ManagedOperation
public synchronized void pause() {
// @ManagedOperation
public synchronized void doPause() {
if (this.context != null) {
this.context.stop();
}
}
@ManagedOperation
public synchronized void resume() {
// @ManagedOperation
public synchronized void doResume() {
if (this.context != null) {
this.context.start();
}

59
spring-cloud-context/src/main/java/org/springframework/cloud/context/restart/RestartMvcEndpoint.java
View File

@@ -1,59 +0,0 @@
/*
* Copyright 2013-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.cloud.context.restart;
import java.util.Collections;
import org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* MVC endpoint to allow an application to be restarted on a POST (to /restart by
* default).
*
* @author Dave Syer
*
*/
public class RestartMvcEndpoint extends EndpointMvcAdapter {
public RestartMvcEndpoint(RestartEndpoint delegate) {
super(delegate);
}
@RequestMapping(method = RequestMethod.POST)
@ResponseBody
@Override
public Object invoke() {
if (!getDelegate().isEnabled()) {
return new ResponseEntity<>(Collections.singletonMap(
"message", "This endpoint is disabled"), HttpStatus.NOT_FOUND);
}
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
RestartMvcEndpoint.super.invoke();
}
});
thread.setDaemon(false);
thread.start();
return Collections.singletonMap("message", "Restarting");
}
}

52
spring-cloud-context/src/main/java/org/springframework/cloud/endpoint/GenericPostableMvcEndpoint.java
View File

@@ -1,52 +0,0 @@
/*
* Copyright 2013-2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.cloud.endpoint;
import java.util.Collections;
import org.springframework.boot.actuate.endpoint.Endpoint;
import org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* A convenient base class for MVC endpoints that accept a POST (instead of the default
* GET).
*
* @author Dave Syer
*
*/
public class GenericPostableMvcEndpoint extends EndpointMvcAdapter {
public GenericPostableMvcEndpoint(Endpoint<?> delegate) {
super(delegate);
}
@RequestMapping(method = RequestMethod.POST)
@ResponseBody
@Override
public Object invoke() {
if (!getDelegate().isEnabled()) {
return new ResponseEntity<>(Collections.singletonMap(
"message", "This endpoint is disabled"), HttpStatus.NOT_FOUND);
}
return super.invoke();
}
}

24
spring-cloud-context/src/main/java/org/springframework/cloud/endpoint/RefreshEndpoint.java
View File

@@ -16,40 +16,30 @@
package org.springframework.cloud.endpoint;
import java.util.Arrays;
import java.util.Collection;
import java.util.Set;
import org.springframework.boot.actuate.endpoint.AbstractEndpoint;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.endpoint.Endpoint;
import org.springframework.boot.endpoint.ReadOperation;
import org.springframework.cloud.context.refresh.ContextRefresher;
import org.springframework.jmx.export.annotation.ManagedOperation;
import org.springframework.jmx.export.annotation.ManagedResource;
/**
* @author Dave Syer
* @author Venil Noronha
*/
@ConfigurationProperties(prefix = "endpoints.refresh", ignoreUnknownFields = false)
@ManagedResource
public class RefreshEndpoint extends AbstractEndpoint<Collection<String>> {
@Endpoint(id = "refresh")
public class RefreshEndpoint {
private ContextRefresher contextRefresher;
public RefreshEndpoint(ContextRefresher contextRefresher) {
super("refresh");
this.contextRefresher = contextRefresher;
}
@ManagedOperation
public String[] refresh() {
@ReadOperation
public Collection<String> refresh() {
Set<String> keys = contextRefresher.refresh();
return keys.toArray(new String[keys.size()]);
}
@Override
public Collection<String> invoke() {
return Arrays.asList(refresh());
return keys;
}
}

89
spring-cloud-context/src/test/java/org/springframework/cloud/autoconfigure/LifecycleMvcAutoConfigurationTests.java
View File

@@ -1,12 +1,14 @@
package org.springframework.cloud.autoconfigure;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.function.Function;
import org.assertj.core.util.Lists;
import org.junit.Test;
import org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.context.restart.RestartEndpoint;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.ResponseEntity;
@@ -23,95 +25,97 @@ import static org.junit.Assert.assertThat;
//TODO: super slow. Port to @SpringBootTest
public class LifecycleMvcAutoConfigurationTests {
// postEnvMvcEndpoint
@Test
public void postEnvMvcEndpointDisabled() {
beanNotCreated("environmentManagerEndpoint",
"endpoints.env.post.enabled=false");
public void environmentWebEndpointExtensionDisabled() {
beanNotCreated("environmentWebEndpointExtension",
"endpoints.env.enabled=false");
}
@Test
public void postEnvMvcEndpointGloballyDisabled() {
beanNotCreated("environmentManagerEndpoint",
"endpoints.enabled=false");
public void environmentWebEndpointExtensionGloballyDisabled() {
beanNotCreated("environmentWebEndpointExtension",
"endpoints.default.enabled=false");
}
@Test
public void postEnvMvcEndpointEnabled() {
beanCreated("environmentManagerEndpoint",
"endpoints.env.post.enabled=true");
public void environmentWebEndpointExtensionEnabled() {
beanCreated("environmentWebEndpointExtension",
"endpoints.env.enabled=true");
}
// restartMvcEndpoint
// restartEndpoint
@Test
public void restartMvcEndpointDisabled() {
beanNotCreated("restartMvcEndpoint",
public void restartEndpointDisabled() {
beanNotCreated("restartEndpoint",
"endpoints.restart.enabled=false");
}
@Test
public void restartMvcEndpointGloballyDisabled() {
beanNotCreated("restartMvcEndpoint",
"endpoints.enabled=false");
public void restartEndpointGloballyDisabled() {
beanNotCreated("restartEndpoint",
"endpoints.default.enabled=false");
}
@Test
public void restartMvcEndpointEnabled() {
beanCreatedAndEndpointEnabled("restartMvcEndpoint",
public void restartEndpointEnabled() {
beanCreatedAndEndpointEnabled("restartEndpoint", RestartEndpoint.class,
RestartEndpoint::restart,
"endpoints.restart.enabled=true");
}
// pauseMvcEndpoint
// pauseEndpoint
@Test
public void pauseMvcEndpointDisabled() {
beanNotCreated("pauseMvcEndpoint",
public void pauseEndpointDisabled() {
beanNotCreated("pauseEndpoint",
"endpoints.pause.enabled=false");
}
@Test
public void pauseMvcEndpointRestartDisabled() {
beanNotCreated("pauseMvcEndpoint",
public void pauseEndpointRestartDisabled() {
beanNotCreated("pauseEndpoint",
"endpoints.restart.enabled=false",
"endpoints.pause.enabled=true");
}
@Test
public void pauseMvcEndpointGloballyDisabled() {
beanNotCreated("pauseMvcEndpoint",
"endpoints.enabled=false");
public void pauseEndpointGloballyDisabled() {
beanNotCreated("pauseEndpoint",
"endpoints.default.enabled=false");
}
@Test
public void pauseMvcEndpointEnabled() {
beanCreatedAndEndpointEnabled("pauseMvcEndpoint",
public void pauseEndpointEnabled() {
beanCreatedAndEndpointEnabled("pauseEndpoint", RestartEndpoint.PauseEndpoint.class,
RestartEndpoint.PauseEndpoint::pause,
"endpoints.restart.enabled=true",
"endpoints.pause.enabled=true");
}
// resumeMvcEndpoint
// resumeEndpoint
@Test
public void resumeMvcEndpointDisabled() {
beanNotCreated("resumeMvcEndpoint",
public void resumeEndpointDisabled() {
beanNotCreated("resumeEndpoint",
"endpoints.restart.enabled=true",
"endpoints.resume.enabled=false");
}
@Test
public void resumeMvcEndpointRestartDisabled() {
beanNotCreated("resumeMvcEndpoint",
public void resumeEndpointRestartDisabled() {
beanNotCreated("resumeEndpoint",
"endpoints.restart.enabled=false",
"endpoints.resume.enabled=true");
}
@Test
public void resumeMvcEndpointGloballyDisabled() {
beanNotCreated("resumeMvcEndpoint",
"endpoints.enabled=false");
public void resumeEndpointGloballyDisabled() {
beanNotCreated("resumeEndpoint",
"endpoints.default.enabled=false");
}
@Test
public void resumeMvcEndpointEnabled() {
beanCreatedAndEndpointEnabled("resumeMvcEndpoint",
public void resumeEndpointEnabled() {
beanCreatedAndEndpointEnabled("resumeEndpoint", RestartEndpoint.ResumeEndpoint.class,
RestartEndpoint.ResumeEndpoint::resume,
"endpoints.restart.enabled=true",
"endpoints.resume.enabled=true");
}
@@ -128,12 +132,13 @@ public class LifecycleMvcAutoConfigurationTests {
}
}
private void beanCreatedAndEndpointEnabled(String beanName, String... properties) {
@SuppressWarnings("unchecked")
private <T> void beanCreatedAndEndpointEnabled(String beanName, Class<T> type, Function<T, Object> function, String... properties) {
try (ConfigurableApplicationContext context = getApplicationContext(Config.class, properties)) {
assertThat("bean was not created", context.containsBeanDefinition(beanName), equalTo(true));
EndpointMvcAdapter endpoint = context.getBean(beanName, EndpointMvcAdapter.class);
Object result = endpoint.invoke();
Object endpoint = context.getBean(beanName, type);
Object result = function.apply((T) endpoint);
assertThat("result is wrong type", result,
is(not(instanceOf(ResponseEntity.class))));

22
spring-cloud-context/src/test/java/org/springframework/cloud/context/environment/EnvironmentManagerIntegrationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2006-2007 the original author or authors.
* Copyright 2006-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -18,7 +18,9 @@ package org.springframework.cloud.context.environment;
import javax.servlet.ServletException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
@@ -30,11 +32,15 @@ import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.context.environment.EnvironmentManagerIntegrationTests.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;
import java.util.Collections;
import static java.util.Collections.singletonMap;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
@@ -42,7 +48,7 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestConfiguration.class)
@SpringBootTest(classes = TestConfiguration.class, properties = "endpoints.default.web.enabled=true")
public class EnvironmentManagerIntegrationTests {
@Autowired
@@ -51,6 +57,9 @@ public class EnvironmentManagerIntegrationTests {
@Autowired
private WebApplicationContext context;
@Autowired
private ObjectMapper mapper;
private MockMvc mvc;
@Before
@@ -59,16 +68,23 @@ public class EnvironmentManagerIntegrationTests {
}
@Test
@Ignore //FIXME: 2.0.0
public void testRefresh() throws Exception {
assertEquals("Hello scope!", properties.getMessage());
// Change the dynamic property source...
this.mvc.perform(post("/application/env").param("message", "Foo"))
String content = mapper.writeValueAsString(singletonMap("params", singletonMap("message", "Foo")));
// String content = "{\"params\":\"{'message':'Foo'}\"}";
// String content = mapper.writeValueAsString(singletonMap("params", "value"));
this.mvc.perform(post("/application/env")
.content(content)
.contentType(MediaType.APPLICATION_JSON))
.andExpect(status().isOk())
.andExpect(content().string("{\"message\":\"Foo\"}"));
assertEquals("Foo", properties.getMessage());
}
@Test
@Ignore //FIXME: 2.0.0
public void testRefreshFails() throws Exception {
try {
this.mvc.perform(post("/application/env").param("delay", "foo"))

4
spring-cloud-context/src/test/java/org/springframework/cloud/context/restart/RestartIntegrationTests.java
View File

@@ -45,7 +45,7 @@ public class RestartIntegrationTests {
RestartEndpoint endpoint = context.getBean(RestartEndpoint.class);
assertNotNull(context.getParent());
assertNull(context.getParent().getParent());
context = endpoint.restart();
context = endpoint.doRestart();
assertNotNull(context);
assertNotNull(context.getParent());
@@ -53,7 +53,7 @@ public class RestartIntegrationTests {
RestartEndpoint next = context.getBean(RestartEndpoint.class);
assertNotSame(endpoint, next);
context = next.restart();
context = next.doRestart();
assertNotNull(context);
assertNotNull(context.getParent());

12
spring-cloud-context/src/test/java/org/springframework/cloud/endpoint/RefreshEndpointTests.java
View File

@@ -75,7 +75,7 @@ public class RefreshEndpointTests {
EnvironmentTestUtils.addEnvironment(this.context, "spring.profiles.active=local");
ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
Collection<String> keys = endpoint.invoke();
Collection<String> keys = endpoint.refresh();
assertTrue("Wrong keys: " + keys, keys.contains("added"));
}
@@ -90,7 +90,7 @@ public class RefreshEndpointTests {
"spring.profiles.active=override");
ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
Collection<String> keys = endpoint.invoke();
Collection<String> keys = endpoint.refresh();
assertTrue("Wrong keys: " + keys, keys.contains("message"));
}
@@ -106,7 +106,7 @@ public class RefreshEndpointTests {
+ ExternalPropertySourceLocator.class.getName());
ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
Collection<String> keys = endpoint.invoke();
Collection<String> keys = endpoint.refresh();
assertTrue("Wrong keys: " + keys, keys.contains("external.message"));
}
@@ -124,7 +124,7 @@ public class RefreshEndpointTests {
"spring.main.sources=" + ExternalPropertySourceLocator.class.getName());
ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
Collection<String> keys = endpoint.invoke();
Collection<String> keys = endpoint.refresh();
assertFalse("Wrong keys: " + keys, keys.contains("external.message"));
}
@@ -137,7 +137,7 @@ public class RefreshEndpointTests {
ContextRefresher contextRefresher = new ContextRefresher(this.context, scope);
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
Empty empty = this.context.getBean(Empty.class);
endpoint.invoke();
endpoint.refresh();
int after = empty.events.size();
assertEquals("Shutdown hooks not cleaned on refresh", 2, after);
assertTrue(empty.events.get(0) instanceof EnvironmentChangeEvent);
@@ -152,7 +152,7 @@ public class RefreshEndpointTests {
ContextRefresher contextRefresher = new ContextRefresher(context, scope);
RefreshEndpoint endpoint = new RefreshEndpoint(contextRefresher);
int count = countShutdownHooks();
endpoint.invoke();
endpoint.refresh();
int after = countShutdownHooks();
assertEquals("Shutdown hooks not cleaned on refresh", count, after);
}