org.opensaml.util.resource

クラス ResourceChangeWatcher

java.lang.Object

java.util.TimerTask

org.opensaml.util.resource.ResourceChangeWatcher

すべての実装されたインタフェース:

Runnable

public class ResourceChangeWatcher
extends TimerTask

A watcher that invokes a callback when a resource update/deletion has been detected.

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static int	DEFAULT_MAX_RETRY_ATTEMPTS Default maximum retry attempts, 0.
static long	DEFAULT_POLL_FREQUENCY Default polling frequency, 12 hours.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
ResourceChangeWatcher(Resource resource) Constructor.
ResourceChangeWatcher(Resource resource, long pollingFrequency) Constructor.
ResourceChangeWatcher(Resource resource, long pollingFrequency, int retryAttempts) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
long	getPollingFrequency() Gets the frequency, in milliseconds, the watched resource should be polled.
List<ResourceChangeListener>	getResourceListeners() Gets the list of registered resource listeners.
void	run()
protected void	signalListeners(ResourceChangeListener.ResourceChange changeType) Signals all registered listeners of a resource change.

クラスから継承されたメソッド java.util.TimerTask

cancel, scheduledExecutionTime

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

DEFAULT_POLL_FREQUENCY

public static final long DEFAULT_POLL_FREQUENCY

Default polling frequency, 12 hours.

関連項目:

定数フィールド値

DEFAULT_MAX_RETRY_ATTEMPTS

public static final int DEFAULT_MAX_RETRY_ATTEMPTS

Default maximum retry attempts, 0.

関連項目:

定数フィールド値

コンストラクタの詳細

ResourceChangeWatcher

public ResourceChangeWatcher(Resource resource)
                      throws ResourceException

Constructor.

パラメータ:

resource - the resource to be watched

例外:

ResourceException - thrown if resource existence or last modification time can not be determined

ResourceChangeWatcher

public ResourceChangeWatcher(Resource resource,
                     long pollingFrequency)
                      throws ResourceException

Constructor.

パラメータ:

resource - the resource to be watched

pollingFrequency - the frequency, in milliseconds, to poll the resource for changes

例外:

ResourceException - thrown if resource existence or last modification time can not be determined

ResourceChangeWatcher

public ResourceChangeWatcher(Resource resource,
                     long pollingFrequency,
                     int retryAttempts)
                      throws ResourceException

Constructor.

パラメータ:

resource - the resource to be watched

pollingFrequency - the frequency, in milliseconds, to poll the resource for changes

retryAttempts - maximum number of poll attempts before the resource is considered inaccessible

例外:

ResourceException - thrown if resource existence or last modification time can not be determined

メソッドの詳細

getPollingFrequency

public long getPollingFrequency()

Gets the frequency, in milliseconds, the watched resource should be polled.

戻り値:

frequency the watched resource should be polled

getResourceListeners

public List<ResourceChangeListener> getResourceListeners()

Gets the list of registered resource listeners. New listeners may be registered with the list or old ones removed.

戻り値:

list of registered resource listeners

run

public void run()

定義:

run インタフェース内 Runnable

定義:

run クラス内 TimerTask

signalListeners

protected void signalListeners(ResourceChangeListener.ResourceChange changeType)

Signals all registered listeners of a resource change.

パラメータ:

changeType - the resource change type