com.mgnt.lifecycle.management.backgroundrunner

Interface BackgroundRunnable

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

BaseBackgroundRunnable

public interface BackgroundRunnable
extends java.lang.Runnable

This is the interface that a user periodically executed Task class must implement. This is done when user defined class extends BaseBackgroundRunnable class. Please see the source code in package com.mgnt.lifecycle.management.backgroundrunner.example that demonstrates the usage of this framework

Method Summary

Modifier and Type	Method and Description
TimeInterval	getTaskExecutionInterval()
void	initTimeIntervalParam(java.lang.String valueStr, TimeInterval defaultValue, java.lang.String propertyName) This is internally implemented method (in class BaseBackgroundRunnable) it allows to initialize other properties of type TimeInterval If such properties exist then the user will need to override method setParamValue(TimeInterval, String) so it will know what setter method to invoke based on propertyName parameter.
boolean	isInitialized() internally used method
void	setInitialized(boolean initialized) internally used method
void	setParamValue(TimeInterval value, java.lang.String property) This method is a general setter method for all properties that hold TimeInterval value.

Methods inherited from interface java.lang.Runnable

run

Method Detail

getTaskExecutionInterval

TimeInterval getTaskExecutionInterval()

Returns:

TimeInterval that specifies how often the Task should be run

initTimeIntervalParam

void initTimeIntervalParam(java.lang.String valueStr,
                           TimeInterval defaultValue,
                           java.lang.String propertyName)

This is internally implemented method (in class BaseBackgroundRunnable) it allows to initialize other properties of type TimeInterval If such properties exist then the user will need to override method setParamValue(TimeInterval, String) so it will know what setter method to invoke based on propertyName parameter. See the source code for class com.mgnt.lifecycle.management.backgroundrunner.example.TypeOneTask that demonstrates this feature

Parameters:

valueStr - String that contains a Time interval value such as "9h", "3m", "10s" etc

defaultValue - TimeInterval that holds a default value for the property should parsing of valueStr parameter fails

propertyName - The name of the property to be set

setParamValue

void setParamValue(TimeInterval value,
                   java.lang.String property)

This method is a general setter method for all properties that hold TimeInterval value. It should be implemented by user defined class implementing this interface. See source code for classes TypeOneTask and TypeTwoTask where one provide complex example in which there are other properties besides Task Execution Interval and second that demonstrates a minimalistic implementation

Parameters:

value - TimeInterval value for the property

property - name of the property to be set

isInitialized

boolean isInitialized()

internally used method

Returns:

setInitialized

void setInitialized(boolean initialized)

internally used method

Parameters:

initialized -