From 323d6e54a9436b36f292bbeab206d53d91e6a6fb Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Fri, 6 May 2016 11:25:37 +0100 Subject: [PATCH] Add backwards compatible constructor to InfoEndpoint Anyone who is extending InfoEndpoint (per the docs) in 1.3 can continue to compile their code until they have time to adapt to the new model. --- .../boot/actuate/endpoint/InfoEndpoint.java | 23 ++++++++ .../boot/actuate/info/MapInfoContributor.java | 41 +++++++++++++ .../InfoEndpointCompatibilityTests.java | 57 +++++++++++++++++++ 3 files changed, 121 insertions(+) create mode 100644 spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/MapInfoContributor.java create mode 100644 spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/InfoEndpointCompatibilityTests.java diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InfoEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InfoEndpoint.java index 9b1c108d14..60a9f696cf 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InfoEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InfoEndpoint.java @@ -16,12 +16,15 @@ package org.springframework.boot.actuate.endpoint; +import java.util.ArrayList; +import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Map; import org.springframework.boot.actuate.info.Info; import org.springframework.boot.actuate.info.InfoContributor; +import org.springframework.boot.actuate.info.MapInfoContributor; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.util.Assert; @@ -47,6 +50,26 @@ public class InfoEndpoint extends AbstractEndpoint> { this.infoContributors = infoContributors; } + /** + * Constructor provided for backward compatibility. + * @param info a map (which is added to the info) + * @param infoContributors the info contributors to use + * + * @deprecated in favour of the constructor without the map + */ + @Deprecated + public InfoEndpoint(Map info, InfoContributor... infoContributors) { + this(createContributors(info, infoContributors)); + } + + private static List createContributors(Map info, + InfoContributor[] infoContributors) { + List result = new ArrayList( + Arrays.asList(infoContributors)); + result.add(0, new MapInfoContributor(info)); + return result; + } + @Override public Map invoke() { Info.Builder builder = new Info.Builder(); diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/MapInfoContributor.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/MapInfoContributor.java new file mode 100644 index 0000000000..79c16ed6df --- /dev/null +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/MapInfoContributor.java @@ -0,0 +1,41 @@ +/* + * Copyright 2012-2016 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.boot.actuate.info; + +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * A simple {@link InfoContributor} that exposes a map. + * + * @author Dave Syer + * @since 1.4.0 + */ +public class MapInfoContributor implements InfoContributor { + + private final Map info; + + public MapInfoContributor(Map info) { + this.info = new LinkedHashMap(info); + } + + @Override + public void contribute(Info.Builder builder) { + builder.withDetails(this.info); + } + +} diff --git a/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/InfoEndpointCompatibilityTests.java b/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/InfoEndpointCompatibilityTests.java new file mode 100644 index 0000000000..86bec9afd8 --- /dev/null +++ b/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/InfoEndpointCompatibilityTests.java @@ -0,0 +1,57 @@ +/* + * Copyright 2012-2016 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.boot.actuate.endpoint; + +import java.util.Collections; + +import org.junit.Test; + +import org.springframework.boot.actuate.info.Info; +import org.springframework.boot.actuate.info.InfoContributor; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link InfoEndpoint}. + * + * @author Dave Syer + */ +public class InfoEndpointCompatibilityTests { + + @Test + public void invoke() throws Exception { + Info actual = getEndpointBean().invoke(); + assertThat(actual.get("key1")).isEqualTo("value1"); + assertThat(actual.get("foo")).isEqualTo("bar"); + } + + private InfoEndpoint getEndpointBean() { + return new InfoEndpoint(Collections.singletonMap("foo", "bar"), + infoContributor()); + } + + private InfoContributor infoContributor() { + return new InfoContributor() { + + @Override + public void contribute(Info.Builder builder) { + builder.withDetail("key1", "value1"); + } + + }; + } +}