LogicalImagerRule.java

Go to the documentation of this file.

/*
 * Autopsy
 *
 * Copyright 2019 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.logicalimager.configuration;

import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

class LogicalImagerRule {

    @Expose(serialize = true)
    private final Boolean shouldAlert;
    @Expose(serialize = true)
    private final Boolean shouldSave;
    @Expose(serialize = true)
    private final String name;
    @Expose(serialize = true)
    private final String description;
    @Expose(serialize = true)
    private List<String> extensions = new ArrayList<>();
    @SerializedName("file-names")
    @Expose(serialize = true)
    private List<String> filenames = new ArrayList<>();
    @SerializedName("folder-names")
    @Expose(serialize = true)
    private List<String> paths = new ArrayList<>();
    @SerializedName("full-paths")
    @Expose(serialize = true)
    private List<String> fullPaths = new ArrayList<>();
    @SerializedName("size-range")
    @Expose(serialize = true)
    final private Map<String, Long> sizeRange = new HashMap<>();
    @SerializedName("date-range")
    @Expose(serialize = true)
    final private Map<String, Integer> dateRange = new HashMap<>();

    // The following fields should not be serialized, internal use only
    @Expose(serialize = false)
    private Long minFileSize;
    @Expose(serialize = false)
    private Long maxFileSize;
    @Expose(serialize = false)
    private Integer minDays;
    @Expose(serialize = false)
    private Integer minDate;
    @Expose(serialize = false)
    private Integer maxDate;

    private LogicalImagerRule(Boolean shouldAlert, Boolean shouldSave, String name, String description,
            List<String> extensions,
            List<String> filenames,
            List<String> paths,
            List<String> fullPaths,
            Long minFileSize,
            Long maxFileSize,
            Integer minDays,
            Integer minDate,
            Integer maxDate
    ) {
        this.shouldAlert = shouldAlert;
        this.shouldSave = shouldSave;
        this.name = name;
        this.description = description;
        this.extensions = extensions;
        this.filenames = filenames;
        this.paths = paths;
        this.fullPaths = fullPaths;

        this.sizeRange.put("min", minFileSize); // NON-NLS
        this.minFileSize = minFileSize;
        this.sizeRange.put("max", maxFileSize); // NON-NLS
        this.maxFileSize = maxFileSize;
        this.dateRange.put("min-days", minDays); // NON-NLS
        this.minDays = minDays;
        this.dateRange.put("min-date", minDate); // NON-NLS
        this.minDate = minDate;
        this.dateRange.put("max-date", maxDate); // NON-NLS
        this.maxDate = maxDate;
    }

    LogicalImagerRule() {
        this.shouldAlert = false; // default
        this.shouldSave = true; // default
        this.description = null;
        this.name = null;
    }

    Boolean isShouldAlert() {
        return shouldAlert;
    }

    Boolean isShouldSave() {
        return shouldSave;
    }

    String getName() {
        return name;
    }

    String getDescription() {
        return description;
    }

    List<String> getExtensions() {
        return extensions;
    }

    List<String> getFilenames() {
        return filenames;
    }

    List<String> getPaths() {
        return paths;
    }

    List<String> getFullPaths() {
        return fullPaths;
    }

    Long getMinFileSize() {
        return minFileSize;
    }

    Long getMaxFileSize() {
        return maxFileSize;
    }

    Integer getMinDays() {
        return minDays;
    }

    Integer getMinDate() {
        return minDate;
    }

    Integer getMaxDate() {
        return maxDate;
    }

    static class Builder {

        private Boolean shouldAlert = null;
        private Boolean shouldSave = null;
        private String name = null;
        private String description = null;
        private List<String> extensions = null;
        private List<String> filenames = null;
        private List<String> paths = null;
        private List<String> fullPaths = null;
        private Long minFileSize = null;
        private Long maxFileSize = null;
        private Integer minDays = null;
        private Integer minDate = null;
        private Integer maxDate = null;

        Builder getShouldAlert(boolean shouldAlert) {
            this.shouldAlert = shouldAlert;
            return this;
        }

        Builder getShouldSave(boolean shouldSave) {
            this.shouldSave = shouldSave;
            return this;
        }

        Builder getName(String name) {
            this.name = name;
            return this;
        }

        Builder getDescription(String description) {
            this.description = description;
            return this;
        }

        Builder getExtensions(List<String> extensions) {
            this.extensions = extensions;
            return this;
        }

        Builder getFilenames(List<String> filenames) {
            this.filenames = filenames;
            return this;
        }

        Builder getPaths(List<String> paths) {
            this.paths = paths;
            return this;
        }

        Builder getFullPaths(List<String> fullPaths) {
            this.fullPaths = fullPaths;
            return this;
        }

        Builder getMinFileSize(Long minFileSize) {
            this.minFileSize = minFileSize;
            return this;
        }

        Builder getMaxFileSize(Long maxFileSize) {
            this.maxFileSize = maxFileSize;
            return this;
        }

        Builder getMinDays(Integer minDays) {
            this.minDays = minDays;
            return this;
        }

        Builder getMinDate(Integer minDate) {
            this.minDate = minDate;
            return this;
        }

        Builder getMaxDate(Integer maxDate) {
            this.maxDate = maxDate;
            return this;
        }

        LogicalImagerRule build() {
            return new LogicalImagerRule(shouldAlert, shouldSave, name, description,
                    extensions, filenames, paths, fullPaths,
                    minFileSize, maxFileSize,
                    minDays, minDate, maxDate
            );
        }
    }
}