org.apache.excalibur.instrument.client.InstrumentableNodeData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of excalibur-instrument-client Show documentation

Excalibur Instrument is an instrumentation utility that allows you to attach a separate JVM to your running application to determine its health. Instrumentation is the process of exposing the internal state in a way that is easy for an administrator or help desk personell to digest. Excalibur Instrumentation is such a package that you can use for your Avalon based projects.

The newest version!

/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.excalibur.instrument.client;

import javax.swing.ImageIcon;

/**
 * @author Avalon Development Team
 */
class InstrumentableNodeData
    extends NodeData
{
    /** An Instrumentable which exists because of configuration. */
    private static final ImageIcon m_iconInstrumentableConf;
    
    /** An Instrumentable which exists because of registration. */
    private static final ImageIcon m_iconInstrumentableReg;
    
    /** An Instrumentable which exists because of registration and
     *   configuration. */
    private static final ImageIcon m_iconInstrumentableRegConf;
    
    /** An Instrumentable which exists because it was loaded from the state
     *   file but is no longer used. */
    private static final ImageIcon m_iconInstrumentableOld;
    
    private InstrumentableData m_data;
    
    private boolean m_configured;
    private boolean m_registered;
    
    /*---------------------------------------------------------------
     * Class Initializer
     *-------------------------------------------------------------*/
    static
    {
        // Load the images.
        ClassLoader cl = InstrumentManagerTreeCellRenderer.class.getClassLoader();
        m_iconInstrumentableConf =
            new ImageIcon( cl.getResource( MEDIA_PATH + "instrumentable_conf.gif") );
        m_iconInstrumentableReg =
            new ImageIcon( cl.getResource( MEDIA_PATH + "instrumentable_reg.gif") );
        m_iconInstrumentableRegConf =
            new ImageIcon( cl.getResource( MEDIA_PATH + "instrumentable_reg_conf.gif") );
        m_iconInstrumentableOld =
            new ImageIcon( cl.getResource( MEDIA_PATH + "instrumentable_old.gif") );
    }
        
    /*---------------------------------------------------------------
     * Constructors
     *-------------------------------------------------------------*/
    InstrumentableNodeData( InstrumentableData data )
    {
        m_data = data;
        
        update();
    }
    
    /*---------------------------------------------------------------
     * NodeData Methods
     *-------------------------------------------------------------*/
    /**
     * Get the icon to display for the node.
     *
     * @return the icon to display for the node.
     */
    ImageIcon getIcon()
    {
        ImageIcon icon;
        if ( isConfigured() && isRegistered() )
        {
            icon = m_iconInstrumentableRegConf;
        }
        else if ( isConfigured() )
        {
            icon = m_iconInstrumentableConf;
        }
        else if ( isRegistered() )
        {
            icon = m_iconInstrumentableReg;
        }
        else
        {
            icon = m_iconInstrumentableOld;
        }
        
        return icon;
    }
    
    /**
     * Return the text to use for a tool tip on this node.
     *
     * @return Tool Tip text.  May be null, for no tool tip.
     */
    String getToolTipText()
    {
        String text;
        if ( isConfigured() && isRegistered() )
        {
            text = "Registered and Configured Instrumentable";
        }
        else if ( isConfigured() )
        {
            text = "Configured but unregistered Instrumentable";
        }
        else if ( isRegistered() )
        {
            text = "Registered Instrumentable";
        }
        else
        {
            text = "Old Instrumentable loaded from state file";
        }
        
        return text;
    }
    
    /*---------------------------------------------------------------
     * Methods
     *-------------------------------------------------------------*/
    InstrumentableData getData()
    {
        return m_data;
    }
    
    boolean isConfigured()
    {
        return m_configured;
    }
    
    boolean isRegistered()
    {
        return m_registered;
    }
    
    /**
     * Collect latest property values from the server.  Each call is remote so this
     *  allows us to use cached values locally to speed things up.
     */
    boolean update()
    {
        boolean changed = false;
        changed |= update( m_data.getName(), m_data.getDescription(), m_data.getStateVersion() );
        
        boolean newConfigured = m_data.isConfigured();
        if ( newConfigured != m_configured )
        {
            changed = true;
            m_configured = newConfigured;
        }
        
        boolean newRegistered = m_data.isRegistered();
        if ( newRegistered != m_registered )
        {
            changed = true;
            m_registered = newRegistered;
        }
        
        return changed;
    }
}