KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > remoting > detection > AbstractDetectorMBean


1 /***************************************
2  * *
3  * JBoss: The OpenSource J2EE WebOS *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  ***************************************/

9 package org.jboss.remoting.detection;
10
11 import org.w3c.dom.Element JavaDoc;
12
13 /**
14  * This provides a MBean accessible interface for setting domain configuration
15  *
16  * @author <a HREF="mailto:telrod@e2technologies.net">Tom Elrod</a>
17  */

18 public interface AbstractDetectorMBean
19 {
20    /**
21     * set the configuration for the domains to be recognized by detector
22     *
23     * @param xml
24     * @jmx.managed-attribute description="Domains is an xml element indicating domains to be recognized by detector"
25     * access="read-write"
26     */

27    public void setConfiguration(Element JavaDoc xml) throws Exception JavaDoc;
28
29    /**
30     * The <code>getDomains</code> method
31     *
32     * @return an <code>Element</code> value
33     * @jmx.managed-attribute
34     */

35    public Element JavaDoc getConfiguration();
36
37    /**
38     * The amount of time to wait between sending (and sometimes receiving) detection messages.
39     *
40     * @param heartbeatTimeDelay
41     * @throws IllegalArgumentException
42     */

43    void setHeartbeatTimeDelay(long heartbeatTimeDelay);
44
45    /**
46     * The amount of time to wait between sending (and sometimes receiving) detection messages.
47     *
48     * @return
49     */

50    long getHeartbeatTimeDelay();
51
52    /**
53     * The amount of time which can elapse without receiving a detection event before a server
54     * will be suspected as being dead and peroforming an explicit invocation on it to verify it is alive.
55     *
56     * @param defaultTimeDelay time in milliseconds
57     * @throws IllegalArgumentException
58     */

59    void setDefaultTimeDelay(long defaultTimeDelay) throws IllegalArgumentException JavaDoc;
60
61    /**
62     * @return The amount of time which can elapse without receiving a detection event before a server
63     * will be suspected as being dead and peroforming an explicit invocation on it to verify it is alive.
64     */

65    long getDefaultTimeDelay();
66 }
67
Popular Tags