HashLookupModuleSettings.java

Go to the documentation of this file.

/*
 * 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.modules.hashdatabase;

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

final class HashLookupModuleSettings implements IngestModuleIngestJobSettings {

    private static final long serialVersionUID = 1L;
    private HashSet<String> namesOfEnabledKnownHashSets;
    private HashSet<String> namesOfDisabledKnownHashSets;    // Added in version 1.1
    private HashSet<String> namesOfEnabledKnownBadHashSets;
    private HashSet<String> namesOfDisabledKnownBadHashSets; // Added in version 1.1
    private boolean shouldCalculateHashes = true;

    HashLookupModuleSettings(boolean shouldCalculateHashes,
            List<String> namesOfEnabledKnownHashSets,
            List<String> namesOfEnabledKnownBadHashSets) {
        this(shouldCalculateHashes, namesOfEnabledKnownHashSets, namesOfEnabledKnownBadHashSets, new ArrayList<>(), new ArrayList<>());
    }

    HashLookupModuleSettings(boolean shouldCalculateHashes,
            List<String> namesOfEnabledKnownHashSets,
            List<String> namesOfEnabledKnownBadHashSets,
            List<String> namesOfDisabledKnownHashSets,
            List<String> namesOfDisabledKnownBadHashSets) {
        this.shouldCalculateHashes = shouldCalculateHashes;
        this.namesOfEnabledKnownHashSets = new HashSet<>(namesOfEnabledKnownHashSets);
        this.namesOfEnabledKnownBadHashSets = new HashSet<>(namesOfEnabledKnownBadHashSets);
        this.namesOfDisabledKnownHashSets = new HashSet<>(namesOfDisabledKnownHashSets);
        this.namesOfDisabledKnownBadHashSets = new HashSet<>(namesOfDisabledKnownBadHashSets);
    }

    @Override
    public long getVersionNumber() {
        this.upgradeFromOlderVersions();
        return HashLookupModuleSettings.serialVersionUID;
    }

    boolean shouldCalculateHashes() {
        this.upgradeFromOlderVersions();
        return this.shouldCalculateHashes;
    }

    boolean isHashSetEnabled(String hashSetName) {
        this.upgradeFromOlderVersions();
        return !(this.namesOfDisabledKnownHashSets.contains(hashSetName) || this.namesOfDisabledKnownBadHashSets.contains(hashSetName));
    }

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

    List<String> getNamesOfDisabledKnownHashSets() {
        this.upgradeFromOlderVersions();
        return new ArrayList<>(namesOfDisabledKnownHashSets);
    }

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

    List<String> getNamesOfDisabledKnownBadHashSets() {
        this.upgradeFromOlderVersions();
        return new ArrayList<>(this.namesOfDisabledKnownBadHashSets);
    }

    private void upgradeFromOlderVersions() {
        if (null == this.namesOfDisabledKnownHashSets) {
            this.namesOfDisabledKnownHashSets = new HashSet<>();
        }
        if (null == this.namesOfDisabledKnownBadHashSets) {
            this.namesOfDisabledKnownBadHashSets = new HashSet<>();
        }
    }

}