IngestModule.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014-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.autopsy.ingest;

public interface IngestModule {

    default void startUp(IngestJobContext context) throws IngestModuleException {
    }

    default void shutDown() {
    }

    public class IngestModuleException extends Exception {

        private static final long serialVersionUID = 1L;

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

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

        @Deprecated
        public IngestModuleException() {
        }

    }

    public enum ProcessResult {

        OK,
        ERROR

    };

}