1 /*
2 * Copyright (C) The Apache Software Foundation. All rights reserved.
3 *
4 * This software is published under the terms of the Apache Software License
5 * version 1.1, a copy of which has been included with this distribution in
6 * the LICENSE file.
7 */
8 package org.apache.james.util.watchdog;
9
10 /***
11 * This interface represents an abstract watchdog process that serves to
12 * monitor a situation and triggers an action under an implementation-specific
13 * trigger condition.
14 *
15 * @author Andrei Ivanov
16 * @author Peter M. Goldstein <farsight@alum.mit.edu>
17 */
18 public interface Watchdog {
19
20 /***
21 * Start this Watchdog, causing it to begin monitoring. The Watchdog can
22 * be stopped and restarted.
23 */
24 void start();
25
26 /***
27 * Reset this Watchdog. Resets any conditions in the implementations
28 * (time to expiration, etc.) to their original values
29 */
30 void reset();
31
32 /***
33 * Stop this Watchdog, terminating the monitoring condition. The monitor
34 * can be restarted with a call to startWatchdog.
35 */
36 void stop();
37 }
This page was automatically generated by Maven