org.springframework.jmx.export.assembler.MethodNameBasedMBeanInfoAssembler Maven / Gradle / Ivy
/*
* Copyright 2002-2022 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
*
* https://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.jmx.export.assembler;
import java.lang.reflect.Method;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;
/**
* Subclass of {@code AbstractReflectiveMBeanInfoAssembler} that allows
* to specify method names to be exposed as MBean operations and attributes.
* JavaBean getters and setters will automatically be exposed as JMX attributes.
*
* You can supply an array of method names via the {@code managedMethods}
* property. If you have multiple beans and you wish each bean to use a different
* set of method names, then you can map bean keys (that is the name used to pass
* the bean to the {@code MBeanExporter}) to a list of method names using the
* {@code methodMappings} property.
*
*
If you specify values for both {@code methodMappings} and
* {@code managedMethods}, Spring will attempt to find method names in the
* mappings first. If no method names for the bean are found, it will use the
* method names defined by {@code managedMethods}.
*
* @author Juergen Hoeller
* @since 1.2
* @see #setManagedMethods
* @see #setMethodMappings
* @see InterfaceBasedMBeanInfoAssembler
* @see SimpleReflectiveMBeanInfoAssembler
* @see MethodExclusionMBeanInfoAssembler
* @see org.springframework.jmx.export.MBeanExporter
*/
public class MethodNameBasedMBeanInfoAssembler extends AbstractConfigurableMBeanInfoAssembler {
/**
* Stores the set of method names to use for creating the management interface.
*/
@Nullable
private Set managedMethods;
/**
* Stores the mappings of bean keys to an array of method names.
*/
@Nullable
private Map> methodMappings;
/**
* Set the array of method names to use for creating the management info.
* These method names will be used for a bean if no entry corresponding to
* that bean is found in the {@code methodMappings} property.
* @param methodNames an array of method names indicating the methods to use
* @see #setMethodMappings
*/
public void setManagedMethods(String... methodNames) {
this.managedMethods = Set.of(methodNames);
}
/**
* Set the mappings of bean keys to a comma-separated list of method names.
* The property key should match the bean key and the property value should match
* the list of method names. When searching for method names for a bean, Spring
* will check these mappings first.
* @param mappings the mappings of bean keys to method names
*/
public void setMethodMappings(Properties mappings) {
this.methodMappings = new HashMap<>();
for (Enumeration en = mappings.keys(); en.hasMoreElements();) {
String beanKey = (String) en.nextElement();
String[] methodNames = StringUtils.commaDelimitedListToStringArray(mappings.getProperty(beanKey));
this.methodMappings.put(beanKey, Set.of(methodNames));
}
}
@Override
protected boolean includeReadAttribute(Method method, String beanKey) {
return isMatch(method, beanKey);
}
@Override
protected boolean includeWriteAttribute(Method method, String beanKey) {
return isMatch(method, beanKey);
}
@Override
protected boolean includeOperation(Method method, String beanKey) {
return isMatch(method, beanKey);
}
protected boolean isMatch(Method method, String beanKey) {
if (this.methodMappings != null) {
Set methodNames = this.methodMappings.get(beanKey);
if (methodNames != null) {
return methodNames.contains(method.getName());
}
}
return (this.managedMethods != null && this.managedMethods.contains(method.getName()));
}
}