ManagedComponentDiscoveryComponent.java

/*
* Jopr Management Platform
* Copyright (C) 2005-2010 Red Hat, Inc.
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2, as
* published by the Free Software Foundation, and/or the GNU Lesser
* General Public License, version 2.1, also as published by the Free
* Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License and the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program;
* if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.rhq.plugins.jbossas5;

import java.util.HashSet;
import java.util.Set;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.jboss.deployers.spi.management.ManagementView;
import org.jboss.managed.api.ComponentType;
import org.jboss.managed.api.ManagedComponent;

import org.rhq.core.domain.configuration.PropertySimple;
import org.rhq.core.domain.resource.ResourceType;
import org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails;
import org.rhq.core.pluginapi.inventory.ResourceDiscoveryComponent;
import org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext;
import org.rhq.plugins.jbossas5.util.ConversionUtils;

/**
 * Discovery component for ManagedComponents exposed by the JBoss AS 5.x Profile Service that will be represented as
 * child Resources of the JBoss AS Resource.
 *
 * @author Jason Dobies
 * @author Mark Spritzer
 * @author Ian Springer
 */
public class ManagedComponentDiscoveryComponent<P extends ProfileServiceComponent<?>> implements
    ResourceDiscoveryComponent<P> {
    private final Log log = LogFactory.getLog(this.getClass());

    public Set<DiscoveredResourceDetails> discoverResources(ResourceDiscoveryContext<P> discoveryContext)
        throws Exception {
        ResourceType resourceType = discoveryContext.getResourceType();
        log.trace("Discovering " + resourceType.getName() + " Resources...");

        ManagementView managementView = discoveryContext.getParentResourceComponent().getConnection()
            .getManagementView();
        // TODO (ips): Only refresh the ManagementView *once* per runtime discovery scan, rather than every time this
        //             method is called. Do this by providing a runtime scan id in the ResourceDiscoveryContext.
        managementView.load();

        ComponentType componentType = getComponentType(discoveryContext);
        Set<ManagedComponent> components;
        try {
            components = managementView.getComponentsForType(componentType);
        } catch (Exception e) {
            throw new IllegalStateException("Failed to get component types for " + resourceType + ".", e);
        }
        if (resourceType.isSingleton() && components.size() > 1) {
            throw new IllegalStateException("Discovered multiple [" + componentType + "] managed components during ["
                + resourceType + "] discovery, but expected to find no more than one - components were: " + components);
        }

        Set<DiscoveredResourceDetails> discoveredResources = new HashSet<DiscoveredResourceDetails>(components.size());
        /* Create a resource for each managed component found. We know all managed components will be of a
           type we're interested in, so we can just add them all. There may be need for multiple iterations
           over lists retrieved from different component types, but that is possible through the current API.
        */
        for (ManagedComponent component : components) {
            if (accept(discoveryContext, component)) {
                String resourceName = getResourceName(component);
                if (resourceName == null) {
                    resourceName = component.getName();
                }
                String resourceKey = getResourceKey(component);
                if (resourceKey == null) {
                    resourceKey = component.getName();
                }

                String version = getResourceVersion(component);

                DiscoveredResourceDetails resource = new DiscoveredResourceDetails(resourceType, resourceKey,
                    resourceName, version, resourceType.getDescription(),
                    discoveryContext.getDefaultPluginConfiguration(), null);

                resource.getPluginConfiguration().put(
                    new PropertySimple(ManagedComponentComponent.Config.COMPONENT_NAME, resourceKey));

                discoveredResources.add(resource);
            }
        }

        log.trace("Discovered " + discoveredResources.size() + " " + resourceType.getName() + " Resources.");
        return discoveredResources;
    }

    protected ComponentType getComponentType(ResourceDiscoveryContext<P> discoveryContext) {
        ResourceType resourceType = discoveryContext.getResourceType();
        return ConversionUtils.getComponentType(resourceType);
    }

    /**
     * Subclasses can override this method if they don't want to use the ManagedComponent name as the initial
     * Resource name.
     *
     * @param component the ManagedComponent being discovered
     *
     * @return the name to be assigned to the corresponding Resource
     */
    protected String getResourceName(ManagedComponent component) {
        return component.getName();
    }

    /**
     * Return the unique resource key for the component.
     * If you override this method, make sure to override 
     * {@link ManagedComponentComponent#getManagedComponent()} method as well
     * because the return value of this method is used as the component name 
     * ({@link ManagedComponentComponent#getComponentName()}). 
     *
     * @param component the component to uniquely identify
     *
     * @return the unique identifier for the component
     */
    protected String getResourceKey(ManagedComponent component) {
        return component.getName();
    }

    /**
     * Subclasses can override this method if they want the discovered ManagedComponent to have a version.
     *
     * @param component the ManagedComponent being discovered
     *
     * @return the version to be assigned to the corresponding Resource
     */
    protected String getResourceVersion(ManagedComponent component) {
        return null;
    }

    /**
     * This method is called during {@link #discoverResources(ResourceDiscoveryContext)} to determine
     * whether given component that has been found in the management view by this component's configured
     * component type is applicable in the discovery context.
     * <p>
     * Because the Profile Service doesn't always provide the components in a hierarchy we present the resources
     * we need this method to filter the components into their appropriate places.
     * <p> 
     * This default implementation always returns true.
     * 
     * @param discoveryContext the current discovery context
     * @param component the discovered component
     * @return true if the component logically belongs in the context, false otherwise.
     */
    protected boolean accept(ResourceDiscoveryContext<P> discoveryContext, ManagedComponent component) {
        return true;
    }
}