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

Add some Javadocs

Browse Source
This commit is contained in:
Dave Syer
2015-02-06 09:52:02 +00:00
parent 9e35f60d97
commit f8d91ef32b
16 changed files with 110 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-cloud-config-client/src/main/java/org/springframework/cloud/autoconfigure/EnvironmentEndpointAutoConfiguration.java → spring-cloud-config-client/src/main/java/org/springframework/cloud/autoconfigure/LifecycleMvcEndpointAutoConfiguration.java
View File

@@ -35,6 +35,10 @@ import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* Autoconfiguration for some MVC endpoints governing the application context lifecycle.
* Provides restart, pause, resume, refresh (environment) and environment update
* endpoints.
*
* @author Dave Syer
*
*/
@@ -43,8 +47,9 @@ import org.springframework.context.annotation.Configuration;
@ConditionalOnProperty(value = "endpoints.env.enabled", matchIfMissing = true)
@ConditionalOnWebApplication
@ConditionalOnBean(RestartEndpoint.class)
@AutoConfigureAfter({ WebMvcAutoConfiguration.class, EndpointAutoConfiguration.class, RefreshAutoConfiguration.class })
public class EnvironmentEndpointAutoConfiguration {
@AutoConfigureAfter({ WebMvcAutoConfiguration.class, EndpointAutoConfiguration.class,
RefreshAutoConfiguration.class })
public class LifecycleMvcEndpointAutoConfiguration {
@Autowired
private RestartEndpoint restartEndpoint;

32
spring-cloud-config-client/src/main/java/org/springframework/cloud/autoconfigure/RefreshAutoConfiguration.java
View File

@@ -49,6 +49,13 @@ import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.integration.monitor.IntegrationMBeanExporter;
/**
* Autoconfiguration for the refresh scope and associated features to do with changes in
* the Environment (e.g. rebinding logger levels).
*
* @author Dave Syer
*
*/
@Configuration
@ConditionalOnClass(RefreshScope.class)
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
@@ -75,16 +82,17 @@ public class RefreshAutoConfiguration {
@Configuration
@ConditionalOnClass(InfoEndpoint.class)
@ConditionalOnBean(EndpointAutoConfiguration.class)
protected static class InfoEndpointRebinderConfiguration implements ApplicationListener<EnvironmentChangeEvent> {
protected static class InfoEndpointRebinderConfiguration implements
ApplicationListener<EnvironmentChangeEvent> {
@Autowired
private EndpointAutoConfiguration endpoints;
@Autowired
private ConfigurableEnvironment environment;
private Map<String, Object> map = new LinkedHashMap<String, Object>();
@Override
public void onApplicationEvent(EnvironmentChangeEvent event) {
for (String key : event.getKeys()) {
@@ -93,21 +101,22 @@ public class RefreshAutoConfiguration {
}
}
}
@Bean
public InfoEndpoint infoEndpoint() throws Exception {
return new InfoEndpoint(endpoints.infoEndpoint().invoke()) {
@Override
public Map<String, Object> invoke() {
Map<String, Object> info = new LinkedHashMap<String, Object>(super.invoke());
Map<String, Object> info = new LinkedHashMap<String, Object>(
super.invoke());
info.putAll(map);
return info;
}
};
}
}
@Configuration
@ConditionalOnBean(ConfigurationPropertiesBindingPostProcessor.class)
protected static class ConfigurationPropertiesRebinderConfiguration {
@@ -135,7 +144,7 @@ public class RefreshAutoConfiguration {
@ConditionalOnClass(IntegrationMBeanExporter.class)
protected static class RestartEndpointWithIntegration {
@Autowired(required=false)
@Autowired(required = false)
private IntegrationMBeanExporter exporter;
@Bean
@@ -179,7 +188,8 @@ public class RefreshAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public RefreshEndpoint refreshEndpoint(ConfigurableApplicationContext context, RefreshScope scope) {
public RefreshEndpoint refreshEndpoint(
ConfigurableApplicationContext context, RefreshScope scope) {
RefreshEndpoint endpoint = new RefreshEndpoint(context, scope);
return endpoint;
}

8
spring-cloud-config-client/src/main/java/org/springframework/cloud/bootstrap/BootstrapConfiguration.java
View File

@@ -18,7 +18,13 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* A marker interface used as a key in <code>META-INF/spring.factories</code>. Entries in
* the factories file are used to create the bootstrap application context.
*
* @author Dave Syer
*
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented

4
spring-cloud-config-client/src/main/java/org/springframework/cloud/config/Environment.java
View File

@@ -23,6 +23,10 @@ import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Simple plain text serializable encapsulation of a list of property sources. Basically a
* DTO for {@link org.springframework.core.env.Environment}, but also applicable outside
* the domain of a Spring application.
*
* @author Dave Syer
*
*/

8
spring-cloud-config-client/src/main/java/org/springframework/cloud/config/PropertySource.java
View File

@@ -22,10 +22,10 @@ import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* @author Dave Syer
*
*/
/**
* Simple plain text serializable encapsulation of a named source of key-value pairs.
* Basically a DTO for {@link PropertySource}, but also applicable outside the domain of a
* Spring application.
*
* @author Dave Syer
*
*/

12
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/config/annotation/RefreshScope.java
View File

@@ -24,7 +24,17 @@ import java.lang.annotation.Target;
import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
@Target({ElementType.TYPE, ElementType.METHOD})
/**
* Convenience annotation to put a <code>@Bean</code> definition in
* {@link org.springframework.cloud.context.scope.refresh.RefreshScope refresh scope}.
* Beans annotated this way can be refreshed at runtime and any components that are using
* them will get a new instance on the next method call, fully initialized and injected
* with all dependencies.
*
* @author Dave Syer
*
*/
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Scope("refresh")
@Documented

3
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/environment/EnvironmentChangeEvent.java
View File

@@ -18,8 +18,11 @@ package org.springframework.cloud.context.environment;
import java.util.Set;
import org.springframework.context.ApplicationEvent;
import org.springframework.core.env.Environment;
/**
* Event published to signal a change in the {@link Environment}.
*
* @author Dave Syer
*
*/

14
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/environment/EnvironmentManager.java
View File

@@ -23,6 +23,7 @@ import java.util.Set;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.jmx.export.annotation.ManagedOperation;
@@ -30,6 +31,10 @@ import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.stereotype.Component;
/**
* Entry point for making local (but volatile) changes to the {@link Environment} of a
* running application. Allows properties to be added and values changed, simply by adding
* them to a high priority property source in the existing Environment.
*
* @author Dave Syer
*
*/
@@ -48,8 +53,8 @@ public class EnvironmentManager implements ApplicationEventPublisherAware {
MutablePropertySources sources = environment.getPropertySources();
if (sources.contains(MANAGER_PROPERTY_SOURCE)) {
@SuppressWarnings("unchecked")
Map<String, Object> map = (Map<String, Object>) sources.get(MANAGER_PROPERTY_SOURCE)
.getSource();
Map<String, Object> map = (Map<String, Object>) sources.get(
MANAGER_PROPERTY_SOURCE).getSource();
this.map = map;
}
}
@@ -60,7 +65,7 @@ public class EnvironmentManager implements ApplicationEventPublisherAware {
}
@ManagedOperation
public Map<String,Object> reset() {
public Map<String, Object> reset() {
Map<String, Object> result = new LinkedHashMap<String, Object>(map);
if (!map.isEmpty()) {
Set<String> keys = map.keySet();
@@ -75,8 +80,7 @@ public class EnvironmentManager implements ApplicationEventPublisherAware {
if (!environment.getPropertySources().contains(MANAGER_PROPERTY_SOURCE)) {
synchronized (map) {
if (!environment.getPropertySources().contains(
MANAGER_PROPERTY_SOURCE)) {
if (!environment.getPropertySources().contains(MANAGER_PROPERTY_SOURCE)) {
MapPropertySource source = new MapPropertySource(
MANAGER_PROPERTY_SOURCE, map);
environment.getPropertySources().addFirst(source);

3
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/environment/EnvironmentManagerMvcEndpoint.java
View File

@@ -26,6 +26,9 @@ import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* MVC endpoint for the {@link EnvironmentManager} providing a POST to /env as a simple
* way to change the Environment.
*
* @author Dave Syer
*
*/

10
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/properties/ConfigurationPropertiesRebinder.java
View File

@@ -25,17 +25,27 @@ import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.boot.context.properties.ConfigurationBeanFactoryMetaData;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConfigurationPropertiesBindingPostProcessor;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ApplicationListener;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.core.env.Environment;
import org.springframework.jmx.export.annotation.ManagedAttribute;
import org.springframework.jmx.export.annotation.ManagedOperation;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.stereotype.Component;
/**
* Listens for {@link EnvironmentChangeEvent} and rebinds beans that were bound to the
* {@link Environment} using {@link ConfigurationProperties
* <code>@ConfigurationProperties</code>}. When these beans are re-bound and
* re-initialized the changes are available immediately to any component that is using the
* <code>@ConfigurationProperties</code> bean.
*
* @see RefreshScope for a deeper and optionally more focused refresh of bean components
*
* @author Dave Syer
*
*/

2
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/restart/RestartEndpoint.java
View File

@@ -35,7 +35,7 @@ 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 teh state
* Those two components communicate via an {@link ApplicationEvent} and set up the state
* needed to restart the context.
*
* @author Dave Syer

9
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/restart/RestartListener.java
View File

@@ -24,6 +24,9 @@ import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.SmartApplicationListener;
/**
* A listener that stores enough information about an application as it starts, to be able
* to restart it later if needed.
*
* @author Dave Syer
*
*/
@@ -58,11 +61,13 @@ public class RestartListener implements SmartApplicationListener {
if (context == null) {
context = event.getApplicationContext();
}
} else if (input instanceof ContextRefreshedEvent) {
}
else if (input instanceof ContextRefreshedEvent) {
if (context != null && input.getSource().equals(context) && event != null) {
context.publishEvent(event);
}
} else {
}
else {
if (context != null && input.getSource().equals(context)) {
context = null;
}

16
spring-cloud-config-client/src/main/java/org/springframework/cloud/context/restart/RestartMvcEndpoint.java
View File

@@ -27,8 +27,10 @@ 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
*
*/
@@ -54,17 +56,17 @@ public class RestartMvcEndpoint extends EndpointMvcAdapter {
});
thread.setDaemon(false);
thread.start();
return Collections.singletonMap(
"message", "Restarting");
return Collections.singletonMap("message", "Restarting");
}
public MvcEndpoint getPauseEndpoint() {
return new GenericPostableMvcEndpoint(((RestartEndpoint)getDelegate()).getPauseEndpoint());
return new GenericPostableMvcEndpoint(
((RestartEndpoint) getDelegate()).getPauseEndpoint());
}
public MvcEndpoint getResumeEndpoint() {
return new GenericPostableMvcEndpoint(((RestartEndpoint)getDelegate()).getResumeEndpoint());
return new GenericPostableMvcEndpoint(
((RestartEndpoint) getDelegate()).getResumeEndpoint());
}
}

7
spring-cloud-config-client/src/main/java/org/springframework/cloud/endpoint/GenericPostableMvcEndpoint.java
View File

@@ -26,6 +26,13 @@ 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) {

10
spring-cloud-config-client/src/main/java/org/springframework/cloud/logging/LoggingRebinder.java
View File

@@ -29,11 +29,14 @@ import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
/**
* Listener that looks for {@link EnvironmentChangeEvent} and rebinds logger levels if any
* changed.
*
* @author Dave Syer
*
*/
public class LoggingRebinder implements
ApplicationListener<EnvironmentChangeEvent>, EnvironmentAware {
public class LoggingRebinder implements ApplicationListener<EnvironmentChangeEvent>,
EnvironmentAware {
private final Log logger = LogFactory.getLog(getClass());
@@ -49,8 +52,7 @@ public class LoggingRebinder implements
if (environment == null) {
return;
}
LoggingSystem system = LoggingSystem.get(LoggingSystem.class
.getClassLoader());
LoggingSystem system = LoggingSystem.get(LoggingSystem.class.getClassLoader());
setLogLevels(system, environment);
}

2
spring-cloud-config-client/src/main/resources/META-INF/spring.factories
View File

@@ -1,7 +1,7 @@
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.autoconfigure.RefreshAutoConfiguration,\
org.springframework.cloud.autoconfigure.EnvironmentEndpointAutoConfiguration,\
org.springframework.cloud.autoconfigure.LifecycleMvcEndpointAutoConfiguration,\
org.springframework.cloud.autoconfigure.ConfigClientAutoConfiguration
# Application Listeners