mirror of
https://github.com/overcuriousity/autopsy-flatpak.git
synced 2025-07-06 21:00:22 +00:00
Fixing parameters for doxygen
This commit is contained in:
Ann Priestman
parent
f5b2c2b56a
commit
43e87bc0ad
@ -256,7 +256,7 @@ public abstract class AbstractSqlEamDb implements EamDb {
|
||||
/**
|
||||
* Creates new Case in the database from the given case
|
||||
*
|
||||
* @param case The case to add
|
||||
* @param autopsyCase The case to add
|
||||
*/
|
||||
@Override
|
||||
public CorrelationCase newCase(Case autopsyCase) throws EamDbException {
|
||||
@ -572,9 +572,11 @@ public abstract class AbstractSqlEamDb implements EamDb {
|
||||
* Retrieves eamArtifact instances from the database that are associated
|
||||
* with the eamArtifactType and eamArtifactValue of the given eamArtifact.
|
||||
*
|
||||
* @param eamArtifact The type/value to look up (artifact with 0 instances)
|
||||
* @param aType The type of the artifact
|
||||
* @param value The correlation value
|
||||
*
|
||||
* @return List of artifact instances for a given type/value
|
||||
* @throws EamDbException
|
||||
*/
|
||||
@Override
|
||||
public List<CorrelationAttributeInstance> getArtifactInstancesByTypeValue(CorrelationAttribute.Type aType, String value) throws EamDbException {
|
||||
@ -673,8 +675,8 @@ public abstract class AbstractSqlEamDb implements EamDb {
|
||||
* Retrieves number of artifact instances in the database that are
|
||||
* associated with the ArtifactType and artifactValue of the given artifact.
|
||||
*
|
||||
* @param eamArtifact Artifact with artifactType and artifactValue to search
|
||||
* for
|
||||
* @param aType The type of the artifact
|
||||
* @param value The correlation value
|
||||
*
|
||||
* @return Number of artifact instances having ArtifactType and
|
||||
* ArtifactValue.
|
||||
@ -723,8 +725,8 @@ public abstract class AbstractSqlEamDb implements EamDb {
|
||||
* database that are associated with the artifactType and artifactValue of
|
||||
* the given artifact.
|
||||
*
|
||||
* @param eamArtifact Artifact with artifactType and artifactValue to search
|
||||
* for
|
||||
* @param aType The type of the artifact
|
||||
* @param value The correlation value
|
||||
*
|
||||
* @return Number of unique tuples
|
||||
*/
|
||||
@ -1017,7 +1019,7 @@ public abstract class AbstractSqlEamDb implements EamDb {
|
||||
* given status.
|
||||
*
|
||||
* @param eamArtifact Artifact containing exactly one (1) ArtifactInstance.
|
||||
* @param FileKnown The status to change the artifact to
|
||||
* @param knownStatus The status to change the artifact to
|
||||
*/
|
||||
@Override
|
||||
public void setArtifactInstanceKnownStatus(CorrelationAttribute eamArtifact, TskData.FileKnown knownStatus) throws EamDbException {
|
||||
|
||||
@ -144,6 +144,8 @@ public class CorrelationAttribute implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the list of artifact instances
|
||||
*
|
||||
* @param artifactInstances the List of artifactInstances to set.
|
||||
*/
|
||||
public void setInstances(List<CorrelationAttributeInstance> artifactInstances) {
|
||||
@ -154,7 +156,9 @@ public class CorrelationAttribute implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param instance the instance to add
|
||||
* Add an artifact instance to the list
|
||||
*
|
||||
* @param artifactInstance the instance to add
|
||||
*/
|
||||
public void addInstance(CorrelationAttributeInstance artifactInstance) {
|
||||
this.artifactInstances.add(artifactInstance);
|
||||
@ -209,7 +213,7 @@ public class CorrelationAttribute implements Serializable {
|
||||
/**
|
||||
* Determine if 2 Type objects are equal
|
||||
*
|
||||
* @param otherType Type object for comparison.
|
||||
* @param that Type object for comparison.
|
||||
*
|
||||
* @return true or false
|
||||
*/
|
||||
|
||||
@ -152,7 +152,7 @@ public interface EamDb {
|
||||
/**
|
||||
* Creates new Case in the database from the given case
|
||||
*
|
||||
* @param case The case to add
|
||||
* @param autopsyCase The case to add
|
||||
*/
|
||||
CorrelationCase newCase(Case autopsyCase) throws EamDbException;
|
||||
|
||||
@ -314,7 +314,7 @@ public interface EamDb {
|
||||
* exists, it is updated. If eamArtifact does not exist nothing happens
|
||||
*
|
||||
* @param eamArtifact Artifact containing exactly one (1) ArtifactInstance.
|
||||
* @param FileKnown The status to change the artifact to
|
||||
* @param knownStatus The status to change the artifact to
|
||||
*/
|
||||
void setArtifactInstanceKnownStatus(CorrelationAttribute eamArtifact, TskData.FileKnown knownStatus) throws EamDbException;
|
||||
|
||||
@ -425,14 +425,6 @@ public interface EamDb {
|
||||
*/
|
||||
void addReferenceInstance(EamGlobalFileInstance eamGlobalFileInstance, CorrelationAttribute.Type correlationType) throws EamDbException;
|
||||
|
||||
/**
|
||||
* Add a new global file instance to the bulk collection
|
||||
*
|
||||
* @param eamGlobalFileInstance The global file instance to add
|
||||
*
|
||||
* @throws EamDbException
|
||||
*/
|
||||
// void prepareGlobalFileInstance(EamGlobalFileInstance eamGlobalFileInstance) throws EamDbException;
|
||||
/**
|
||||
* Insert the bulk collection of Global File Instances
|
||||
*
|
||||
|
||||
@ -268,7 +268,7 @@ public class SqliteEamDb extends AbstractSqlEamDb {
|
||||
/**
|
||||
* Creates new Case in the database from the given case
|
||||
*
|
||||
* @param case The case to add
|
||||
* @param autopsyCase The case to add
|
||||
*/
|
||||
@Override
|
||||
public CorrelationCase newCase(Case autopsyCase) throws EamDbException {
|
||||
@ -412,7 +412,8 @@ public class SqliteEamDb extends AbstractSqlEamDb {
|
||||
* Retrieves eamArtifact instances from the database that are associated
|
||||
* with the eamArtifactType and eamArtifactValue of the given eamArtifact.
|
||||
*
|
||||
* @param eamArtifact The type/value to look up (artifact with 0 instances)
|
||||
* @param aType The type of the artifact
|
||||
* @param value The correlation value
|
||||
*
|
||||
* @return List of artifact instances for a given type/value
|
||||
*/
|
||||
@ -451,11 +452,12 @@ public class SqliteEamDb extends AbstractSqlEamDb {
|
||||
* Retrieves number of artifact instances in the database that are
|
||||
* associated with the ArtifactType and artifactValue of the given artifact.
|
||||
*
|
||||
* @param eamArtifact Artifact with artifactType and artifactValue to search
|
||||
* for
|
||||
* @param aType The correlation type
|
||||
* @param value The value to search for
|
||||
*
|
||||
* @return Number of artifact instances having ArtifactType and
|
||||
* ArtifactValue.
|
||||
* @throws EamDbException
|
||||
*/
|
||||
@Override
|
||||
public Long getCountArtifactInstancesByTypeValue(CorrelationAttribute.Type aType, String value) throws EamDbException {
|
||||
@ -482,10 +484,11 @@ public class SqliteEamDb extends AbstractSqlEamDb {
|
||||
* database that are associated with the artifactType and artifactValue of
|
||||
* the given artifact.
|
||||
*
|
||||
* @param eamArtifact Artifact with artifactType and artifactValue to search
|
||||
* for
|
||||
* @param aType The correlation type
|
||||
* @param value The value to search for
|
||||
*
|
||||
* @return Number of unique tuples
|
||||
* @throws EamDbException
|
||||
*/
|
||||
@Override
|
||||
public Long getCountUniqueCaseDataSourceTuplesHavingTypeValue(CorrelationAttribute.Type aType, String value) throws EamDbException {
|
||||
@ -557,10 +560,11 @@ public class SqliteEamDb extends AbstractSqlEamDb {
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets an eamArtifact instance as knownStatus = "Bad". If eamArtifact
|
||||
* Sets an eamArtifact instance as the given knownStatus. If eamArtifact
|
||||
* exists, it is updated. If eamArtifact does not exist nothing happens
|
||||
*
|
||||
* @param eamArtifact Artifact containing exactly one (1) ArtifactInstance.
|
||||
* @param knownStatus The known status of the artifact
|
||||
*/
|
||||
@Override
|
||||
public void setArtifactInstanceKnownStatus(CorrelationAttribute eamArtifact, TskData.FileKnown knownStatus) throws EamDbException {
|
||||
|
||||
@ -52,7 +52,7 @@ The blackboard allows modules to communicate with each other and the UI. It has
|
||||
|
||||
The blackboard is not unique to Autopsy. It is part of The Sleuth Kit datamodel and The Sleuth Kit Framework. In the name of reducing the amount of documentation that we need to maintain, we provide links here to those documentation sources.
|
||||
|
||||
- \ref mod_bbpage (http://sleuthkit.org/sleuthkit/docs/jni-docs/4.3/mod_bbpage.html)
|
||||
- <a href="http://sleuthkit.org/sleuthkit/docs/jni-docs/4.3/mod_bbpage.html">The Blackboard</a>
|
||||
|
||||
|
||||
\subsection mod_dev_other_services Framework Services and Utilities
|
||||
|
||||
@ -321,8 +321,9 @@ public final class ThunderbirdMboxFileIngestModule implements FileIngestModule {
|
||||
*
|
||||
* @param attachments
|
||||
* @param abstractFile
|
||||
* @param messageArtifact
|
||||
*
|
||||
* @return
|
||||
* @return List of attachments
|
||||
*/
|
||||
private List<AbstractFile> handleAttachments(List<EmailMessage.Attachment> attachments, AbstractFile abstractFile, BlackboardArtifact messageArtifact) {
|
||||
List<AbstractFile> files = new ArrayList<>();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user