PhotoRecCarverIngestJobSettings.java

Go to the documentation of this file.

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

import java.util.ArrayList;
import java.util.Collections;
import org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings;
import java.util.List;

final class PhotoRecCarverIngestJobSettings implements IngestModuleIngestJobSettings {

    enum ExtensionFilterOption {
        INCLUDE,
        EXCLUDE,
        NO_FILTER
    };

    private static final long serialVersionUID = 1L;

    private boolean keepCorruptedFiles;
    private List<String> extensions;
    private ExtensionFilterOption extensionFilterOption;

    PhotoRecCarverIngestJobSettings() {
        this(PhotoRecCarverFileIngestModule.DEFAULT_CONFIG_KEEP_CORRUPTED_FILES,
                PhotoRecCarverFileIngestModule.DEFAULT_CONFIG_EXTENSION_FILTER,
                null);
    }

    PhotoRecCarverIngestJobSettings(boolean keepCorruptedFiles, ExtensionFilterOption extensionFilterOption, List<String> includeExcludeExtensions) {
        this.keepCorruptedFiles = keepCorruptedFiles;
        setExtensionFilterOption(extensionFilterOption);
        setExtensions(includeExcludeExtensions);
        
    }

    @Override
    public long getVersionNumber() {
        return serialVersionUID;
    }

    boolean isKeepCorruptedFiles() {
        return keepCorruptedFiles;
    }

    void setKeepCorruptedFiles(boolean keepCorruptedFiles) {
        this.keepCorruptedFiles = keepCorruptedFiles;
    }

    List<String> getExtensions() {
        return extensions == null
                ? Collections.emptyList()
                : Collections.unmodifiableList(extensions);
    }

    void setExtensions(List<String> includeExcludeExtensions) {
        this.extensions = new ArrayList<>();
        if (includeExcludeExtensions != null) {
            this.extensions.addAll(includeExcludeExtensions);
        }
    }

    ExtensionFilterOption getExtensionFilterOption() {
        return (this.extensionFilterOption == null) ? 
                ExtensionFilterOption.NO_FILTER : 
                extensionFilterOption;
    }

    void setExtensionFilterOption(ExtensionFilterOption extensionFilterOption) {
        this.extensionFilterOption = (extensionFilterOption == null) ? 
                ExtensionFilterOption.NO_FILTER : 
                extensionFilterOption;
    }
}