AutopsyEventPublisher.java

Go to the documentation of this file.

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

import java.beans.PropertyChangeListener;
import java.net.URISyntaxException;
import java.util.Set;
import java.util.logging.Level;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.ThreadSafe;
import jakarta.jms.JMSException;
import org.sleuthkit.autopsy.core.UserPreferencesException;
import org.sleuthkit.autopsy.core.UserPreferences;
import org.sleuthkit.autopsy.coreutils.Logger;

@ThreadSafe
public final class AutopsyEventPublisher {

    private static final Logger logger = Logger.getLogger(AutopsyEventPublisher.class.getName());
    private static final int MAX_REMOTE_EVENT_PUBLISH_TRIES = 1;
    private final LocalEventPublisher localPublisher; // LocalEventPublisher is thread-safe
    @GuardedBy("this")
    private RemoteEventPublisher remotePublisher;
    @GuardedBy("this")
    private String currentChannelName;

    public AutopsyEventPublisher() {
        localPublisher = new LocalEventPublisher();
    }

    public synchronized void openRemoteEventChannel(String channelName) throws AutopsyEventException {
        currentChannelName = channelName;
        if (null != remotePublisher) {
            closeRemoteEventChannel();
        }
        try {
            remotePublisher = new RemoteEventPublisher(channelName, localPublisher, UserPreferences.getMessageServiceConnectionInfo());
        } catch (URISyntaxException | JMSException ex) {
            String message = "Failed to open remote event channel"; //NON-NLS
            logger.log(Level.SEVERE, message, ex);
            throw new AutopsyEventException(message, ex);
        } catch (UserPreferencesException ex) {
            String message = "Error accessing messaging service connection info"; //NON-NLS
            logger.log(Level.SEVERE, message, ex);
            throw new AutopsyEventException(message, ex);
        }
    }

    public synchronized void closeRemoteEventChannel() {
        stopRemotePublisher();
        currentChannelName = null;
    }

    public void addSubscriber(Set<String> eventNames, PropertyChangeListener subscriber) {
        localPublisher.addSubscriber(eventNames, subscriber);
    }

    public void addSubscriber(String eventName, PropertyChangeListener subscriber) {
        localPublisher.addSubscriber(eventName, subscriber);
    }

    public void removeSubscriber(Set<String> eventNames, PropertyChangeListener subscriber) {
        localPublisher.removeSubscriber(eventNames, subscriber);
    }

    public void removeSubscriber(String eventName, PropertyChangeListener subscriber) {
        localPublisher.removeSubscriber(eventName, subscriber);
    }

    public void publish(AutopsyEvent event) {
        publishLocally(event);
        publishRemotely(event);
    }

    public void publishLocally(AutopsyEvent event) {
        localPublisher.publish(event);
    }

    public synchronized void publishRemotely(AutopsyEvent event) {
        if (null != currentChannelName) {
            boolean published = false;
            int tryCount = 1;

            while (false == published && tryCount <= MAX_REMOTE_EVENT_PUBLISH_TRIES) {
                try {
                    if (null == remotePublisher) {
                        openRemoteEventChannel(currentChannelName);
                    }
                    remotePublisher.publish(event);
                    published = true;
                } catch (AutopsyEventException | JMSException ex) {
                    logger.log(Level.SEVERE, String.format("Failed to publish %s using channel %s (tryCount = %s)", event.getPropertyName(), currentChannelName, tryCount), ex); //NON-NLS
                    stopRemotePublisher();
                    ++tryCount;
                }
            }
        }
    }

    private synchronized void stopRemotePublisher() {
        if (null != remotePublisher) {
            try {
                remotePublisher.stop();
            } catch (JMSException ex) {
                logger.log(Level.SEVERE, String.format("Error closing remote event publisher for channel %s", currentChannelName), ex); //NON-NLS
            }
            remotePublisher = null;
        }
    }

}