Improve MBean without backing Endpoint support
Improve support for MBeans without a backing endpoint by introducing a `JmxEndpoint` interface. The `JmxEndpoint` is intentionally similar in design to the `MvcEndpoint` from the `mvc` package and allows for completely custom JMX beans that are not backed by any real actuator `Endpoint`. The `AuditEventsMBean` has been refactored to use the new interface and has been renamed to `AuditEventsJmxEndpoint`. See gh-6579pull/7796/merge
Phillip Webb
8 years ago
parent
2f1e4f0c02
commit
5b40eb48e0
@ -0,0 +1,62 @@
|
||||
/*
|
||||
* 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.jmx;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.fasterxml.jackson.databind.JavaType;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
|
||||
/**
|
||||
* Internal converter that uses an {@link ObjectMapper} to convert to JSON.
|
||||
*
|
||||
* @author Christian Dupuis
|
||||
* @author Andy Wilkinson
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class DataConverter {
|
||||
|
||||
private final ObjectMapper objectMapper;
|
||||
|
||||
private final JavaType listObject;
|
||||
|
||||
private final JavaType mapStringObject;
|
||||
|
||||
DataConverter(ObjectMapper objectMapper) {
|
||||
this.objectMapper = (objectMapper == null ? new ObjectMapper() : objectMapper);
|
||||
this.listObject = this.objectMapper.getTypeFactory()
|
||||
.constructParametricType(List.class, Object.class);
|
||||
this.mapStringObject = this.objectMapper.getTypeFactory()
|
||||
.constructParametricType(Map.class, String.class, Object.class);
|
||||
|
||||
}
|
||||
|
||||
public Object convert(Object data) {
|
||||
if (data == null) {
|
||||
return null;
|
||||
}
|
||||
if (data instanceof String) {
|
||||
return data;
|
||||
}
|
||||
if (data.getClass().isArray() || data instanceof List) {
|
||||
return this.objectMapper.convertValue(data, this.listObject);
|
||||
}
|
||||
return this.objectMapper.convertValue(data, this.mapStringObject);
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,70 +0,0 @@
|
||||
/*
|
||||
* 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.jmx;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.fasterxml.jackson.databind.JavaType;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
|
||||
import org.springframework.jmx.export.annotation.ManagedAttribute;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Abstract base class for JMX endpoint implementations.
|
||||
*
|
||||
* @author Vedran Pavic
|
||||
* @since 1.5.0
|
||||
*/
|
||||
public abstract class EndpointMBeanSupport {
|
||||
|
||||
private final ObjectMapper mapper;
|
||||
|
||||
private final JavaType listObject;
|
||||
|
||||
private final JavaType mapStringObject;
|
||||
|
||||
public EndpointMBeanSupport(ObjectMapper objectMapper) {
|
||||
Assert.notNull(objectMapper, "ObjectMapper must not be null");
|
||||
this.mapper = objectMapper;
|
||||
this.listObject = objectMapper.getTypeFactory()
|
||||
.constructParametricType(List.class, Object.class);
|
||||
this.mapStringObject = objectMapper.getTypeFactory()
|
||||
.constructParametricType(Map.class, String.class, Object.class);
|
||||
}
|
||||
|
||||
@ManagedAttribute(description = "Indicates whether the underlying endpoint exposes sensitive information")
|
||||
public abstract boolean isSensitive();
|
||||
|
||||
@ManagedAttribute(description = "Returns the class of the underlying endpoint")
|
||||
public abstract String getEndpointClass();
|
||||
|
||||
protected Object convert(Object result) {
|
||||
if (result == null) {
|
||||
return null;
|
||||
}
|
||||
if (result instanceof String) {
|
||||
return result;
|
||||
}
|
||||
if (result.getClass().isArray() || result instanceof List) {
|
||||
return this.mapper.convertValue(result, this.listObject);
|
||||
}
|
||||
return this.mapper.convertValue(result, this.mapStringObject);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,54 @@
|
||||
/*
|
||||
* 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.jmx;
|
||||
|
||||
import org.springframework.boot.actuate.endpoint.Endpoint;
|
||||
|
||||
/**
|
||||
* A strategy for the JMX layer on top of an {@link Endpoint}. Implementations are allowed
|
||||
* to use {@code @ManagedAttribute} and the full Spring JMX machinery. Implementations may
|
||||
* be backed by an actual {@link Endpoint} or may be specifically designed for JMX only.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 1.5.0
|
||||
* @see EndpointMBean
|
||||
* @see AbstractJmxEndpoint
|
||||
*/
|
||||
public interface JmxEndpoint {
|
||||
|
||||
/**
|
||||
* Return if the JMX endpoint is enabled.
|
||||
* @return if the endpoint is enabled
|
||||
*/
|
||||
boolean isEnabled();
|
||||
|
||||
/**
|
||||
* Return the MBean identity for this endpoint.
|
||||
* @return the MBean identity.
|
||||
*/
|
||||
String getIdentity();
|
||||
|
||||
/**
|
||||
* Return the type of {@link Endpoint} exposed, or {@code null} if this
|
||||
* {@link JmxEndpoint} exposes information that cannot be represented as a traditional
|
||||
* {@link Endpoint}.
|
||||
* @return the endpoint type
|
||||
*/
|
||||
@SuppressWarnings("rawtypes")
|
||||
Class<? extends Endpoint> getEndpointType();
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue