io.pcp.parfait.AbstractMonitorable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parfait-core Show documentation
Java performance monitoring framework, including PCP bridge
The newest version!
/*
 * Copyright 2009-2017 Aconex
 *
 * 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 io.pcp.parfait;

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

import javax.measure.Unit;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Convenience base class for implementing {@link Monitorable}. Provides implementations for
 * metadata methods and a high performance synchronization-free implementation of {@link Monitor}
 * notification.
 */
public abstract class AbstractMonitorable implements Monitorable {
    protected final Logger LOG;
    
    private final List monitors = new CopyOnWriteArrayList();
    private final String name;
    private final String description;
    private final Class type;
    private final Unit unit;
    private final ValueSemantics semantics;

    protected AbstractMonitorable(String name, String description, Class type, Unit unit, ValueSemantics semantics) {
        this.name = name;
        this.description = description;
        this.type = type;
        this.unit = unit;
        this.semantics = semantics;
        LOG = LoggerFactory.getLogger("parfait."+name);
    }

    protected void registerSelf(MonitorableRegistry registry) {
        registry.register(this);
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public String getDescription() {
        return description;
    }
    
    @Override
    public Class getType() {
        return type;
    }
    
    @Override
    public Unit getUnit() {
        return unit;
    }
    
    @Override
    public ValueSemantics getSemantics() {
        return semantics;
    }

    @Override
    public synchronized void attachMonitor(Monitor monitor) {
        if (!isAttached(monitor)) {
            monitors.add(monitor);
        }
    }

    @Override
    public synchronized void removeMonitor(Monitor monitor) {
        if (isAttached(monitor)) {
            monitors.remove(monitor);
        }
    }

    /**
     * Checks if a given Monitor is registered for notifications with this Monitorable.  
     * @return true if the monitor is currently in the notification list for the monitorable
     * 
     */
    synchronized boolean isAttached(Monitor monitorToFind) {
        return monitors.contains(monitorToFind);
    }

    protected final void notifyMonitors() {
        logValue();
        for (Monitor monitor : monitors) {
            monitor.valueChanged(this);
        }
    }

    protected final void logValue() {
        if (LOG.isTraceEnabled()) {
            LOG.trace(getName() + "=" + get());
        }
    }
}