Class Watchdog

java.lang.Object

org.apache.commons.exec.Watchdog

All Implemented Interfaces:

Runnable

public class Watchdog
extends Object
implements Runnable

Generalization of ExecuteWatchdog.

See Also:

• ExecuteWatchdog

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Watchdog.Builder	Builds ExecuteWatchdog instances.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<TimeoutObserver>	observers	Observers.
private boolean	stopped	Whether this is stopped.
private final ThreadFactory	threadFactory	The thread factory.
private final Duration	timeout	Timeout duration.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Watchdog(long timeoutMillis)	Deprecated. Use Watchdog.Builder.get().
private	Watchdog(Watchdog.Builder builder)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	addTimeoutObserver(TimeoutObserver to)	Adds a TimeoutObserver.
static Watchdog.Builder	builder()	Creates a new builder.
protected final void	fireTimeoutOccured()	Fires a timeout occurred event for each observer.
(package private) ThreadFactory	getThreadFactory()	Gets the thread factory.
Duration	getTimeout()	Gets the timeout.
void	removeTimeoutObserver(TimeoutObserver to)	Removes a TimeoutObserver.
void	run()
void	start()	Starts a new thread.
void	stop()	Requests a thread stop.

Methods inherited from class Object

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

Field Details

observers

private final List<TimeoutObserver> observers

Observers.

timeout

private final Duration timeout

Timeout duration.

stopped

private boolean stopped

Whether this is stopped.

threadFactory

private final ThreadFactory threadFactory

The thread factory.

Constructor Details

Watchdog

private Watchdog(Watchdog.Builder builder)

Constructs a new instance.

Parameters:

threadFactory - the thread factory.

timeout - the timeout duration.

Watchdog

@Deprecated
public Watchdog(long timeoutMillis)

Deprecated.

Use Watchdog.Builder.get().

Constructs a new instance.

Parameters:

timeoutMillis - the timeout duration.

Method Details

builder

public static Watchdog.Builder builder()

Creates a new builder.

Returns:

a new builder.

Since:

1.4.0

addTimeoutObserver

public void addTimeoutObserver(TimeoutObserver to)

Adds a TimeoutObserver.

Parameters:

to - a TimeoutObserver to add.

fireTimeoutOccured

protected final void fireTimeoutOccured()

Fires a timeout occurred event for each observer.

getThreadFactory

ThreadFactory getThreadFactory()

Gets the thread factory.

Returns:

the thread factory.

getTimeout

public Duration getTimeout()

Gets the timeout.

Returns:

the timeout.

Since:

1.6.0

removeTimeoutObserver

public void removeTimeoutObserver(TimeoutObserver to)

Removes a TimeoutObserver.

Parameters:

to - a TimeoutObserver to remove.

run

public void run()

Specified by:

run in interface Runnable

start

public void start()

Starts a new thread.

stop

public void stop()

Requests a thread stop.