TskDataModelChangedEvent.java

Go to the documentation of this file.

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

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.stream.Collectors;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.events.AutopsyEvent;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;

public abstract class TskDataModelChangedEvent<T, U> extends AutopsyEvent {

    private static final long serialVersionUID = 1L;
    private static final Logger logger = Logger.getLogger(TskDataModelChangedEvent.class.getName());
    private final boolean hasOldValue;
    private final List<Long> oldValueIds;
    private transient List<T> oldValueObjects;
    private final boolean hasNewValue;
    private final List<Long> newValueIds;
    private transient List<U> newValueObjects;

    protected TskDataModelChangedEvent(String eventName, List<T> oldValueObjects, Function<T, Long> oldValueGetIdMethod, List<U> newValueObjects, Function<U, Long> newValueGetIdMethod) {
        super(eventName, null, null);
        oldValueIds = new ArrayList<>();
        this.oldValueObjects = new ArrayList<>();
        if (oldValueObjects != null) {
            hasOldValue = true;
            oldValueIds.addAll(oldValueObjects.stream()
                    .map(o -> oldValueGetIdMethod.apply(o))
                    .collect(Collectors.toList()));
            this.oldValueObjects.addAll(oldValueObjects);
        } else {
            hasOldValue = false;
        }
        newValueIds = new ArrayList<>();
        this.newValueObjects = new ArrayList<>();
        if (newValueObjects != null) {
            hasNewValue = true;
            newValueIds.addAll(newValueObjects.stream()
                    .map(o -> newValueGetIdMethod.apply(o))
                    .collect(Collectors.toList()));
            this.newValueObjects.addAll(newValueObjects);
        } else {
            hasNewValue = false;
        }
    }

    @Override
    public List<T> getOldValue() {
        if (hasOldValue) {
            if (oldValueObjects == null) {
                try {
                    Case currentCase = Case.getCurrentCaseThrows();
                    SleuthkitCase caseDb = currentCase.getSleuthkitCase();
                    oldValueObjects = getOldValueObjects(caseDb, oldValueIds);
                } catch (NoCurrentCaseException | TskCoreException ex) {
                    logger.log(Level.SEVERE, String.format("Error getting oldValue() TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex);
                    return Collections.emptyList();
                }
            }
            return Collections.unmodifiableList(oldValueObjects);
        } else {
            return Collections.emptyList();
        }
    }

    @Override
    public List<U> getNewValue() {
        if (hasNewValue) {
            if (newValueObjects == null) {
                try {
                    Case currentCase = Case.getCurrentCaseThrows();
                    SleuthkitCase caseDb = currentCase.getSleuthkitCase();
                    newValueObjects = getNewValueObjects(caseDb, newValueIds);
                } catch (NoCurrentCaseException | TskCoreException ex) {
                    logger.log(Level.SEVERE, String.format("Error getting newValue() TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex);
                    return Collections.emptyList();
                }
            }
            return Collections.unmodifiableList(newValueObjects);
        } else {
            return Collections.emptyList();
        }
    }

    protected List<T> getOldValueObjects(SleuthkitCase caseDb, List<Long> ids) throws TskCoreException {
        return Collections.emptyList();
    }

    protected List<U> getNewValueObjects(SleuthkitCase caseDb, List<Long> ids) throws TskCoreException {
        return Collections.emptyList();
    }

}