diff --git a/spring-cloud-config-client/src/main/java/org/springframework/cloud/config/client/ConfigClientProperties.java b/spring-cloud-config-client/src/main/java/org/springframework/cloud/config/client/ConfigClientProperties.java index 9b8f814d..548b658f 100644 --- a/spring-cloud-config-client/src/main/java/org/springframework/cloud/config/client/ConfigClientProperties.java +++ b/spring-cloud-config-client/src/main/java/org/springframework/cloud/config/client/ConfigClientProperties.java @@ -46,6 +46,9 @@ public class ConfigClientProperties { */ private String profile = "default"; + /** + * Name of application used to fetch remote properties. + */ @Value("${spring.application.name:application}") private String name; @@ -79,7 +82,7 @@ public class ConfigClientProperties { * Flag to indicate that failure to connect to the server is fatal (default false). */ private boolean failFast = false; - + private ConfigClientProperties() { } @@ -92,7 +95,7 @@ public class ConfigClientProperties { } public boolean isEnabled() { - return enabled; + return this.enabled; } public void setEnabled(boolean enabled) { @@ -104,7 +107,7 @@ public class ConfigClientProperties { } public String getUri() { - return uri; + return this.uri; } public void setUri(String url) { @@ -112,7 +115,7 @@ public class ConfigClientProperties { } public String getName() { - return name; + return this.name; } public void setName(String name) { @@ -120,7 +123,7 @@ public class ConfigClientProperties { } public String getProfile() { - return profile; + return this.profile; } public void setProfile(String env) { @@ -128,7 +131,7 @@ public class ConfigClientProperties { } public String getLabel() { - return label; + return this.label; } public void setLabel(String label) { @@ -152,7 +155,7 @@ public class ConfigClientProperties { } public Discovery getDiscovery() { - return discovery; + return this.discovery; } public void setDiscovery(Discovery discovery) { @@ -160,7 +163,7 @@ public class ConfigClientProperties { } public boolean isFailFast() { - return failFast; + return this.failFast; } public void setFailFast(boolean failFast) { @@ -205,10 +208,10 @@ public class ConfigClientProperties { } private String[] getUsernamePassword() { - if (StringUtils.hasText(password)) { + if (StringUtils.hasText(this.password)) { return new String[] { - StringUtils.hasText(username) ? username.trim() : "user", - password.trim() }; + StringUtils.hasText(this.username) ? this.username.trim() : "user", + this.password.trim() }; } return new String[2]; } @@ -216,11 +219,18 @@ public class ConfigClientProperties { public static class Discovery { public static final String DEFAULT_CONFIG_SERVER = "CONFIGSERVER"; + /** + * Flag to indicate that config server discovery is enabled (config server URL will be + * looked up via discovery). + */ private boolean enabled; + /** + * Service id to locate config server. + */ private String serviceId = DEFAULT_CONFIG_SERVER; public boolean isEnabled() { - return enabled; + return this.enabled; } public void setEnabled(boolean enabled) { @@ -228,7 +238,7 @@ public class ConfigClientProperties { } public String getServiceId() { - return serviceId; + return this.serviceId; } public void setServiceId(String serviceId) { @@ -241,27 +251,28 @@ public class ConfigClientProperties { org.springframework.core.env.Environment environment) { ConfigClientProperties override = new ConfigClientProperties(); BeanUtils.copyProperties(this, override); - override.setName(environment.resolvePlaceholders("${" - + ConfigClientProperties.PREFIX - + ".name:${spring.application.name:application}}")); + override.setName( + environment.resolvePlaceholders("${" + ConfigClientProperties.PREFIX + + ".name:${spring.application.name:application}}")); if (environment.containsProperty(ConfigClientProperties.PREFIX + ".profile")) { - override.setProfile(environment.getProperty(ConfigClientProperties.PREFIX - + ".profile")); + override.setProfile( + environment.getProperty(ConfigClientProperties.PREFIX + ".profile")); } if (environment.containsProperty(ConfigClientProperties.PREFIX + ".label")) { - override.setLabel(environment.getProperty(ConfigClientProperties.PREFIX - + ".label")); + override.setLabel( + environment.getProperty(ConfigClientProperties.PREFIX + ".label")); } return override; } @Override public String toString() { - return "ConfigClientProperties [enabled=" + enabled + ", profile=" + profile - + ", name=" + name + ", label=" + (label == null ? "" : label) - + ", username=" + username + ", password=" + password + ", uri=" + uri - + ", discovery.enabled=" + discovery.enabled + ", failFast=" + failFast - + "]"; + return "ConfigClientProperties [enabled=" + this.enabled + ", profile=" + + this.profile + ", name=" + this.name + ", label=" + + (this.label == null ? "" : this.label) + ", username=" + this.username + + ", password=" + this.password + ", uri=" + this.uri + + ", discovery.enabled=" + this.discovery.enabled + ", failFast=" + + this.failFast + "]"; } } diff --git a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/MultipleJGitEnvironmentRepository.java b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/MultipleJGitEnvironmentRepository.java index fc3017d5..9c8ad848 100644 --- a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/MultipleJGitEnvironmentRepository.java +++ b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/MultipleJGitEnvironmentRepository.java @@ -48,6 +48,9 @@ import org.springframework.util.StringUtils; @ConfigurationProperties("spring.cloud.config.server.git") public class MultipleJGitEnvironmentRepository extends JGitEnvironmentRepository { + /** + * Map of repository identifier to location and other properties. + */ private Map repos = new LinkedHashMap(); private Map placeholders = new LinkedHashMap(); @@ -185,7 +188,13 @@ public class MultipleJGitEnvironmentRepository extends JGitEnvironmentRepository public static class PatternMatchingJGitEnvironmentRepository extends JGitEnvironmentRepository { + /** + * Pattern to match on application name and profiles. + */ private String[] pattern = new String[0]; + /** + * Name of repository (same as map key by default). + */ private String name; public PatternMatchingJGitEnvironmentRepository() { diff --git a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/SvnKitEnvironmentRepository.java b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/SvnKitEnvironmentRepository.java index 5c42e44c..ceee7f2e 100644 --- a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/SvnKitEnvironmentRepository.java +++ b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/environment/SvnKitEnvironmentRepository.java @@ -48,6 +48,9 @@ public class SvnKitEnvironmentRepository extends AbstractScmEnvironmentRepositor private static final String DEFAULT_LABEL = "trunk"; + /** + * The default label for environment properties requests. + */ private String defaultLabel = DEFAULT_LABEL; public String getDefaultLabel() { diff --git a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/support/AbstractScmAccessor.java b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/support/AbstractScmAccessor.java index 1572272a..341de8ee 100644 --- a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/support/AbstractScmAccessor.java +++ b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/support/AbstractScmAccessor.java @@ -39,11 +39,26 @@ import org.springframework.util.StringUtils; public class AbstractScmAccessor { protected Log logger = LogFactory.getLog(getClass()); + /** + * Base directory for local working copy of repository. + */ private File basedir; + /** + * URI of remote repository. + */ private String uri; private ConfigurableEnvironment environment; + /** + * Username for authentication with remote repository. + */ private String username; + /** + * Password for authentication with remote repository. + */ private String password; + /** + * Search paths to use within local working copy. By default searches only the root. + */ private String[] searchPaths = new String[0]; public AbstractScmAccessor(ConfigurableEnvironment environment) {