Browse Source

Reformat and regenerate docs.

pull/1077/head
Olga Maciaszek-Sharma 3 years ago
parent
commit
9c3620b772
  1. 2
      README.adoc
  2. 2
      docs/src/main/asciidoc/_configprops.adoc
  3. 5
      spring-cloud-commons/src/main/java/org/springframework/cloud/client/DefaultServiceInstance.java
  4. 9
      spring-cloud-commons/src/main/java/org/springframework/cloud/commons/util/IdUtils.java
  5. 2
      spring-cloud-commons/src/test/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryClientTests.java
  6. 7
      spring-cloud-commons/src/test/java/org/springframework/cloud/commons/util/IdUtilsTests.java

2
README.adoc

@ -27,7 +27,7 @@ Extract the files into the JDK/jre/lib/security folder for whichever version of @@ -27,7 +27,7 @@ Extract the files into the JDK/jre/lib/security folder for whichever version of
== Building
:jdkversion: 1.8
:jdkversion: 17
=== Basic Compile and Test

2
docs/src/main/asciidoc/_configprops.adoc

@ -1,7 +1,7 @@ @@ -1,7 +1,7 @@
|===
|Name | Default | Description
|spring.cloud.compatibility-verifier.compatible-boot-versions | `2.6.x` | Default accepted versions for the Spring Boot dependency. You can set {@code x} for the patch version if you don't want to specify a concrete value. Example: {@code 3.4.x}
|spring.cloud.compatibility-verifier.compatible-boot-versions | | Default accepted versions for the Spring Boot dependency. You can set {@code x} for the patch version if you don't want to specify a concrete value. Example: {@code 3.4.x}
|spring.cloud.compatibility-verifier.enabled | `false` | Enables creation of Spring Cloud compatibility verification.
|spring.cloud.config.allow-override | `true` | Flag to indicate that {@link #isOverrideSystemProperties() systemPropertiesOverride} can be used. Set to false to prevent users from changing the default accidentally. Default true.
|spring.cloud.config.override-none | `false` | Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false.

5
spring-cloud-commons/src/main/java/org/springframework/cloud/client/DefaultServiceInstance.java

@ -80,13 +80,14 @@ public class DefaultServiceInstance implements ServiceInstance { @@ -80,13 +80,14 @@ public class DefaultServiceInstance implements ServiceInstance {
/**
* Creates a URI from the given ServiceInstance's host:port.
* @param instance the ServiceInstance.
* @return URI of the form (secure)?https:http + "host:port". Scheme port default used if port not set.
* @return URI of the form (secure)?https:http + "host:port". Scheme port default used
* if port not set.
*/
public static URI getUri(ServiceInstance instance) {
String scheme = (instance.isSecure()) ? "https" : "http";
int port = instance.getPort();
if (port <= 0) {
port = (instance.isSecure()) ? 443 : 80;
port = (instance.isSecure()) ? 443 : 80;
}
String uri = String.format("%s://%s:%s", scheme, instance.getHost(), port);
return URI.create(uri);

9
spring-cloud-commons/src/main/java/org/springframework/cloud/commons/util/IdUtils.java

@ -30,6 +30,7 @@ public final class IdUtils { @@ -30,6 +30,7 @@ public final class IdUtils {
public static final String DEFAULT_SERVICE_ID_STRING = "${vcap.application.name:${spring.application.name:application}}:${vcap.application.instance_index:${spring.application.index:${local.server.port:${server.port:0}}}}:${vcap.application.instance_id:${cachedrandom.${vcap.application.name:${spring.application.name:application}}.value}}";
public static final String DEFAULT_SERVICE_ID_WITH_ACTIVE_PROFILES_STRING = "${vcap.application.name:${spring.application.name:application}:${spring.profiles.active}}:${vcap.application.instance_index:${spring.application.index:${local.server.port:${server.port:0}}}}:${vcap.application.instance_id:${cachedrandom.${vcap.application.name:${spring.application.name:application}}.value}}";
// @checkstyle:on
private IdUtils() {
@ -66,11 +67,13 @@ public final class IdUtils { @@ -66,11 +67,13 @@ public final class IdUtils {
*/
public static String getResolvedServiceId(PropertyResolver resolver) {
final String unresolvedServiceId;
// addition of active profiles at the 2nd position of the service ID breaks backwards-compatibility,
// addition of active profiles at the 2nd position of the service ID breaks
// backwards-compatibility,
// so we fall back to the old implementation in case no profiles are active
if (StringUtils.hasText(resolver.getProperty("spring.profiles.active"))) {
unresolvedServiceId = getUnresolvedServiceIdWithActiveProfiles();
} else {
}
else {
unresolvedServiceId = getUnresolvedServiceId();
}
return resolver.resolvePlaceholders(unresolvedServiceId);
@ -78,7 +81,6 @@ public final class IdUtils { @@ -78,7 +81,6 @@ public final class IdUtils {
/**
* Gets the unresolved template for the service id <i>without active profiles.</i>
*
* @return The combination of properties to create a unique service id.
*/
public static String getUnresolvedServiceId() {
@ -87,7 +89,6 @@ public final class IdUtils { @@ -87,7 +89,6 @@ public final class IdUtils {
/**
* Gets the unresolved template for the service id including active profiles.
*
* @return The combination of properties to create a unique service id.
*/
public static String getUnresolvedServiceIdWithActiveProfiles() {

2
spring-cloud-commons/src/test/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryClientTests.java

@ -70,7 +70,7 @@ public class SimpleDiscoveryClientTests { @@ -70,7 +70,7 @@ public class SimpleDiscoveryClientTests {
then(instances.get(1).getUri()).isEqualTo(URI.create("https://host2:443"));
then(instances.get(1).isSecure()).isEqualTo(true);
then(instances.get(1).getMetadata()).isNotNull();
then(instances.get(2).getServiceId()).isEqualTo("service1");
then(instances.get(2).getHost()).isEqualTo("host3");
then(instances.get(2).getPort()).isEqualTo(0);

7
spring-cloud-commons/src/test/java/org/springframework/cloud/commons/util/IdUtilsTests.java

@ -116,7 +116,8 @@ public class IdUtilsTests { @@ -116,7 +116,8 @@ public class IdUtilsTests {
@Test
public void testUnresolvedServiceIdWithActiveProfiles() {
then(IdUtils.DEFAULT_SERVICE_ID_WITH_ACTIVE_PROFILES_STRING).isEqualTo(IdUtils.getUnresolvedServiceIdWithActiveProfiles());
then(IdUtils.DEFAULT_SERVICE_ID_WITH_ACTIVE_PROFILES_STRING)
.isEqualTo(IdUtils.getUnresolvedServiceIdWithActiveProfiles());
}
@Test
@ -148,7 +149,8 @@ public class IdUtilsTests { @@ -148,7 +149,8 @@ public class IdUtilsTests {
env.setProperty("cachedrandom.springname.value", "123abc");
then("springname:1234:123abc").isEqualTo(IdUtils.getResolvedServiceId(env));
// ensure that for spring.profiles.active, empty string value is equivalent to not being set at all
// ensure that for spring.profiles.active, empty string value is equivalent to not
// being set at all
env.setProperty("spring.profiles.active", "");
then("springname:1234:123abc").isEqualTo(IdUtils.getResolvedServiceId(env));
}
@ -179,4 +181,5 @@ public class IdUtilsTests { @@ -179,4 +181,5 @@ public class IdUtilsTests {
env.setProperty("spring.profiles.active", "123profile");
then("springname:123profile:1234:123abc").isEqualTo(IdUtils.getResolvedServiceId(env));
}
}

Loading…
Cancel
Save