IngestJobProgressSnapshot.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014-2021 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.ingest;

import java.io.Serializable;
import java.util.Collections;
import java.util.Date;
import java.util.List;

public final class IngestJobProgressSnapshot implements Serializable {

    private static final long serialVersionUID = 1L;

    private final String dataSource;
    private final long jobId;
    private final long jobStartTime;
    private final long snapShotTime;
    private final String currentIngestModuleTier;
    transient private final DataSourceIngestPipeline.DataSourcePipelineModule dataSourceLevelIngestModule;
    private final boolean fileIngestRunning;
    private final Date fileIngestStartTime;
    private final long processedFiles;
    private final long estimatedFilesToProcess;
    private final IngestTasksScheduler.IngestTasksSnapshot tasksSnapshot;
    transient private final boolean jobCancelled;
    transient private final IngestJob.CancellationReason jobCancellationReason;
    transient private final List<String> cancelledDataSourceModules;

    IngestJobProgressSnapshot(
            String dataSourceName,
            long jobId,
            long jobStartTime,
            String currentIngestModuleTier,
            DataSourceIngestPipeline.DataSourcePipelineModule dataSourceIngestModule,
            boolean fileIngestRunning,
            Date fileIngestStartTime,
            boolean jobCancelled,
            IngestJob.CancellationReason cancellationReason,
            List<String> cancelledModules,
            long processedFiles,
            long estimatedFilesToProcess,
            long snapshotTime,
            IngestTasksScheduler.IngestTasksSnapshot tasksSnapshot) {
        this.dataSource = dataSourceName;
        this.jobId = jobId;
        this.jobStartTime = jobStartTime;
        this.currentIngestModuleTier = currentIngestModuleTier;
        this.dataSourceLevelIngestModule = dataSourceIngestModule;
        this.fileIngestRunning = fileIngestRunning;
        this.fileIngestStartTime = fileIngestStartTime;
        this.jobCancelled = jobCancelled;
        this.jobCancellationReason = cancellationReason;
        this.cancelledDataSourceModules = cancelledModules;
        this.processedFiles = processedFiles;
        this.estimatedFilesToProcess = estimatedFilesToProcess;
        this.snapShotTime = snapshotTime;
        this.tasksSnapshot = tasksSnapshot;
    }

    long getSnapshotTime() {
        return snapShotTime;
    }

    String getDataSource() {
        return dataSource;
    }

    long getJobId() {
        return this.jobId;
    }

    long getJobStartTime() {
        return jobStartTime;
    }

    String getCurrentIngestModuleTier() {
        return currentIngestModuleTier;
    }

    DataSourceIngestPipeline.DataSourcePipelineModule getDataSourceLevelIngestModule() {
        return this.dataSourceLevelIngestModule;
    }

    boolean getFileIngestIsRunning() {
        return this.fileIngestRunning;
    }

    // RJCTODO: How is this affected by ingest module tiers?
    Date getFileIngestStartTime() {
        return new Date(fileIngestStartTime.getTime());
    }

    // RJCTODO: How is this affected by ingest module tiers?
    double getFilesProcessedPerSec() {
        return (double) processedFiles / ((snapShotTime - jobStartTime) / 1000);
    }

    // RJCTODO: How is this affected by ingest module tiers?
    long getFilesProcessed() {
        return processedFiles;
    }

    // RJCTODO: How is this affected by ingest module tiers?
    long getFilesEstimated() {
        return estimatedFilesToProcess;
    }

    long getDsQueueSize() {
        if (null == this.tasksSnapshot) {
            return 0;
        }
        return this.tasksSnapshot.getDataSourceQueueSize();
    }

    long getRootQueueSize() {
        if (null == this.tasksSnapshot) {
            return 0;
        }
        return this.tasksSnapshot.getRootQueueSize();
    }

    long getDirQueueSize() {
        if (null == this.tasksSnapshot) {
            return 0;
        }
        return this.tasksSnapshot.getDirQueueSize();
    }

    long getStreamingQueueSize() {
        if (null == this.tasksSnapshot) {
            return 0;
        }
        return this.tasksSnapshot.getStreamedFilesQueueSize();
    }

    long getFileQueueSize() {
        if (null == this.tasksSnapshot) {
            return 0;
        }
        return this.tasksSnapshot.getFileQueueSize();
    }

    long getDataArtifactTasksQueueSize() {
        if (tasksSnapshot == null) {
            return 0;
        }
        return tasksSnapshot.getArtifactsQueueSize();
    }

    long getAnalysisResultTasksQueueSize() {
        if (tasksSnapshot == null) {
            return 0;
        }
        return tasksSnapshot.getResultsQueueSize();
    }

    long getRunningListSize() {
        if (null == this.tasksSnapshot) {
            return 0;
        }
        return this.tasksSnapshot.getProgressListSize();
    }

    boolean isCancelled() {
        return this.jobCancelled;
    }

    IngestJob.CancellationReason getCancellationReason() {
        return this.jobCancellationReason;
    }

    List<String> getCancelledDataSourceIngestModules() {
        return Collections.unmodifiableList(this.cancelledDataSourceModules);
    }

}