KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > ext > lb > LoadBalancer


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23  
24 /*
25  * $Header: /cvs/glassfish/admin-core/mbeanapi/src/java/com/sun/appserv/management/ext/lb/LoadBalancer.java,v 1.6 2005/12/25 03:50:28 tcfujii Exp $
26  * $Revision: 1.6 $
27  * $Date: 2005/12/25 03:50:28 $
28  */

29
30 package com.sun.appserv.management.ext.lb;
31
32 import java.util.Date JavaDoc;
33
34 import static com.sun.appserv.management.base.XTypes.*;
35 import com.sun.appserv.management.base.AMX;
36
37 /**
38    Runtime counterpart for the config MBean {@link com.sun.appserv.management.config.LoadBalancerConfig}
39    representing the load-balancer element.
40  */

41 public interface LoadBalancer extends AMX {
42
43     /** The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}. */
44     public static final String JavaDoc J2EE_TYPE = LOAD_BALANCER;
45
46     /**
47       Applies changes in the corresponding configuration to this LB
48      */

49     public void applyLBChanges();
50
51     /**
52       @return true if there are pending changes for this LB
53      */

54     public boolean isApplyChangeRequired();
55
56     /**
57       Exports the corresponding LBConfig information and returns the contents as a string.
58       @see com.sun.appserv.management.config.LBConfig
59      */

60     public String JavaDoc getLoadBalancerXML();
61       
62     /**
63       Returns the timestamp of the most recent export of corresponding LBConfig
64      */

65     public Date JavaDoc getLastExported();
66     
67     /**
68       Returns the timestamp of the most recent application of corresponding LBConfig
69      */

70     public Date JavaDoc getLastApplied();
71
72     /**
73       Returns the timestamp of the last time the stats on this loadbalancer were reset
74      */

75     public Date JavaDoc getLastResetTime();
76
77     /**
78       Reset the monitoring stats on this loadbalancer.
79      */

80     public void resetStats();
81     
82     /**
83       Reset the monitoring stats on this loadbalancer.
84      */

85     public boolean testConnection();
86             
87     /**
88      * Returns the uhealthy/healthy/quiesced status for an insatnce load balanced
89      * by this load balancer.
90      */

91     public String JavaDoc getStatus(String JavaDoc instanceName);
92 }
93
Popular Tags