org.wso2.carbon.as.monitoring.collector.jmx.CollectorUtil.java Source code

Introduction

Here is the source code for org.wso2.carbon.as.monitoring.collector.jmx.CollectorUtil.java

Source

/*
 * Copyright (c) 2005-2014, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. licenses this file to you 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.wso2.carbon.as.monitoring.collector.jmx;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.as.monitoring.publisher.MonitoringEvent;
import org.wso2.carbon.as.monitoring.collector.jmx.clients.Result;

import javax.management.Attribute;
import java.lang.reflect.Field;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.List;

/**
 * The Utility class that contains some of the functions that are used across the entire module
 */
public class CollectorUtil {

    private static final Log LOG = LogFactory.getLog(CollectorUtil.class);

    /**
     * Get a particular Result object which maps to the given correlator
     *
     * @param results    the list of results
     * @param correlator the correlator
     * @return the Result matching to the given correlator. null if not match found
     */
    public Result getResultByCorrelator(List<Result> results, String correlator) {
        for (Result result : results) {
            if (correlator.equals(result.getCorrelator())) {
                return result;
            }
        }

        return null;
    }

    /**
     * Map the attributes on the result to the given event Object using reflection
     *
     * @param result The Result object with the attribute values
     * @param event  The POJO to be updated with the attribute values.
     */
    public void mapResultAttributesToPoJo(Result result, Object event) throws AttributeMapperException {
        if (result == null) {
            throw new AttributeMapperException("parameter 'result' should not be null");
        }
        if (result.getAttributes() == null) {
            throw new AttributeMapperException("attribute list of the parameter 'result' should not be null");
        }

        List<Attribute> attributeList = result.getAttributes().asList();
        for (Attribute attribute : attributeList) {
            setFieldValue(event, attribute);
        }
    }

    /**
     * Feed the serverAddress, serverName, clusterDomain and ClusterSubDomain values to the event.
     * Set "-" as the value for any param which cannot be retrieved because of errors etc...
     *
     * @param event The monitoring event
     */
    public void mapMetaData(MonitoringEvent event) {
        String serverAddress = "-";
        String serverName = "-";

        try {
            InetAddress ip = InetAddress.getLocalHost();
            serverAddress = ip.getHostAddress();
            serverName = ip.getHostName();
        } catch (UnknownHostException ignored) {
            // we miss the host address & host name
            // no alternative. not a blocker.
            if (LOG.isDebugEnabled()) {
                LOG.debug("Exception occurred while getting local host InetAddress.", ignored);
            }
        }

        event.setServerAddress(serverAddress);
        event.setServerName(serverName);
        event.setClusterDomain(getClusterDomain());
        event.setClusterSubDomain(getClusterSubDomain());
    }

    /**
     * Set the value of the attribute to the matching property of the event Object.
     *
     * @param event     The event object that should be filled with the attribute value
     * @param attribute The Attribute that should be set to the event field
     */
    public void setFieldValue(Object event, Attribute attribute) throws AttributeMapperException {
        Class<?> clazz = event.getClass();
        Field field;
        try {
            field = clazz.getDeclaredField(attribute.getName());
        } catch (NoSuchFieldException e) {
            throw new AttributeMapperException(attribute.getName() + " not found as a field", e);
        }

        try {
            field.setAccessible(true);
            if (field.getType().equals(attribute.getValue().getClass())) {
                field.set(event, attribute.getValue());
            } else {
                throw new AttributeMapperException("Type mismatch occurred. field = " + field.getName()
                        + " expected = " + field.getType() + ", found = " + attribute.getValue().getClass());
            }
        } catch (IllegalAccessException e) {
            throw new AttributeMapperException(
                    "Error occurred while accessing field: " + field.getName() + " accessing failed.", e);
        }
    }

    private String getClusterDomain() {
        return "-";
    }

    private String getClusterSubDomain() {
        return "-";
    }
}