org.springframework.jmx.export.assembler.MethodExclusionMBeanInfoAssembler Maven / Gradle / Ivy
/*
* Copyright 2002-2014 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.jmx.export.assembler;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import org.springframework.util.StringUtils;
/**
* {@code AbstractReflectiveMBeanInfoAssembler} subclass that allows
* method names to be explicitly excluded as MBean operations and attributes.
*
* Any method not explicitly excluded from the management interface will be exposed to
* JMX. JavaBean getters and setters will automatically be exposed as JMX attributes.
*
*
You can supply an array of method names via the {@code ignoredMethods}
* 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 ignoredMethodMappings} property.
*
*
If you specify values for both {@code ignoredMethodMappings} and
* {@code ignoredMethods}, 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 ignoredMethods}.
*
* @author Rob Harrop
* @author Seth Ladd
* @since 1.2.5
* @see #setIgnoredMethods
* @see #setIgnoredMethodMappings
* @see InterfaceBasedMBeanInfoAssembler
* @see SimpleReflectiveMBeanInfoAssembler
* @see MethodNameBasedMBeanInfoAssembler
* @see org.springframework.jmx.export.MBeanExporter
*/
public class MethodExclusionMBeanInfoAssembler extends AbstractConfigurableMBeanInfoAssembler {
private Set ignoredMethods;
private Map> ignoredMethodMappings;
/**
* Set the array of method names to be ignored when 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 ignoredMethodsMappings} property.
* @see #setIgnoredMethodMappings(java.util.Properties)
*/
public void setIgnoredMethods(String... ignoredMethodNames) {
this.ignoredMethods = new HashSet(Arrays.asList(ignoredMethodNames));
}
/**
* Set the mappings of bean keys to a comma-separated list of method names.
* These method names are ignored when creating the management interface.
*
The property key must match the bean key and the property value must match
* the list of method names. When searching for method names to ignore for a bean,
* Spring will check these mappings first.
*/
public void setIgnoredMethodMappings(Properties mappings) {
this.ignoredMethodMappings = new HashMap>();
for (Enumeration en = mappings.keys(); en.hasMoreElements();) {
String beanKey = (String) en.nextElement();
String[] methodNames = StringUtils.commaDelimitedListToStringArray(mappings.getProperty(beanKey));
this.ignoredMethodMappings.put(beanKey, new HashSet(Arrays.asList(methodNames)));
}
}
@Override
protected boolean includeReadAttribute(Method method, String beanKey) {
return isNotIgnored(method, beanKey);
}
@Override
protected boolean includeWriteAttribute(Method method, String beanKey) {
return isNotIgnored(method, beanKey);
}
@Override
protected boolean includeOperation(Method method, String beanKey) {
return isNotIgnored(method, beanKey);
}
/**
* Determine whether the given method is supposed to be included,
* that is, not configured as to be ignored.
* @param method the operation method
* @param beanKey the key associated with the MBean in the beans map
* of the {@code MBeanExporter}
*/
protected boolean isNotIgnored(Method method, String beanKey) {
if (this.ignoredMethodMappings != null) {
Set methodNames = this.ignoredMethodMappings.get(beanKey);
if (methodNames != null) {
return !methodNames.contains(method.getName());
}
}
if (this.ignoredMethods != null) {
return !this.ignoredMethods.contains(method.getName());
}
return true;
}
}