IBM WebSphere Extended Deployment (XD)TM
Release 6.0

com.ibm.ws.xd.dwlm.client
MultiClusterRoutingPolicy



The multi-cluster routing policy interface. The multi-cluster routing is the ability to route application requests between a local cell and its clusters and remote cells. The remote cell must be represented as a generic server cluster in the local on demand router cell.


Method Summary
public  StringgetApplication()
           Gets the application for which this policy is applicable.
public  StringgetWebModule()
           Gets the web module for which this policy is applicable.
public  booleanisApplicationScope()
           Indicates whether policy scope is the application level. The application.
public  booleanisWebModuleScope()
           Indicates whether policy scope is the web module level. The web module.
public  booleanisCellScope()
           Indicates whether policy scope is the cell level. The cell.
public  booleanpolicyIsFailOver()
           Indicates policy type of fail over.
public  booleanpolicyIsStaticLoadBalance()
           Indicates policy type is for static load balance.
public  booleanpolicyIsDynamicLoadBalance()
           Indicates policy type is for dynamic load balance.
public  StringfailOverPolicy()
           An array of objects containing the fail over policy string. Each element of the.
public  StringloadBalancePolicy()
           An array of objects containing the load balancing policy string. Each element of the.
public  TargetClustergetClusters()
           Gets array of clusters for this policy..
public  booleanisApplicationMatch(java.lang.String)
           Indicates whether the application names match.
public  booleanisWebModuleMatch(java.lang.String)
           Indicates whether the web module names match.
public  booleanequals(java.lang.String, java.lang.String)
           Returns true if object is equal by comparing the name and value objects and false otherwise.
public  StringtoString()
           String representation of the object.

Method Detail

getApplication

public String getApplication()
Gets the application for which this policy is applicable.


Returns:
     String The name of the application.


getWebModule

public String getWebModule()
Gets the web module for which this policy is applicable.


Returns:
     String The name of the web module.


isApplicationScope

public boolean isApplicationScope()
Indicates whether policy scope is the application level. The application for which this applies is indicated by the application name above.


Returns:
     True if the scope is at the application level and false otherwise.


isWebModuleScope

public boolean isWebModuleScope()
Indicates whether policy scope is the web module level. The web module for which this applies is indicated by the web module name above.


Returns:
     True if the scope is at the web module and false otherwise.


isCellScope

public boolean isCellScope()
Indicates whether policy scope is the cell level. The cell for which this applies is indicated in the fail over or load balance objects.


Returns:
     True if the scope is at the cell and false otherwise.


policyIsFailOver

public boolean policyIsFailOver()
Indicates policy type of fail over.


Returns:
     True if policy type is failover.


policyIsStaticLoadBalance

public boolean policyIsStaticLoadBalance()
Indicates policy type is for static load balance.


Returns:
     True if policy type is static load balance.


policyIsDynamicLoadBalance

public boolean policyIsDynamicLoadBalance()
Indicates policy type is for dynamic load balance.


Returns:
     True if policy type is dynamic load balance.


failOverPolicy

public String failOverPolicy()
An array of objects containing the fail over policy string. Each element of the array represents a 2-tuple of cell:cluster. The array must contain at least 2 elements. For example, a fail over policy with one 2-tuple backing the other would be: cell1:cluster1,cell1:GSC1 and so the first element of the array would be cell1:cluster1 and the second, cell1:GSC1.


Returns:
     String array


loadBalancePolicy

public String loadBalancePolicy()
An array of objects containing the load balancing policy string. Each element of the array represents a 2-tuple or 3-tuple of cell:cluster:weight. The array must contain more than one element. For example, to load balance across two cells the policy expression would be: cell1:cluster1:weight1,cell1:GSC1:weight2 and so the first element of the array would be cell1:cluster1:weight1 and the second, cell1:GSC1:weight2. The cluster is optional, and when it is not specified, the second element is null. For example, cell1::weight1,cell1:GSC1:weight2. says load balance application requests between all clusters in cell1 with the remote cell represented by the generic server cluster GSC1.


Returns:
     String array


getClusters

public TargetCluster getClusters()
Gets array of clusters for this policy. These are not created at configuration time, but rather at parent object construction time.


Returns:
     TargetCluster[] These are GSCTargetCluster[] objects.


isApplicationMatch

public boolean isApplicationMatch(String appname)
Indicates whether the application names match.
Parameters:


Returns:
     True if the application name passed in matches what is contained in this policy object.


isWebModuleMatch

public boolean isWebModuleMatch(String webModule)
Indicates whether the web module names match.
Parameters:


Returns:
     True if the web module name passed in matches what is contained in this policy object.


equals

public boolean equals(String name,String value)
Returns true if object is equal by comparing the name and value objects and false otherwise.
Parameters:
    name - Policy name.
    value - Policy expression following syntax above.


Returns:
     True if the object is equal and false otherwise


toString

public String toString()
String representation of the object.


Returns:
     String


IBM WebSphere Extended Deployment (XD)TM
Release 6.0