com.github.wuic.util

Class PollingScheduler<T>

java.lang.Object

com.github.wuic.util.PollingScheduler<T>

Type Parameters:

T - the type of listener

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AbstractNutDao, ContextBuilderConfigurator

public abstract class PollingScheduler<T>
extends Object
implements Runnable

This class is able to schedule a polling operation in the WuicScheduledThreadPool.

Since:

0.4.0

Version:

1.1

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PollingScheduler.Polling This class represents a polling information.

Constructor Summary

Constructors

Constructor and Description
PollingScheduler() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Long	getLastUpdateTimestampFor(String path) Retrieves a timestamp that indicates the last time this nut has changed.
Map<T,? extends PollingScheduler.Polling>	getNutObservers() Gets polling data with observers.
int	getPollingInterval() Returns the polling interval.
void	observe(String pattern, T... listeners) Adds a set of listeners to be notified when a polling operation is perform on a nut matching the given pattern.
void	setPollingInterval(int intervalSeconds) Defines a new polling interval.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

PollingScheduler

public PollingScheduler()

Creates a new instance.

Method Detail

observe

public final void observe(String pattern,
           T... listeners)
                   throws IOException

Adds a set of listeners to be notified when a polling operation is perform on a nut matching the given pattern.

Parameters:

pattern - the pattern to use to retrieve the different real paths to poll

listeners - some listeners to be notified when an update has been detected on a nut

Throws:

IOException - if an I/O occurs while retrieving last update of the nut

getNutObservers

public Map<T,? extends PollingScheduler.Polling> getNutObservers()

Gets polling data with observers.

Returns:

the observers

getPollingInterval

public final int getPollingInterval()

Returns the polling interval.

Returns:

the polling interval

setPollingInterval

public final void setPollingInterval(int intervalSeconds)

Defines a new polling interval. If current polling operation are currently processed, then they are not interrupted and a new scheduling is created if the given value is a positive number. If the value is not positive, then no polling will occur.

Parameters:

intervalSeconds - interval in seconds

getLastUpdateTimestampFor

protected abstract Long getLastUpdateTimestampFor(String path)
                                           throws IOException

Retrieves a timestamp that indicates the last time this nut has changed.

Parameters:

path - the real path of the nut

Returns:

the timestamp

Throws:

IOException - if any I/O error occurs