IngestModuleInfo.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * 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.datamodel;

import java.util.ResourceBundle;

public final class IngestModuleInfo {

        private static final ResourceBundle bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle");

        public static enum IngestModuleType {
                /*
                 * IMPORTANT: DO NOT CHANGE ORDER, THE ORDINAL VALUES OF THE ENUM ARE
                 * STORED IN THE CASE DATABASE
                 */
                DATA_SOURCE_LEVEL(bundle.getString("IngestModuleInfo.IngestModuleType.DataSourceLevel.displayName")),
                FILE_LEVEL(bundle.getString("IngestModuleInfo.IngestModuleType.FileLevel.displayName")),
                DATA_ARTIFACT(bundle.getString("IngestModuleInfo.IngestModuleType.DataArtifact.displayName")),
                MULTIPLE("IngestModuleInfo.IngestModuleType.Multiple.displayName");

                private final String displayName;

                private IngestModuleType(String displayName) {
                        this.displayName = displayName;
                }

                public static IngestModuleType fromID(int typeId) {
                        for (IngestModuleType moduleType : IngestModuleType.values()) {
                                if (moduleType.ordinal() == typeId) {
                                        return moduleType;
                                }
                        }
                        return null;
                }

                public String getDisplayName() {
                        return displayName;
                }

        }

        private final long ingestModuleId;
        private final String displayName;
        private final String uniqueName;
        private final IngestModuleType type;
        private final String version;

        IngestModuleInfo(long ingestModuleId, String displayName, String uniqueName, IngestModuleType type, String version) {
                this.ingestModuleId = ingestModuleId;
                this.displayName = displayName;
                this.uniqueName = uniqueName;
                this.type = type;
                this.version = version;
        }

        public long getIngestModuleId() {
                return ingestModuleId;
        }

        public String getDisplayName() {
                return displayName;
        }

        public String getUniqueName() {
                return uniqueName;
        }

        public IngestModuleType getType() {
                return type;
        }

        public String getVersion() {
                return version;
        }

}