org.codice.ddf.spatial.ogc.catalog.common

Class AvailabilityTask

java.lang.Object

org.codice.ddf.spatial.ogc.catalog.common.AvailabilityTask

All Implemented Interfaces:

Runnable

public class AvailabilityTask
extends Object
implements Runnable

Runnable task to cache and update the availability based on the AvailabilityCommand. NOTE: It is ideal to run this on a short interval (1 second) to maintain an accurate status of the availability.

Author:

kcwire

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_DELAY
static int	ONE_SECOND

Constructor Summary

Constructors

Constructor and Description
AvailabilityTask(long interval, AvailabilityCommand command, String id) Default Constructor

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable()
void	run() Determines if the interval has elapsed before executing the AvailabilityCommand.
void	setInterval(long interval) Sets the interval.
void	updateLastAvailableTimestamp(long timestamp) Update the timestamp based on last successful response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_DELAY

public static final int NO_DELAY

See Also:

Constant Field Values

ONE_SECOND

public static final int ONE_SECOND

See Also:

Constant Field Values

Constructor Detail

AvailabilityTask

public AvailabilityTask(long interval,
                        AvailabilityCommand command,
                        String id)

Default Constructor

Parameters:

interval - - in millis

command - - the command to execute

id - - the unique id

Method Detail

run

public void run()

Determines if the interval has elapsed before executing the AvailabilityCommand. It is ideal this task is run on short intervals to check if the interval has elapsed.

Specified by:

run in interface Runnable

isAvailable

public boolean isAvailable()

updateLastAvailableTimestamp

public void updateLastAvailableTimestamp(long timestamp)

Update the timestamp based on last successful response. This timestamp is used to determine if the interval has elapsed.

Parameters:

timestamp - - timestamp in millis

setInterval

public void setInterval(long interval)

Sets the interval. This interval is used to determine if the Command should be executed.

Parameters:

interval - - interval in millis