Blackboard.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * 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.casemodule.services;

import java.io.Closeable;
import java.io.IOException;
import org.openide.util.Lookup;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskDataException;

public final class Blackboard implements Closeable {

    private SleuthkitCase caseDb;
    
    Blackboard(SleuthkitCase casedb) {
        this.caseDb = casedb;
    }

    public synchronized void indexArtifact(BlackboardArtifact artifact) throws BlackboardException {
        if (null == caseDb) {
            throw new BlackboardException("Blackboard has been closed");
        }
        KeywordSearchService searchService = Lookup.getDefault().lookup(KeywordSearchService.class);
        if (null == searchService) {
            throw new BlackboardException("Keyword search service not found");
        }
        try {
            searchService.index(artifact);
        } catch (TskCoreException ex) {
            throw new BlackboardException("Error indexing artifact", ex);
        }
    }

    public synchronized BlackboardArtifact.Type getOrAddArtifactType(String typeName, String displayName) throws BlackboardException {
        if (null == caseDb) {
            throw new BlackboardException("Blackboard has been closed");
        }
        try {
            return caseDb.addBlackboardArtifactType(typeName, displayName);
        } catch (TskDataException typeExistsEx) {
            try {
                return caseDb.getArtifactType(typeName);
            } catch (TskCoreException ex) {
                throw new BlackboardException("Failed to get or add artifact type", ex);
            }
        } catch (TskCoreException ex) {
            throw new BlackboardException("Failed to get or add artifact type", ex);
        }
    }

    public synchronized BlackboardAttribute.Type getOrAddAttributeType(String typeName, BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE valueType, String displayName) throws BlackboardException {
        if (null == caseDb) {
            throw new BlackboardException("Blackboard has been closed");
        }
        try {
            return caseDb.addArtifactAttributeType(typeName, valueType, displayName);
        } catch (TskDataException typeExistsEx) {
            try {
                return caseDb.getAttributeType(typeName);
            } catch (TskCoreException ex) {
                throw new BlackboardException("Failed to get or add attribute type", ex);
            }
        } catch (TskCoreException ex) {
            throw new BlackboardException("Failed to get or add attribute type", ex);
        }
    }

    @Override
    public synchronized void close() throws IOException {
        caseDb = null;
    }


    public static final class BlackboardException extends Exception {

        private static final long serialVersionUID = 1L;

        public BlackboardException(String message) {
            super(message);
        }

        public BlackboardException(String message, Throwable cause) {
            super(message, cause);
        }
    }
}