Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
CentralRepository.java
Go to the documentation of this file.
1 /*
2  * Central Repository
3  *
4  * Copyright 2015-2020 Basis Technology Corp.
5  * Contact: carrier <at> sleuthkit <dot> org
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 package org.sleuthkit.autopsy.centralrepository.datamodel;
20 
21 import java.sql.SQLException;
22 import java.util.Collection;
23 import java.util.List;
24 import java.util.Optional;
25 import java.util.Set;
26 import org.sleuthkit.datamodel.TskData;
30 import org.sleuthkit.datamodel.HashHitInfo;
31 import org.sleuthkit.datamodel.InvalidAccountIDException;
32 
36 public interface CentralRepository {
37 
46 
50  }
51  switch (selectedPlatform) {
52  case POSTGRESQL:
53  return PostgresCentralRepo.getInstance();
54 
55  case SQLITE:
56  return SqliteCentralRepo.getInstance();
57  default:
58  return null;
59  }
60  }
61 
73 
82  void updateSettings();
83 
87  void saveSettings();
88 
92  void reset() throws CentralRepoException;
93 
99  static boolean isEnabled() {
102  }
103 
112  public void newDbInfo(String name, String value) throws CentralRepoException;
113 
122  void addDataSourceObjectId(int rowId, long dataSourceObjectId) throws CentralRepoException;
123 
133  public String getDbInfo(String name) throws CentralRepoException;
134 
143  public void updateDbInfo(String name, String value) throws CentralRepoException;
144 
152  CorrelationCase newCase(CorrelationCase eamCase) throws CentralRepoException;
153 
159  CorrelationCase newCase(Case autopsyCase) throws CentralRepoException;
160 
166  void updateCase(CorrelationCase eamCase) throws CentralRepoException;
167 
177  CentralRepoExaminer getOrInsertExaminer(String examinerLoginName) throws CentralRepoException;
178 
188  CorrelationCase getCase(Case autopsyCase) throws CentralRepoException;
189 
197  CorrelationCase getCaseByUUID(String caseUUID) throws CentralRepoException;
198 
206  CorrelationCase getCaseById(int caseId) throws CentralRepoException;
207 
213  List<CorrelationCase> getCases() throws CentralRepoException;
214 
223  CorrelationDataSource newDataSource(CorrelationDataSource eamDataSource) throws CentralRepoException;
224 
230  void updateDataSourceMd5Hash(CorrelationDataSource eamDataSource) throws CentralRepoException;
231 
237  void updateDataSourceSha1Hash(CorrelationDataSource eamDataSource) throws CentralRepoException;
238 
245  void updateDataSourceSha256Hash(CorrelationDataSource eamDataSource) throws CentralRepoException;
246 
256  CorrelationDataSource getDataSource(CorrelationCase correlationCase, Long caseDbDataSourceId) throws CentralRepoException;
257 
267  CorrelationDataSource getDataSourceById(CorrelationCase correlationCase, int dataSourceId) throws CentralRepoException;
268 
274  List<CorrelationDataSource> getDataSources() throws CentralRepoException;
275 
284  void updateDataSourceName(CorrelationDataSource eamDataSource, String newName) throws CentralRepoException;
285 
292  void addArtifactInstance(CorrelationAttributeInstance eamArtifact) throws CentralRepoException;
293 
309 
322  List<CorrelationAttributeInstance> getArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
323 
341  List<CorrelationAttributeInstance> getArtifactInstancesByTypeValuesAndCases(CorrelationAttributeInstance.Type aType, List<String> values, List<Integer> caseIds) throws CentralRepoException, CorrelationAttributeNormalizationException;
342 
353  Long getCountArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
354 
362  int getFrequencyPercentage(CorrelationAttributeInstance corAttr) throws CentralRepoException, CorrelationAttributeNormalizationException;
363 
374  Long getCountUniqueCaseDataSourceTuplesHavingTypeValue(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
375 
381  Long getCountUniqueDataSources() throws CentralRepoException;
382 
392  Long getCountArtifactInstancesByCaseDataSource(CorrelationDataSource correlationDataSource) throws CentralRepoException;
393 
401  void addAttributeInstanceBulk(CorrelationAttributeInstance eamArtifact) throws CentralRepoException;
402 
407  void commitAttributeInstancesBulk() throws CentralRepoException;
408 
412  void bulkInsertCases(List<CorrelationCase> cases) throws CentralRepoException;
413 
423  void updateAttributeInstanceComment(CorrelationAttributeInstance eamArtifact) throws CentralRepoException;
424 
443  CorrelationDataSource correlationDataSource, String value, String filePath) throws CentralRepoException, CorrelationAttributeNormalizationException;
444 
459  CorrelationDataSource correlationDataSource, long objectID) throws CentralRepoException, CorrelationAttributeNormalizationException;
460 
468  void setAttributeInstanceKnownStatus(CorrelationAttributeInstance eamArtifact, TskData.FileKnown knownStatus) throws CentralRepoException;
469 
478  Long getCountArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
479 
492  List<String> getListCasesHavingArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
493 
506  List<String> getListCasesHavingArtifactInstances(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
507 
515  public void deleteReferenceSet(int referenceSetID) throws CentralRepoException;
516 
530  public boolean referenceSetIsValid(int referenceSetID, String referenceSetName, String version) throws CentralRepoException;
531 
544  public boolean referenceSetExists(String referenceSetName, String version) throws CentralRepoException;
545 
557  public boolean isFileHashInReferenceSet(String hash, int referenceSetID) throws CentralRepoException, CorrelationAttributeNormalizationException;
558 
572  HashHitInfo lookupHash(String hash, int referenceSetID) throws CentralRepoException, CorrelationAttributeNormalizationException;
573 
583  public boolean isValueInReferenceSet(String value, int referenceSetID, int correlationTypeID) throws CentralRepoException, CorrelationAttributeNormalizationException;
584 
593  boolean isArtifactKnownBadByReference(CorrelationAttributeInstance.Type aType, String value) throws CentralRepoException, CorrelationAttributeNormalizationException;
594 
604  CentralRepoOrganization newOrganization(CentralRepoOrganization eamOrg) throws CentralRepoException;
605 
613  List<CentralRepoOrganization> getOrganizations() throws CentralRepoException;
614 
624  CentralRepoOrganization getOrganizationByID(int orgID) throws CentralRepoException;
625 
635  CentralRepoOrganization getReferenceSetOrganization(int referenceSetID) throws CentralRepoException;
636 
645  void updateOrganization(CentralRepoOrganization updatedOrganization) throws CentralRepoException;
646 
654  void deleteOrganization(CentralRepoOrganization organizationToDelete) throws CentralRepoException;
655 
665  int newReferenceSet(CentralRepoFileSet eamGlobalSet) throws CentralRepoException;
666 
676  CentralRepoFileSet getReferenceSetByID(int globalSetID) throws CentralRepoException;
677 
687  List<CentralRepoFileSet> getAllReferenceSets(CorrelationAttributeInstance.Type correlationType) throws CentralRepoException;
688 
697  void addReferenceInstance(CentralRepoFileInstance eamGlobalFileInstance, CorrelationAttributeInstance.Type correlationType) throws CentralRepoException;
698 
708  void bulkInsertReferenceTypeEntries(Set<CentralRepoFileInstance> globalInstances, CorrelationAttributeInstance.Type contentType) throws CentralRepoException;
709 
720  List<CentralRepoFileInstance> getReferenceInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String aValue) throws CentralRepoException, CorrelationAttributeNormalizationException;
721 
731  int newCorrelationType(CorrelationAttributeInstance.Type newType) throws CentralRepoException;
732 
742  List<CorrelationAttributeInstance.Type> getDefinedCorrelationTypes() throws CentralRepoException;
743 
753  List<CorrelationAttributeInstance.Type> getEnabledCorrelationTypes() throws CentralRepoException;
754 
764  List<CorrelationAttributeInstance.Type> getSupportedCorrelationTypes() throws CentralRepoException;
765 
773  void updateCorrelationType(CorrelationAttributeInstance.Type aType) throws CentralRepoException;
774 
784  CorrelationAttributeInstance.Type getCorrelationTypeById(int typeId) throws CentralRepoException;
785 
791  public void upgradeSchema() throws CentralRepoException, SQLException, IncompatibleCentralRepoException;
792 
804  public CoordinationService.Lock getExclusiveMultiUserDbLock() throws CentralRepoException;
805 
814  void processInstanceTable(CorrelationAttributeInstance.Type type, InstanceTableCallback instanceTableCallback) throws CentralRepoException;
815 
825  void processInstanceTableWhere(CorrelationAttributeInstance.Type type, String whereClause, InstanceTableCallback instanceTableCallback) throws CentralRepoException;
826 
835  public void processSelectClause(String selectClause, InstanceTableCallback instanceTableCallback) throws CentralRepoException;
836 
846  void executeCommand(String sql, List<Object> params) throws CentralRepoException;
847 
858  void executeQuery(String sql, List<Object> params, CentralRepositoryDbQueryCallback queryCallback) throws CentralRepoException;
859 
867  Optional<CentralRepoAccountType> getAccountTypeByName(String accountTypeName) throws CentralRepoException;
868 
876  Collection<CentralRepoAccountType> getAllAccountTypes() throws CentralRepoException;
877 
889  CentralRepoAccount getOrCreateAccount(CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID) throws InvalidAccountIDException, CentralRepoException;
890 
903  CentralRepoAccount getAccount(CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID) throws InvalidAccountIDException, CentralRepoException;
904 
905 }
void addAttributeInstanceBulk(CorrelationAttributeInstance eamArtifact)
boolean referenceSetExists(String referenceSetName, String version)
List< String > getListCasesHavingArtifactInstances(CorrelationAttributeInstance.Type aType, String value)
void executeQuery(String sql, List< Object > params, CentralRepositoryDbQueryCallback queryCallback)
CentralRepoOrganization newOrganization(CentralRepoOrganization eamOrg)
Long getCountArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String value)
void addReferenceInstance(CentralRepoFileInstance eamGlobalFileInstance, CorrelationAttributeInstance.Type correlationType)
List< CentralRepoFileSet > getAllReferenceSets(CorrelationAttributeInstance.Type correlationType)
CentralRepoAccount getAccount(CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID)
List< CorrelationAttributeInstance > getArtifactInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String value)
void deleteOrganization(CentralRepoOrganization organizationToDelete)
boolean isArtifactKnownBadByReference(CorrelationAttributeInstance.Type aType, String value)
CentralRepoExaminer getOrInsertExaminer(String examinerLoginName)
void setAttributeInstanceKnownStatus(CorrelationAttributeInstance eamArtifact, TskData.FileKnown knownStatus)
void addDataSourceObjectId(int rowId, long dataSourceObjectId)
void bulkInsertReferenceTypeEntries(Set< CentralRepoFileInstance > globalInstances, CorrelationAttributeInstance.Type contentType)
void updateAttributeInstanceComment(CorrelationAttributeInstance eamArtifact)
List< String > getListCasesHavingArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value)
Optional< CentralRepoAccountType > getAccountTypeByName(String accountTypeName)
List< CorrelationAttributeInstance.Type > getDefinedCorrelationTypes()
void addArtifactInstance(CorrelationAttributeInstance eamArtifact)
Long getCountArtifactInstancesKnownBad(CorrelationAttributeInstance.Type aType, String value)
List< CentralRepoFileInstance > getReferenceInstancesByTypeValue(CorrelationAttributeInstance.Type aType, String aValue)
void updateDataSourceSha1Hash(CorrelationDataSource eamDataSource)
void processInstanceTableWhere(CorrelationAttributeInstance.Type type, String whereClause, InstanceTableCallback instanceTableCallback)
HashHitInfo lookupHash(String hash, int referenceSetID)
void processInstanceTable(CorrelationAttributeInstance.Type type, InstanceTableCallback instanceTableCallback)
boolean isFileHashInReferenceSet(String hash, int referenceSetID)
List< CorrelationAttributeInstance > getArtifactInstancesByTypeValues(CorrelationAttributeInstance.Type aType, List< String > values)
void updateOrganization(CentralRepoOrganization updatedOrganization)
int newCorrelationType(CorrelationAttributeInstance.Type newType)
boolean referenceSetIsValid(int referenceSetID, String referenceSetName, String version)
void updateDataSourceName(CorrelationDataSource eamDataSource, String newName)
CorrelationAttributeInstance getCorrelationAttributeInstance(CorrelationAttributeInstance.Type type, CorrelationCase correlationCase, CorrelationDataSource correlationDataSource, String value, String filePath)
void updateDataSourceMd5Hash(CorrelationDataSource eamDataSource)
void updateCorrelationType(CorrelationAttributeInstance.Type aType)
CorrelationDataSource newDataSource(CorrelationDataSource eamDataSource)
List< CorrelationAttributeInstance > getArtifactInstancesByTypeValuesAndCases(CorrelationAttributeInstance.Type aType, List< String > values, List< Integer > caseIds)
boolean isValueInReferenceSet(String value, int referenceSetID, int correlationTypeID)
int getFrequencyPercentage(CorrelationAttributeInstance corAttr)
List< CorrelationAttributeInstance.Type > getEnabledCorrelationTypes()
CorrelationDataSource getDataSource(CorrelationCase correlationCase, Long caseDbDataSourceId)
CorrelationAttributeInstance.Type getCorrelationTypeById(int typeId)
List< CorrelationAttributeInstance.Type > getSupportedCorrelationTypes()
void processSelectClause(String selectClause, InstanceTableCallback instanceTableCallback)
Long getCountArtifactInstancesByCaseDataSource(CorrelationDataSource correlationDataSource)
CentralRepoOrganization getReferenceSetOrganization(int referenceSetID)
void updateDataSourceSha256Hash(CorrelationDataSource eamDataSource)
Long getCountUniqueCaseDataSourceTuplesHavingTypeValue(CorrelationAttributeInstance.Type aType, String value)
CentralRepoAccount getOrCreateAccount(CentralRepoAccount.CentralRepoAccountType crAccountType, String accountUniqueID)
CorrelationDataSource getDataSourceById(CorrelationCase correlationCase, int dataSourceId)

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.