IngestJobRunner.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2018-2019 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.testutils;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
import javax.annotation.concurrent.GuardedBy;
import org.sleuthkit.autopsy.events.AutopsyEvent;
import org.sleuthkit.autopsy.ingest.IngestJobSettings;
import org.sleuthkit.autopsy.ingest.IngestJobStartResult;
import org.sleuthkit.autopsy.ingest.IngestManager;
import org.sleuthkit.autopsy.ingest.IngestModuleError;
import org.sleuthkit.datamodel.Content;

public final class IngestJobRunner {

    private static final Set<IngestManager.IngestJobEvent> INGEST_JOB_EVENTS_OF_INTEREST = EnumSet.of(IngestManager.IngestJobEvent.COMPLETED, IngestManager.IngestJobEvent.CANCELLED);

    public static List<IngestModuleError> runIngestJob(Collection<Content> dataSources, IngestJobSettings settings) throws InterruptedException {
        Object ingestMonitor = new Object();
        IngestJobCompletionListener completiontListener = new IngestJobCompletionListener(ingestMonitor, dataSources.size());
        IngestManager ingestManager = IngestManager.getInstance();
        ingestManager.addIngestJobEventListener(INGEST_JOB_EVENTS_OF_INTEREST, completiontListener);
        try {
            synchronized (ingestMonitor) {
                IngestJobStartResult jobStartResult = ingestManager.beginIngestJob(dataSources, settings);
                if (jobStartResult.getModuleErrors().isEmpty()) {
                    ingestMonitor.wait();
                    return Collections.emptyList();
                } else {
                    return jobStartResult.getModuleErrors();
                }
            }
        } finally {
            ingestManager.removeIngestJobEventListener(completiontListener);
        }
    }

    private IngestJobRunner() {
    }

    private static final class IngestJobCompletionListener implements PropertyChangeListener {

        private final Object ingestMonitor;
        
        @GuardedBy("ingestMonitor")
        private int remainingJobsCount;

        IngestJobCompletionListener(Object ingestMonitor, int jobsCount) {
            this.ingestMonitor = ingestMonitor;
            this.remainingJobsCount = jobsCount;
        }

        @Override
        public void propertyChange(PropertyChangeEvent event) {
            if (AutopsyEvent.SourceType.LOCAL == ((AutopsyEvent) event).getSourceType()) {
                String eventType = event.getPropertyName();
                if (eventType.equals(IngestManager.IngestJobEvent.COMPLETED.toString()) || eventType.equals(IngestManager.IngestJobEvent.CANCELLED.toString())) {
                    synchronized (ingestMonitor) {
                        this.remainingJobsCount--;
                        if (this.remainingJobsCount <= 0) {
                            ingestMonitor.notify();    
                        }
                    }
                }
            }
        }
    }

}