EamDb.java

Go to the documentation of this file.

/*
 * Central Repository
 *
 * Copyright 2015-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.centralrepository.datamodel;

import java.sql.SQLException;
import java.util.List;
import java.util.Set;
import org.sleuthkit.datamodel.TskData;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.coordinationservice.CoordinationService;
import org.sleuthkit.datamodel.CaseDbSchemaVersionNumber;

public interface EamDb {

    public static final int SCHEMA_VERSION = 1;
    public static final CaseDbSchemaVersionNumber CURRENT_DB_SCHEMA_VERSION
            = new CaseDbSchemaVersionNumber(1, 1);
  
    
    static EamDb getInstance() throws EamDbException {

        EamDbPlatformEnum selectedPlatform = EamDbPlatformEnum.DISABLED;
        if (EamDbUtil.useCentralRepo()) {
            selectedPlatform = EamDbPlatformEnum.getSelectedPlatform();
        }
        switch (selectedPlatform) {
            case POSTGRESQL:
                return PostgresEamDb.getInstance();

            case SQLITE:
                return SqliteEamDb.getInstance();
            default:
                return null;
        }
    }

    void shutdownConnections() throws EamDbException;

    void updateSettings();

    void saveSettings();

    void reset() throws EamDbException;

    static boolean isEnabled() {
        return EamDbUtil.useCentralRepo()
                && EamDbPlatformEnum.getSelectedPlatform() != EamDbPlatformEnum.DISABLED;
    }

    public void newDbInfo(String name, String value) throws EamDbException;

    public String getDbInfo(String name) throws EamDbException;

    public void updateDbInfo(String name, String value) throws EamDbException;

    CorrelationCase newCase(CorrelationCase eamCase) throws EamDbException;

    CorrelationCase newCase(Case autopsyCase) throws EamDbException;

    void updateCase(CorrelationCase eamCase) throws EamDbException;

    CorrelationCase getCase(Case autopsyCase) throws EamDbException;

    CorrelationCase getCaseByUUID(String caseUUID) throws EamDbException;

    CorrelationCase getCaseById(int caseId) throws EamDbException;
    List<CorrelationCase> getCases() throws EamDbException;
    
    void newDataSource(CorrelationDataSource eamDataSource) throws EamDbException;

    CorrelationDataSource getDataSource(CorrelationCase correlationCase, String dataSourceDeviceId) throws EamDbException;

    
    CorrelationDataSource getDataSourceById(CorrelationCase correlationCase, int dataSourceId) throws EamDbException;
    
    List<CorrelationDataSource> getDataSources() throws EamDbException;

    void addArtifactInstance(CorrelationAttributeInstance eamArtifact) throws EamDbException;

    List<CorrelationAttributeInstance> getArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;
    
    List<CorrelationAttributeInstance> getArtifactInstancesByPath(CorrelationAttributeInstance.Type aType, String filePath) throws EamDbException;

    Long getCountArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;

    int getFrequencyPercentage(CorrelationAttributeInstance corAttr) throws EamDbException, CorrelationAttributeNormalizationException;

    Long getCountUniqueCaseDataSourceTuplesHavingTypeValue(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;

    Long getCountUniqueDataSources() throws EamDbException;

    Long getCountArtifactInstancesByCaseDataSource(String caseUUID, String dataSourceID) throws EamDbException;

    void addAttributeInstanceBulk(CorrelationAttributeInstance eamArtifact) throws EamDbException;

    void commitAttributeInstancesBulk() throws EamDbException;

    void bulkInsertCases(List<CorrelationCase> cases) throws EamDbException;

    void updateAttributeInstanceComment(CorrelationAttributeInstance eamArtifact) throws EamDbException;

    CorrelationAttributeInstance getCorrelationAttributeInstance(CorrelationAttributeInstance.Type type, CorrelationCase correlationCase,
            CorrelationDataSource correlationDataSource, String value, String filePath) throws EamDbException, CorrelationAttributeNormalizationException;

    void setAttributeInstanceKnownStatus(CorrelationAttributeInstance eamArtifact, TskData.FileKnown knownStatus) throws EamDbException;

    List<CorrelationAttributeInstance> getArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;

    List<CorrelationAttributeInstance> getArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType) throws EamDbException;
    Long getCountArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;

    List<String> getListCasesHavingArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;

    public void deleteReferenceSet(int referenceSetID) throws EamDbException;

    public boolean referenceSetIsValid(int referenceSetID, String referenceSetName, String version) throws EamDbException;

    public boolean referenceSetExists(String referenceSetName, String version) throws EamDbException;

    public boolean isFileHashInReferenceSet(String hash, int referenceSetID) throws EamDbException, CorrelationAttributeNormalizationException;

    public boolean isValueInReferenceSet(String value, int referenceSetID, int correlationTypeID) throws EamDbException, CorrelationAttributeNormalizationException;

    boolean isArtifactKnownBadByReference(CorrelationAttributeInstance.Type aType, String value) throws EamDbException, CorrelationAttributeNormalizationException;

    EamOrganization newOrganization(EamOrganization eamOrg) throws EamDbException;

    List<EamOrganization> getOrganizations() throws EamDbException;

    EamOrganization getOrganizationByID(int orgID) throws EamDbException;

    EamOrganization getReferenceSetOrganization(int referenceSetID) throws EamDbException;

    void updateOrganization(EamOrganization updatedOrganization) throws EamDbException;

    void deleteOrganization(EamOrganization organizationToDelete) throws EamDbException;

    int newReferenceSet(EamGlobalSet eamGlobalSet) throws EamDbException;

    EamGlobalSet getReferenceSetByID(int globalSetID) throws EamDbException;

    List<EamGlobalSet> getAllReferenceSets(CorrelationAttributeInstance.Type correlationType) throws EamDbException;

    void addReferenceInstance(EamGlobalFileInstance eamGlobalFileInstance, CorrelationAttributeInstance.Type correlationType) throws EamDbException;

    void bulkInsertReferenceTypeEntries(Set<EamGlobalFileInstance> globalInstances, CorrelationAttributeInstance.Type contentType) throws EamDbException;

    List<EamGlobalFileInstance> getReferenceInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String aValue) throws EamDbException, CorrelationAttributeNormalizationException;

    int newCorrelationType(CorrelationAttributeInstance.Type newType) throws EamDbException;

    List<CorrelationAttributeInstance.Type> getDefinedCorrelationTypes() throws EamDbException;

    List<CorrelationAttributeInstance.Type> getEnabledCorrelationTypes() throws EamDbException;

    List<CorrelationAttributeInstance.Type> getSupportedCorrelationTypes() throws EamDbException;

    void updateCorrelationType(CorrelationAttributeInstance.Type aType) throws EamDbException;

    CorrelationAttributeInstance.Type getCorrelationTypeById(int typeId) throws EamDbException;

    public void upgradeSchema() throws EamDbException, SQLException;

    public CoordinationService.Lock getExclusiveMultiUserDbLock() throws EamDbException;

    void processInstanceTable(CorrelationAttributeInstance.Type type, InstanceTableCallback instanceTableCallback) throws EamDbException;
    
    void processInstanceTableWhere(CorrelationAttributeInstance.Type type, String whereClause, InstanceTableCallback instanceTableCallback) throws EamDbException;

}