AbstractNodePropertySheetTask.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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.sleuthkit.autopsy.datamodel.utils;

import com.google.common.util.concurrent.ThreadFactoryBuilder;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.lang.ref.WeakReference;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.logging.Level;
import org.openide.nodes.AbstractNode;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.datamodel.AbstractContentNode;

public abstract class AbstractNodePropertySheetTask<T extends AbstractNode> implements Runnable {

    private static final Logger LOGGER = Logger.getLogger(AbstractContentNode.class.getName());
    private static final Integer THREAD_POOL_SIZE = 10;
    private static final ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE, new ThreadFactoryBuilder().setNameFormat("node-background-task-%d").build());
    private final WeakReference<T> weakNodeRef;
    private final WeakReference<PropertyChangeListener> weakListenerRef;

    private static Future<?> submitTask(AbstractNodePropertySheetTask<?> task) {
        return executor.submit(task);
    }

    protected AbstractNodePropertySheetTask(T node, PropertyChangeListener listener) {
        this.weakNodeRef = new WeakReference<>(node);
        this.weakListenerRef = new WeakReference<>(listener);
    }

    protected abstract PropertyChangeEvent computePropertyValue(T node) throws Exception;

    public final Future<?> submit() {
        return submitTask(this);
    }

    @Override
    public final void run() {
        try {
            T node = this.weakNodeRef.get();
            PropertyChangeListener listener = this.weakListenerRef.get();
            if (node == null || listener == null) {
                return;
            }

            if (Thread.currentThread().isInterrupted()) {
                return;
            }

            PropertyChangeEvent changeEvent = computePropertyValue(node);

            if (Thread.currentThread().isInterrupted()) {
                return;
            }

            if (changeEvent != null) {
                listener.propertyChange(changeEvent);
            }

        } catch (Exception ex) {
            LOGGER.log(Level.WARNING, "Error executing property sheet values computation background task", ex);
        }

    }

}