AutopsyService.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2016-2019 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.appservices;

import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.progress.ProgressIndicator;

public interface AutopsyService {

    String getServiceName();

//    Status getStatus() {
//        
//    }
//    default void openAppResources(ApplicationContext context) throws AutopsyServiceException {
//        /*
//         * Autopsy services may not have application-level resources.
//         */
//    }
    default void openCaseResources(CaseContext context) throws AutopsyServiceException {
        /*
         * Autopsy services may not have case-level resources.
         */
    }

    default void closeCaseResources(CaseContext context) throws AutopsyServiceException {
        /*
         * Autopsy services may not have case-level resources.
         */
    }

//    default void closeAppResources(ApplicationContext context) throws AutopsyServiceException {
//        /*
//         * Autopsy services may not have case-level resources.
//         */
//    }
    public static class CaseContext {

        private final Case theCase;
        private final ProgressIndicator progressIndicator;
        private volatile boolean cancelRequested;
        private final boolean isNewCase;

        public CaseContext(Case theCase, ProgressIndicator progressIndicator) {
            this(theCase, progressIndicator, false);
        }
        
        public CaseContext(Case theCase, ProgressIndicator progressIndicator, boolean isNewCase) {
            this.theCase = theCase;
            this.progressIndicator = progressIndicator;
            this.cancelRequested = false;
            this.isNewCase = isNewCase;
        }

        public Case getCase() {
            return this.theCase;
        }

        public ProgressIndicator getProgressIndicator() {
            return this.progressIndicator;
        }

        public void requestCancel() {
            this.cancelRequested = true;
        }

        public boolean cancelRequested() {
            return this.cancelRequested;
        }
        
        public boolean isNewCase() {
            return this.isNewCase;
        }
    }

    public static class AutopsyServiceException extends Exception {

        private static final long serialVersionUID = 1L;

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

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