ArtifactHelperBase.java

Go to the documentation of this file.

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

import java.util.Collection;
import java.util.Optional;
import org.apache.commons.lang3.StringUtils;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.SleuthkitCase;

class ArtifactHelperBase {

        private final SleuthkitCase caseDb;
        private final Content srcContent;
        private final String moduleName;
        private final Long ingestJobId;

        ArtifactHelperBase(SleuthkitCase caseDb, String moduleName, Content srcContent, Long ingestJobId) {
                this.moduleName = moduleName;
                this.srcContent = srcContent;
                this.caseDb = caseDb;
                this.ingestJobId = ingestJobId;
        }

        Content getContent() {
                return srcContent;
        }

        SleuthkitCase getSleuthkitCase() {
                return caseDb;
        }

        String getModuleName() {
                return moduleName;
        }

        Optional<Long> getIngestJobId() {
                return Optional.ofNullable(ingestJobId);
        }

        void addAttributeIfNotNull(BlackboardAttribute.ATTRIBUTE_TYPE attributeType, String attrValue, Collection<BlackboardAttribute> attributes) {
                if (!StringUtils.isEmpty(attrValue)) {
                        attributes.add(new BlackboardAttribute(attributeType, getModuleName(), attrValue));
                }
        }

        void addAttributeIfNotZero(BlackboardAttribute.ATTRIBUTE_TYPE attributeType, long attrValue, Collection<BlackboardAttribute> attributes) {
                if (attrValue > 0) {
                        attributes.add(new BlackboardAttribute(attributeType, getModuleName(), attrValue));
                }
        }

        void addAttributeIfNotZero(BlackboardAttribute.ATTRIBUTE_TYPE attributeType, int attrValue, Collection<BlackboardAttribute> attributes) {
                if (attrValue > 0) {
                        attributes.add(new BlackboardAttribute(attributeType, getModuleName(), attrValue));
                }
        }

}