CentralRepository.java

Go to the documentation of this file.

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

import java.sql.SQLException;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import org.sleuthkit.datamodel.TskData;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoAccount.CentralRepoAccountType;
import org.sleuthkit.autopsy.coordinationservice.CoordinationService;
import org.sleuthkit.datamodel.HashHitInfo;
import org.sleuthkit.datamodel.InvalidAccountIDException;

public interface CentralRepository {

    static CentralRepository getInstance() throws CentralRepoException {

        CentralRepoPlatforms selectedPlatform = CentralRepoPlatforms.DISABLED;
        if (CentralRepoDbUtil.allowUseOfCentralRepository()) {
            selectedPlatform = CentralRepoDbManager.getSavedDbChoice().getDbPlatform();
        }
        switch (selectedPlatform) {
            case POSTGRESQL:
                return PostgresCentralRepo.getInstance();

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

    void shutdownConnections() throws CentralRepoException;

    void updateSettings();

    void saveSettings();

    void reset() throws CentralRepoException;

    static boolean isEnabled() {
        return CentralRepoDbUtil.allowUseOfCentralRepository()
                && CentralRepoDbManager.getSavedDbChoice() != CentralRepoDbChoice.DISABLED;
    }

    void newDbInfo(String name, String value) throws CentralRepoException;

    void addDataSourceObjectId(int rowId, long dataSourceObjectId) throws CentralRepoException;

    String getDbInfo(String name) throws CentralRepoException;

    void updateDbInfo(String name, String value) throws CentralRepoException;

    CorrelationCase newCase(CorrelationCase eamCase) throws CentralRepoException;

    CorrelationCase newCase(Case autopsyCase) throws CentralRepoException;

    void updateCase(CorrelationCase eamCase) throws CentralRepoException;

    CentralRepoExaminer getOrInsertExaminer(String examinerLoginName) throws CentralRepoException;

    CorrelationCase getCase(Case autopsyCase) throws CentralRepoException;

    CorrelationCase getCaseByUUID(String caseUUID) throws CentralRepoException;

    CorrelationCase getCaseById(int caseId) throws CentralRepoException;

    List<CorrelationCase> getCases() throws CentralRepoException;

    CorrelationDataSource newDataSource(CorrelationDataSource eamDataSource) throws CentralRepoException;

    void updateDataSourceMd5Hash(CorrelationDataSource eamDataSource) throws CentralRepoException;

    void updateDataSourceSha1Hash(CorrelationDataSource eamDataSource) throws CentralRepoException;

    void updateDataSourceSha256Hash(CorrelationDataSource eamDataSource) throws CentralRepoException;

    CorrelationDataSource getDataSource(CorrelationCase correlationCase, Long caseDbDataSourceId) throws CentralRepoException;

    CorrelationDataSource getDataSourceById(CorrelationCase correlationCase, int dataSourceId) throws CentralRepoException;

    List<CorrelationDataSource> getDataSources() throws CentralRepoException;

    void updateDataSourceName(CorrelationDataSource eamDataSource, String newName) throws CentralRepoException;

    void addArtifactInstance(CorrelationAttributeInstance eamArtifact) throws CentralRepoException;

    List<CorrelationAttributeInstance> getArtifactInstancesByTypeValues(CorrelationAttributeInstance.Type aType, List<String> values) throws CentralRepoException, CorrelationAttributeNormalizationException;

    List<CorrelationAttributeInstance> getArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type type, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;

    List<CorrelationAttributeInstance> getArtifactInstancesByTypeValuesAndCases(CorrelationAttributeInstance.Type aType, List<String> values, List<Integer> caseIds) throws CentralRepoException, CorrelationAttributeNormalizationException;

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

    int getFrequencyPercentage(CorrelationAttributeInstance corAttr) throws CentralRepoException, CorrelationAttributeNormalizationException;

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

    Long getCountCasesWithOtherInstances(CorrelationAttributeInstance instance) throws CentralRepoException, CorrelationAttributeNormalizationException;

    Long getCountUniqueDataSources() throws CentralRepoException;

    Long getCountArtifactInstancesByCaseDataSource(CorrelationDataSource correlationDataSource) throws CentralRepoException;

    void addAttributeInstanceBulk(CorrelationAttributeInstance eamArtifact) throws CentralRepoException;

    void commitAttributeInstancesBulk() throws CentralRepoException;

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

    void updateAttributeInstanceComment(CorrelationAttributeInstance eamArtifact) throws CentralRepoException;

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

    CorrelationAttributeInstance getCorrelationAttributeInstance(CorrelationAttributeInstance.Type type, CorrelationCase correlationCase,
            CorrelationDataSource correlationDataSource, long objectID) throws CentralRepoException, CorrelationAttributeNormalizationException;

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

    Long getCountArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;

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

    List<String> getListCasesHavingArtifactInstances(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;

    void deleteReferenceSet(int referenceSetID) throws CentralRepoException;

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

    boolean referenceSetExists(String referenceSetName, String version) throws CentralRepoException;

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

    HashHitInfo lookupHash(String hash, int referenceSetID) throws CentralRepoException, CorrelationAttributeNormalizationException;

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

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

    CentralRepoOrganization newOrganization(CentralRepoOrganization eamOrg) throws CentralRepoException;

    List<CentralRepoOrganization> getOrganizations() throws CentralRepoException;

    CentralRepoOrganization getOrganizationByID(int orgID) throws CentralRepoException;

    CentralRepoOrganization getReferenceSetOrganization(int referenceSetID) throws CentralRepoException;

    void updateOrganization(CentralRepoOrganization updatedOrganization) throws CentralRepoException;

    void deleteOrganization(CentralRepoOrganization organizationToDelete) throws CentralRepoException;

    int newReferenceSet(CentralRepoFileSet eamGlobalSet) throws CentralRepoException;

    CentralRepoFileSet getReferenceSetByID(int globalSetID) throws CentralRepoException;

    List<CentralRepoFileSet> getAllReferenceSets(CorrelationAttributeInstance.Type correlationType) throws CentralRepoException;

    void addReferenceInstance(CentralRepoFileInstance eamGlobalFileInstance, CorrelationAttributeInstance.Type correlationType) throws CentralRepoException;

    void bulkInsertReferenceTypeEntries(Set<CentralRepoFileInstance> globalInstances, CorrelationAttributeInstance.Type contentType) throws CentralRepoException;

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

    int newCorrelationType(CorrelationAttributeInstance.Type newType) throws CentralRepoException;

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

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

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

    void updateCorrelationType(CorrelationAttributeInstance.Type aType) throws CentralRepoException;

    CorrelationAttributeInstance.Type getCorrelationTypeById(int typeId) throws CentralRepoException;

    void upgradeSchema() throws CentralRepoException, SQLException, IncompatibleCentralRepoException;

    CoordinationService.Lock getExclusiveMultiUserDbLock() throws CentralRepoException;

    void processInstanceTable(CorrelationAttributeInstance.Type type, InstanceTableCallback instanceTableCallback) throws CentralRepoException;

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

    void processSelectClause(String selectClause, InstanceTableCallback instanceTableCallback) throws CentralRepoException;

    void executeCommand(String sql, List<Object> params) throws CentralRepoException;

    void executeQuery(String sql, List<Object> params, CentralRepositoryDbQueryCallback queryCallback) throws CentralRepoException;

    Optional<CentralRepoAccountType> getAccountTypeByName(String accountTypeName) throws CentralRepoException;

    Collection<CentralRepoAccountType> getAllAccountTypes() throws CentralRepoException;

    CentralRepoAccount getOrCreateAccount(CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID) throws InvalidAccountIDException, CentralRepoException;

    CentralRepoAccount getAccount(CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID) throws InvalidAccountIDException, CentralRepoException;

}