CaseMetadata.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2015 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;

import java.nio.file.Path;

public final class CaseMetadata {

    public final static class CaseMetadataException extends Exception {

        private static final long serialVersionUID = 1L;

        private CaseMetadataException(String message) {
            super(message);
        }

        private CaseMetadataException(String message, Throwable cause) {
            super(message, cause);
        }
    }

    private final Case.CaseType caseType;
    private final String caseName;
    private final String caseNumber;
    private final String examiner;
    private final String caseDirectory;
    private final String caseDatabaseName;
    private final String caseTextIndexName;

    public CaseMetadata(Path metadataFilePath) throws CaseMetadataException {
        try {
            /*
             * TODO (RC): This class should eventually replace the non-public
             * and unsafe XMLCaseManagement class altogether.
             */
            XMLCaseManagement metadata = new XMLCaseManagement();
            metadata.open(metadataFilePath.toString());
            try {
                caseType = metadata.getCaseType();
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Case type element missing");
            }
            try {
                caseName = metadata.getCaseName();
                if (caseName.isEmpty()) {
                    throw new CaseMetadataException("Case name missing");
                }
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Case name element missing");
            }
            try {
                caseNumber = metadata.getCaseNumber();
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Case number element missing");
            }
            try {
                examiner = metadata.getCaseExaminer();
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Examiner element missing");
            }
            try {
                caseDirectory = metadata.getCaseDirectory();
                if (caseDirectory.isEmpty()) {
                    throw new CaseMetadataException("Case directory missing");
                }
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Case directory element missing");
            }
            try {
                caseDatabaseName = metadata.getDatabaseName();
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Case database element missing");
            }
            try {
                caseTextIndexName = metadata.getTextIndexName();
                if (Case.CaseType.MULTI_USER_CASE == caseType && caseDatabaseName.isEmpty()) {
                    throw new CaseMetadataException("Case keyword search index name missing");
                }
            } catch (NullPointerException unused) {
                throw new CaseMetadataException("Case keyword search index name missing");
            }
        } catch (CaseActionException ex) {
            throw new CaseMetadataException(ex.getLocalizedMessage(), ex);
        }
    }

    public Case.CaseType getCaseType() {
        return this.caseType;
    }

    public String getCaseName() {
        return caseName;
    }

    public String getCaseNumber() {
        return caseNumber;
    }

    public String getExaminer() {
        return examiner;
    }

    public String getCaseDirectory() {
        return caseDirectory;
    }

    public String getCaseDatabaseName() {
        return caseDatabaseName;
    }

    public String getTextIndexName() {
        return caseTextIndexName;
    }

}