autopsy-flatpak/HashDatabase/src/org/sleuthkit/autopsy/hashdatabase/HashLookupModuleSettings.java

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

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

/**
 * Settings for a hash lookup file ingest module instance.
 */
final class HashLookupModuleSettings implements IngestModuleIngestJobSettings {

    private static final long serialVersionUID = 1L;
    private final HashSet<String> namesOfEnabledKnownHashSets = new HashSet<>();
    private final HashSet<String> namesOfEnabledKnownBadHashSets = new HashSet<>();
    private boolean shouldCalculateHashes = true;

    HashLookupModuleSettings(boolean shouldCalculateHashes, List<String> namesOfEnabledKnownHashSets, List<String> namesOfEnabledKnownBadHashSets) {
        this.shouldCalculateHashes = shouldCalculateHashes;
        this.namesOfEnabledKnownHashSets.addAll(namesOfEnabledKnownHashSets);
        this.namesOfEnabledKnownBadHashSets.addAll(namesOfEnabledKnownBadHashSets);
    }

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

    boolean isHashSetEnabled(String hashSetName) {
        return (namesOfEnabledKnownHashSets.contains(hashSetName) || namesOfEnabledKnownBadHashSets.contains(hashSetName));
    }

    List<String> getNamesOfEnabledKnownHashSets() {
        return new ArrayList<>(namesOfEnabledKnownHashSets);
    }

    List<String> getNamesOfEnabledKnownBadHashSets() {
        return new ArrayList<>(namesOfEnabledKnownBadHashSets);
    }
}