org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings Class Reference

Static Public Member Functions
static DayOfWeek	getPauseDayOfWeek ()
static int	getPauseDurationMinutes ()
static boolean	getPauseEnabled ()
static int	getPauseStartTimeHour ()
static int	getPauseStartTimeMinute ()
static void	setPauseDayOfWeek (DayOfWeek dayOfWeek)
static void	setPauseDurationMinutes (int durationInMinutes)
static void	setPauseEnabled (boolean enabled)
static void	setPauseStartTimeHour (int hour)
static void	setPauseStartTimeMinute (int timeInMinutes)

Private Member Functions
	ScheduledIngestPauseSettings ()

Static Private Attributes
static final boolean	DEFAULT_ENABLED_VALUE = false
static final int	DEFAULT_PAUSE_DURATION_VALUE = 60
static final int	DEFAULT_TIME_VALUE = 0
static final String	PAUSE_DAY_OF_WEEK_KEY = "IngestPauseDayOfWeek"
static final String	PAUSE_DURATION_MINUTES_KEY = "IngestPauseDurationMinutes"
static final String	PAUSE_ENABLED_KEY = "IngestPauseEnabled"
static final String	PAUSE_TIME_HOUR_KEY = "IngestPauseTimeHour"
static final String	PAUSE_TIME_MINUTES_KEY = "IngestPauseTimeMinutes"
static final Preferences	preferences = NbPreferences.forModule(ScheduledIngestPauseSettings.class)

Detailed Description

Settings that allow ingest jobs in progress to be paused weekly at a specified time for a specified duration. Because ingest job execution is a variable time activity, it is also possible to specify a window after the specified pause time in which the pause should still occur.

THIS IS A BETA CLASS AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 35 of file ScheduledIngestPauseSettings.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.ScheduledIngestPauseSettings ( )

private

Private constructor to prevent utilit bclass instantiation.

Definition at line 184 of file ScheduledIngestPauseSettings.java.

Member Function Documentation

static DayOfWeek org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.getPauseDayOfWeek ( )

static

Gets the day of the week when ingest should pause.

Returns

The day of the week. The default value is Sunday.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 81 of file ScheduledIngestPauseSettings.java.

static int org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.getPauseDurationMinutes ( )

static

Gets the duration of the ingest pause in minutes.

Returns

The duration in minutes. The default value is 60.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 164 of file ScheduledIngestPauseSettings.java.

static boolean org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.getPauseEnabled ( )

static

Gets whether or not a scheduled ingest pause is enabled.

Returns

True or false. The default value is false.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 58 of file ScheduledIngestPauseSettings.java.

static int org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.getPauseStartTimeHour ( )

static

Gets the hour of the time of day when ingest should pause.

Returns

The hour as an integer in the range of 0-23. The default value is zero.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 107 of file ScheduledIngestPauseSettings.java.

static int org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.getPauseStartTimeMinute ( )

static

Gets the minutes of the time of day when ingest should pause.

Returns

The minutes of the time of day as an integer in the range of 0-59. The default value is zero.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 136 of file ScheduledIngestPauseSettings.java.

static void org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.setPauseDayOfWeek ( DayOfWeek  dayOfWeek )

static

Sets the day of the week when ingest should pause.

Parameters

dayOfWeek

The day of the week as an integer in the range 1-7.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 94 of file ScheduledIngestPauseSettings.java.

static void org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.setPauseDurationMinutes ( int  durationInMinutes )

static

Sets the duration of the ingest pause in minutes.

Parameters

durationInMinutes

The duration in minutes.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 176 of file ScheduledIngestPauseSettings.java.

static void org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.setPauseEnabled ( boolean  enabled )

static

Sets whether or not a scheduled ingest pause is enabled.

Parameters

enabled

True or false.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 69 of file ScheduledIngestPauseSettings.java.

static void org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.setPauseStartTimeHour ( int  hour )

static

Sets the hour of the time of day when ingest should pause.

Parameters

hour	The hour of the time of day as an integer in the range of 0-23.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 120 of file ScheduledIngestPauseSettings.java.

static void org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.setPauseStartTimeMinute ( int  timeInMinutes )

static

Sets the minutes of the time of day when ingest should pause.

Parameters

timeInMinutes

The minutes of the time of day as an integer in the range of 0-59.

THIS IS A BETA METHOD AND IS SUBJECT TO CHANGE OR DELETION.

Definition at line 149 of file ScheduledIngestPauseSettings.java.

Member Data Documentation

final boolean org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.DEFAULT_ENABLED_VALUE = false

staticprivate

Definition at line 43 of file ScheduledIngestPauseSettings.java.

final int org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.DEFAULT_PAUSE_DURATION_VALUE = 60

staticprivate

Definition at line 49 of file ScheduledIngestPauseSettings.java.

final int org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.DEFAULT_TIME_VALUE = 0

staticprivate

Definition at line 48 of file ScheduledIngestPauseSettings.java.

final String org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.PAUSE_DAY_OF_WEEK_KEY = "IngestPauseDayOfWeek"

staticprivate

Definition at line 44 of file ScheduledIngestPauseSettings.java.

final String org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.PAUSE_DURATION_MINUTES_KEY = "IngestPauseDurationMinutes"

staticprivate

Definition at line 47 of file ScheduledIngestPauseSettings.java.

final String org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.PAUSE_ENABLED_KEY = "IngestPauseEnabled"

staticprivate

Definition at line 42 of file ScheduledIngestPauseSettings.java.

final String org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.PAUSE_TIME_HOUR_KEY = "IngestPauseTimeHour"

staticprivate

Definition at line 45 of file ScheduledIngestPauseSettings.java.

final String org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.PAUSE_TIME_MINUTES_KEY = "IngestPauseTimeMinutes"

staticprivate

Definition at line 46 of file ScheduledIngestPauseSettings.java.

final Preferences org.sleuthkit.autopsy.ingest.ScheduledIngestPauseSettings.preferences = NbPreferences.forModule(ScheduledIngestPauseSettings.class)

staticprivate

Definition at line 41 of file ScheduledIngestPauseSettings.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/ingest/ScheduledIngestPauseSettings.java