/*
* Copyright 2013-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.integration.jmx;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import javax.management.MBeanServerConnection;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
import javax.management.QueryExp;
import org.springframework.integration.core.MessageSource;
import org.springframework.integration.endpoint.AbstractMessageSource;
import org.springframework.messaging.MessagingException;
import org.springframework.util.Assert;
/**
* A {@link MessageSource} implementation that retrieves a snapshot of a filtered subset of the MBean tree.
*
* @author Stuart Williams
* @author Gary Russell
* @since 3.0
*
*/
public class MBeanTreePollingMessageSource extends AbstractMessageSource<Object> {
private volatile MBeanServerConnection server;
private volatile ObjectName queryName = null;
private volatile QueryExp queryExpression = ObjectName.WILDCARD;
private final MBeanObjectConverter converter;
/**
* @param converter The converter.
*/
public MBeanTreePollingMessageSource(MBeanObjectConverter converter) {
this.converter = converter;
}
@Override
public String getComponentType() {
return "jmx:tree-polling-channel-adapter";
}
/**
* Provides the mapped tree object
*/
@Override
protected Object doReceive() {
Assert.notNull(this.server, "MBeanServer is required");
try {
Map<String, Object> beans = new HashMap<String, Object>();
Set<ObjectInstance> results = this.server.queryMBeans(this.queryName, this.queryExpression);
for (ObjectInstance instance : results) {
Object result = this.converter.convert(this.server, instance);
beans.put(instance.getObjectName().getCanonicalName(), result);
}
return beans;
}
catch (Exception e) {
throw new MessagingException("Failed to retrieve tree snapshot", e);
}
}
/**
* Provide the MBeanServer where the JMX MBean has been registered.
*
* @param server The MBean server connection.
*/
public void setServer(MBeanServerConnection server) {
this.server = server;
}
/**
* @param queryName The query name.
*/
public void setQueryName(String queryName) {
Assert.notNull(queryName, "'queryName' must not be null");
try {
setQueryNameReference(ObjectName.getInstance(queryName));
}
catch (MalformedObjectNameException e) {
throw new IllegalArgumentException(e);
}
}
/**
* @param queryName The query name.
*/
public void setQueryNameReference(ObjectName queryName) {
this.queryName = queryName;
}
/**
* @param queryExpression The query expression.
*/
public void setQueryExpression(String queryExpression) {
Assert.notNull(queryExpression, "'queryExpression' must not be null");
try {
setQueryExpressionReference(ObjectName.getInstance(queryExpression));
}
catch (MalformedObjectNameException e) {
throw new IllegalArgumentException(e);
}
}
/**
* @param queryExpression The query expression.
*/
public void setQueryExpressionReference(QueryExp queryExpression) {
this.queryExpression = queryExpression;
}
}