IngestJobContext.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.util.List;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.DataArtifact;

public final class IngestJobContext {

    private final IngestJobPipeline ingestJobPipeline;

    IngestJobContext(IngestJobPipeline ingestJobPipeline) {
        this.ingestJobPipeline = ingestJobPipeline;
    }

    public String getExecutionContext() {
        return ingestJobPipeline.getExecutionContext();
    }

    public Content getDataSource() {
        return ingestJobPipeline.getDataSource();
    }

    public long getJobId() {
        return ingestJobPipeline.getId();
    }

    @Deprecated
    public boolean isJobCancelled() {
        return ingestJobPipeline.isCancelled();
    }

    public boolean dataSourceIngestIsCancelled() {
        return ingestJobPipeline.currentDataSourceIngestModuleIsCancelled() || ingestJobPipeline.isCancelled();
    }

    public boolean fileIngestIsCancelled() {
        /*
         * It is not currently possible to cancel individual file ingest
         * modules.
         */
        return ingestJobPipeline.isCancelled();
    }

    public boolean dataArtifactIngestIsCancelled() {
        /*
         * It is not currently possible to cancel individual data artifact
         * ingest modules.
         */
        return ingestJobPipeline.isCancelled();
    }

    public boolean processingUnallocatedSpace() {
        return ingestJobPipeline.shouldProcessUnallocatedSpace();
    }

    @Deprecated
    public void scheduleFiles(List<AbstractFile> files) {
        addFilesToJob(files);
    }    
    
    public void addFilesToJob(List<AbstractFile> files) {
        ingestJobPipeline.addFiles(files);
    }

    public void addDataArtifactsToJob(List<DataArtifact> artifacts) {
        ingestJobPipeline.addDataArtifacts(artifacts);
    }

}