Classes
class	CrashDetectionTask

enum	Service

class	ServicesMonitorException

enum	ServiceStatus

Public Member Functions
void	addSubscriber (PropertyChangeListener subscriber)

void	addSubscriber (Set< String > eventNames, PropertyChangeListener subscriber)

void	addSubscriber (String eventName, PropertyChangeListener subscriber)

String	getServiceStatus (String service) throws ServicesMonitorException

void	removeSubscriber (Set< String > eventNames, PropertyChangeListener subscriber)

void	removeSubscriber (String eventName, PropertyChangeListener subscriber)

void	removeSubscriber (PropertyChangeListener subscriber)

void	setServiceStatus (String service, String status, String details)

Static Public Member Functions
static synchronized ServicesMonitor	getInstance ()

Private Member Functions
	ServicesMonitor ()

void	checkAllServices ()

void	checkDatabaseConnectionStatus ()

void	checkKeywordSearchServerConnectionStatus ()

void	checkMessagingServerConnectionStatus ()

void	checkServiceStatus (String service)

Private Attributes
AutopsyEventPublisher	eventPublisher

final ScheduledThreadPoolExecutor	periodicTasksExecutor

final ConcurrentHashMap< String, String >	statusByService

Static Private Attributes
static final long	CRASH_DETECTION_INTERVAL_MINUTES = 15

static ServicesMonitor	instance = new ServicesMonitor()

static final Logger	logger = Logger.getLogger(ServicesMonitor.class.getName())

static final int	NUMBER_OF_PERIODIC_TASK_THREADS = 1

static final String	PERIODIC_TASK_THREAD_NAME = "services-monitor-periodic-task-%d"

static final Set< String >	servicesList

Detailed Description

This class periodically checks availability of collaboration resources - remote database, remote keyword search server, messaging service - and reports status updates to the user in case of a gap in service.

Definition at line 49 of file ServicesMonitor.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.core.ServicesMonitor.ServicesMonitor ( )

private

Start periodic task that check the availability of key collaboration services.

Definition at line 133 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.checkAllServices().

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.getInstance().

Member Function Documentation

void org.sleuthkit.autopsy.core.ServicesMonitor.addSubscriber ( PropertyChangeListener subscriber )

Adds an event subscriber to this publisher. Subscriber will be subscribed to all events from this publisher.

Parameters

subscriber The subscriber to add.

Definition at line 312 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.addSubscriber().

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.subscribeToServiceMonitorEvents().

void org.sleuthkit.autopsy.core.ServicesMonitor.addSubscriber	(	Set< String >	eventNames,
		PropertyChangeListener	subscriber
	)

Adds an event subscriber to this publisher.

Parameters

eventNames	The events the subscriber is interested in.
subscriber	The subscriber to add.

Definition at line 322 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.addSubscriber().

void org.sleuthkit.autopsy.core.ServicesMonitor.addSubscriber	(	String	eventName,
		PropertyChangeListener	subscriber
	)

Adds an event subscriber to this publisher.

Parameters

eventName	The event the subscriber is interested in.
subscriber	The subscriber to add.

Definition at line 332 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.addSubscriber().

void org.sleuthkit.autopsy.core.ServicesMonitor.checkAllServices ( )

private

Verifies connectivity to all services.

Definition at line 369 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.checkServiceStatus(), and org.sleuthkit.autopsy.core.UserPreferences.getIsMultiUserModeEnabled().

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.CrashDetectionTask.run(), and org.sleuthkit.autopsy.core.ServicesMonitor.ServicesMonitor().

void org.sleuthkit.autopsy.core.ServicesMonitor.checkDatabaseConnectionStatus ( )

private

Performs case database service availability status check.

Definition at line 241 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.DOWN, org.sleuthkit.autopsy.core.UserPreferences.getDatabaseConnectionInfo(), org.sleuthkit.autopsy.core.ServicesMonitor.Service.REMOTE_CASE_DATABASE, org.sleuthkit.autopsy.core.ServicesMonitor.setServiceStatus(), and org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.UP.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkServiceStatus().

void org.sleuthkit.autopsy.core.ServicesMonitor.checkKeywordSearchServerConnectionStatus ( )

private

Performs keyword search service availability status check.

Definition at line 261 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.DOWN, org.sleuthkit.autopsy.core.UserPreferences.getIndexingServerHost(), org.sleuthkit.autopsy.core.UserPreferences.getIndexingServerPort(), org.sleuthkit.autopsy.core.ServicesMonitor.Service.REMOTE_KEYWORD_SEARCH, org.sleuthkit.autopsy.core.ServicesMonitor.setServiceStatus(), org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.tryConnect(), and org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.UP.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkServiceStatus().

void org.sleuthkit.autopsy.core.ServicesMonitor.checkMessagingServerConnectionStatus ( )

private

Performs messaging service availability status check.

Definition at line 286 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.DOWN, org.sleuthkit.autopsy.core.UserPreferences.getMessageServiceConnectionInfo(), org.sleuthkit.autopsy.core.ServicesMonitor.Service.MESSAGING, org.sleuthkit.autopsy.core.ServicesMonitor.setServiceStatus(), org.sleuthkit.autopsy.events.MessageServiceConnectionInfo.tryConnect(), and org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.UP.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkServiceStatus().

void org.sleuthkit.autopsy.core.ServicesMonitor.checkServiceStatus ( String service )

private

Performs service availability status check.

Parameters

service Name of the service.

Definition at line 228 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.checkDatabaseConnectionStatus(), org.sleuthkit.autopsy.core.ServicesMonitor.checkKeywordSearchServerConnectionStatus(), org.sleuthkit.autopsy.core.ServicesMonitor.checkMessagingServerConnectionStatus(), org.sleuthkit.autopsy.core.ServicesMonitor.Service.MESSAGING, org.sleuthkit.autopsy.core.ServicesMonitor.Service.REMOTE_CASE_DATABASE, and org.sleuthkit.autopsy.core.ServicesMonitor.Service.REMOTE_KEYWORD_SEARCH.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkAllServices(), and org.sleuthkit.autopsy.core.ServicesMonitor.getServiceStatus().

static synchronized ServicesMonitor org.sleuthkit.autopsy.core.ServicesMonitor.getInstance ( )

static

Definition at line 126 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.instance, and org.sleuthkit.autopsy.core.ServicesMonitor.ServicesMonitor().

String org.sleuthkit.autopsy.core.ServicesMonitor.getServiceStatus ( String service ) throws ServicesMonitorException

Get last status update for a service.

Parameters

service Name of the service.

Returns: ServiceStatus Status for the service.

Exceptions

ServicesMonitorException If service name is null or service doesn't exist.

Definition at line 203 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.checkServiceStatus().

Referenced by org.sleuthkit.autopsy.ingest.IngestManager.startIngestJob().

void org.sleuthkit.autopsy.core.ServicesMonitor.removeSubscriber	(	Set< String >	eventNames,
		PropertyChangeListener	subscriber
	)

Removes an event subscriber from this publisher.

Parameters

eventNames	The events the subscriber is no longer interested in.
subscriber	The subscriber to remove.

Definition at line 342 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.removeSubscriber().

void org.sleuthkit.autopsy.core.ServicesMonitor.removeSubscriber	(	String	eventName,
		PropertyChangeListener	subscriber
	)

Removes an event subscriber from this publisher.

Parameters

eventName	The event the subscriber is no longer interested in.
subscriber	The subscriber to remove.

Definition at line 352 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.removeSubscriber().

void org.sleuthkit.autopsy.core.ServicesMonitor.removeSubscriber ( PropertyChangeListener subscriber )

Removes an event subscriber to this publisher. Subscriber will be removed from all event notifications from this publisher.

Parameters

subscriber The subscriber to remove.

Definition at line 362 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.removeSubscriber().

void org.sleuthkit.autopsy.core.ServicesMonitor.setServiceStatus	(	String	service,
		String	status,
		String	details
	)

Updates service status and publishes the service status update if it is different from previous status. Event is published locally. Logs status changes.

Parameters

service	Name of the service.
status	Updated status for the service.
details	Details of the event.

Definition at line 159 of file ServicesMonitor.java.

References org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.DOWN, org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), org.sleuthkit.autopsy.core.ServicesMonitor.Service.getDisplayName(), org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.info(), org.sleuthkit.autopsy.events.AutopsyEventPublisher.publishLocally(), and org.sleuthkit.autopsy.core.ServicesMonitor.ServiceStatus.UP.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.checkDatabaseConnectionStatus(), org.sleuthkit.autopsy.core.ServicesMonitor.checkKeywordSearchServerConnectionStatus(), and org.sleuthkit.autopsy.core.ServicesMonitor.checkMessagingServerConnectionStatus().

Member Data Documentation

final long org.sleuthkit.autopsy.core.ServicesMonitor.CRASH_DETECTION_INTERVAL_MINUTES = 15

staticprivate

Definition at line 57 of file ServicesMonitor.java.

AutopsyEventPublisher org.sleuthkit.autopsy.core.ServicesMonitor.eventPublisher

private

Definition at line 51 of file ServicesMonitor.java.

ServicesMonitor org.sleuthkit.autopsy.core.ServicesMonitor.instance = new ServicesMonitor()

staticprivate

Call constructor on start-up so that the first check of services is done as soon as possible.

Definition at line 73 of file ServicesMonitor.java.

Referenced by org.sleuthkit.autopsy.core.ServicesMonitor.getInstance().

final Logger org.sleuthkit.autopsy.core.ServicesMonitor.logger = Logger.getLogger(ServicesMonitor.class.getName())

staticprivate

Definition at line 52 of file ServicesMonitor.java.

final int org.sleuthkit.autopsy.core.ServicesMonitor.NUMBER_OF_PERIODIC_TASK_THREADS = 1

staticprivate

Definition at line 56 of file ServicesMonitor.java.

final String org.sleuthkit.autopsy.core.ServicesMonitor.PERIODIC_TASK_THREAD_NAME = "services-monitor-periodic-task-%d"

staticprivate

Definition at line 55 of file ServicesMonitor.java.

final ScheduledThreadPoolExecutor org.sleuthkit.autopsy.core.ServicesMonitor.periodicTasksExecutor

private

Definition at line 53 of file ServicesMonitor.java.

final Set<String> org.sleuthkit.autopsy.core.ServicesMonitor.servicesList

staticprivate

Initial value:

= Stream.of(ServicesMonitor.Service.values())
            .map(Service::toString)
            .collect(Collectors.toSet())

Definition at line 59 of file ServicesMonitor.java.

final ConcurrentHashMap<String, String> org.sleuthkit.autopsy.core.ServicesMonitor.statusByService

private

The service monitor maintains a mapping of each service to it's last status update.

Definition at line 67 of file ServicesMonitor.java.

The documentation for this class was generated from the following file:

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/core/ServicesMonitor.java

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation