KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > module > builders > vwms > VwmProbeInterface


1 /*
2
3 This software is OSI Certified Open Source Software.
4 OSI Certified is a certification mark of the Open Source Initiative.
5
6 The license (Mozilla version 1.0) can be read at the MMBase site.
7 See http://www.MMBase.org/license
8
9 */
10 package org.mmbase.module.builders.vwms;
11
12 import org.mmbase.module.core.*;
13
14 /**
15  * Virtual Web Master Probe interface.
16  * A VWM that runs a scheduler should implement this interface.
17  * The routines defined here are entry routines for the probe, needed to perform scheduled tasks.
18  *
19  * @application VWMs
20  * @deprecated with only one implementation, better to not use an interface?
21  * @author Daniel Ockeloen
22  * @author Pierre van Rooden (javadocs)
23  * @version $Id: VwmProbeInterface.java,v 1.7 2004/10/08 10:57:57 pierre Exp $
24  */
25 public interface VwmProbeInterface {
26
27     /**
28     * Performs general periodic maintenance.
29     * @return <code>true</code> if maintenance was performed, <code>false</code> otherwise
30     */
31     public boolean probeCall();
32
33     /**
34     * Returns the name of the VWM.
35     */
36     public String JavaDoc getName();
37
38     /**
39     * Performs maintenance based on a Vwmtasknode.
40     * @param node The Vwmtask node that describes the task to be performed.
41     * @return <code>true</code> if maintenance was performed, <code>false</code> if it failed
42     */
43     public boolean performTask(MMObjectNode node);
44 }
45
Popular Tags