com.ibm.websphere.objectgrid.client

Class RouteTableValidation

java.lang.Object

com.ibm.websphere.objectgrid.client.RouteTableValidation

public final class RouteTableValidation
extends Object

A utility class that retrieves the route table from the catalog service and validates that each of the partitions is reachable.

Since:

7.1.0.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteTableValidation.Filter

Constructor Summary

Constructors

Constructor and Description
RouteTableValidation()

Method Summary

Methods

Modifier and Type	Method and Description
static String	validateRouteTable(String bootstrap, String objectGridName, RouteTableValidation.Filter filter, ClientSecurityConfiguration securityConfig) Deprecated.
static TabularData	validateRouteTable(String bootstrap, String objectGridName, String mapSetName, RouteTableValidation.Filter filter, ClientSecurityConfiguration securityConfig) Retrieves the route table for objectGridName from bootstrap but only validates the shards that match the filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouteTableValidation

public RouteTableValidation()

Method Detail

validateRouteTable

@Deprecated
public static String validateRouteTable(String bootstrap,
                                   String objectGridName,
                                   RouteTableValidation.Filter filter,
                                   ClientSecurityConfiguration securityConfig)

Deprecated.

Retrieves the route table for objectGridName from bootstrap but only validates the shards that match the filter. Use the reachable attribute below to filter valid or invalid shards.

The format of the XML is as follows:

 <objectGrid name="<objectgrid>" name="<name>">
   <primary zone="<zone>"> partition="<partition>"> state="<reachable>"> ipaddress="<ipaddress>">
     <replica zone="<zone>"> partition="<partition>"> state="<reachable>"> ipaddress="<ipaddress>">
   </primary>
 </objectGrid>
 

Parameters:

bootstrap - The ORB bootstrap address of the catalog service. This may be a single address or compound address (host:port[,host:port]). Must not be null.

objectGridName - The name of the grid to validate the route information for. May not be null.

filter - The filters to apply, null indicates no filtering.

securityConfig - The security properties used to connect to a secure catalog service, null indicates no security.

Returns:

The XML representing the validation output.

validateRouteTable

public static TabularData validateRouteTable(String bootstrap,
                             String objectGridName,
                             String mapSetName,
                             RouteTableValidation.Filter filter,
                             ClientSecurityConfiguration securityConfig)

Retrieves the route table for objectGridName from bootstrap but only validates the shards that match the filter. Use the reachable attribute to filter valid or invalid shards.

The validated route table is returned as TabularData, where each CompositeData (row in the TabularData) contains the following items:

Item Name	Type	Description	Since
State	String	State of shard. States include reachable, unreachable, and invalid	8.5
HostName	String	The host name of the machine where the shard resides	8.5
Domain	String	Domain name of the shard	8.6
ObjectGrid	String	ObjectGrid name of the shard	8.5
MapSet	String	Map set name of the shard	8.5
ZoneName	String	Zone name of the shard	8.5
ShardType	String	The shard type. Types include Primary, SynchronousReplica, and AsynchronousReplica	8.5
Partition	String	Partition name of the shard.	8.5
ContainerName	String	The name of the container where the shard resides	8.6
PlacementScope	String	The Placement Scope of the shard. Placement scopes include Domain and Container.	8.6

Parameters:

bootstrap - The bootstrap address of the catalog service. This may be a single address or compound address (host:port[,host:port]). Must not be null.

objectGridName - The name of the grid to validate the route information for. May not be null.

mapSetName - The name of the map set to validate the route information for. May be null to return all map sets for a grid

filter - The filters to apply, null indicates no filtering.

securityConfig - The security properties used to connect to a secure catalog service, null indicates no security.

Returns:

TabularData The TabularData representing the validation output.

Since:

8.5