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.
pull/5883/head
Dave Syer 9 years ago
parent 631dc52d88
commit 323d6e54a9

@ -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<Map<String, Object>> {
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<String, Object> info, InfoContributor... infoContributors) {
this(createContributors(info, infoContributors));
}
private static List<InfoContributor> createContributors(Map<String, Object> info,
InfoContributor[] infoContributors) {
List<InfoContributor> result = new ArrayList<InfoContributor>(
Arrays.asList(infoContributors));
result.add(0, new MapInfoContributor(info));
return result;
}
@Override
public Map<String, Object> invoke() {
Info.Builder builder = new Info.Builder();

@ -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<String, Object> info;
public MapInfoContributor(Map<String, Object> info) {
this.info = new LinkedHashMap<String, Object>(info);
}
@Override
public void contribute(Info.Builder builder) {
builder.withDetails(this.info);
}
}

@ -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");
}
};
}
}
Loading…
Cancel
Save