KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > config > ClusterRefConfig


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/config/ClusterRefConfig.java,v 1.7 2005/12/25 03:49:18 tcfujii Exp $
26  * $Revision: 1.7 $
27  * $Date: 2005/12/25 03:49:18 $
28  */
29
30 package com.sun.appserv.management.config;
31
32
33 import com.sun.appserv.management.base.XTypes;
34 import com.sun.appserv.management.base.Container;
35
36 /**
37  * represents the <server-ref> element.
38  */
39 public interface ClusterRefConfig extends RefConfig, HealthCheckerConfigCR, Container {
40
41     /**
42       The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}.
43      */
44     public static final String JavaDoc J2EE_TYPE = XTypes.CLUSTER_REF_CONFIG;
45
46     /**
47         @since Appserver 9.0
48      */
49     public String JavaDoc getReferencedClusterName();
50     
51     /**
52         @since Appserver 9.0
53      */
54     public void setReferencedClusterName( String JavaDoc clusterName );
55     
56     
57     /**
58       <b>EE only</b>
59         Load balancing policy to be used for this cluster. Possible
60         values are round-robin , weighted-round-robin or
61         user-defined. round-robin is the default. For
62         weighted-round-robin, the weights of the instance are
63         considered while load balancing. For user-defined, the policy
64         is implemented by a shared library which is loaded by the
65         load balancer and the instance selected is delegated to the
66         loaded module.
67         
68       Return load balancing policy to be used for this cluster. Possible
69       values are: See {@link LbPolicyTypeValues}.
70      */
71     public String JavaDoc getLBPolicy();
72
73     /**
74        <b>EE only</b>
75        Set the load balancing policy to be used for this cluster.
76        See {@link com.sun.appserv.management.config.LbPolicyTypeValues}.
77      */
78     public void setLBPolicy(final String JavaDoc value);
79
80     /**
81       <b>EE only</b>
82       Returns the absolute path to the shared library
83       implementing the {@link LbPolicyTypeValues#USER_DEFINED} policy.
84      */
85     public String JavaDoc getLBPolicyModule();
86
87     /**
88       <b>EE only</b>
89       Sets the absolute path to the shared library implementing the
90       {@link LbPolicyTypeValues#USER_DEFINED} policy.
91      */
92     public void setLBPolicyModule(final String JavaDoc lbPolicyModule);
93 }
94
Popular Tags