com.ibm.websphere.objectgrid
Interface ClientClusterContext

public interface ClientClusterContext

This interface is a context to represent which cluster/domain the client connected to using one of the ObjectGridManager.connect methods. An instance of this interface is used to retrieve client ObjectGrid instances and for performing admin operations against an ObjectGrid cluster/domain or its servers.

Since:

WAS XD 6.0.1, XC10

See Also:

ObjectGridManager

Method Summary

ClientProperties	getClientProperties(String objectGridName) Retrieve the ClientProperties object for this ClientClusterContext for the specified ObjectGrid name.
String	getClusterName() Gets the name of the domain to which the client is connected
void	setClientProperties(String objectGridName, URL url) Sets the ClientProperties properties for the selected ObjectGrid using the specified client properies file.

Method Detail

getClusterName

String getClusterName()

Gets the name of the domain to which the client is connected

Returns:

the name of the domain this context is connected to

getClientProperties

ClientProperties getClientProperties(String objectGridName)

Retrieve the ClientProperties object for this ClientClusterContext for the specified ObjectGrid name. A ClientProperties is scoped to this ClientClusterContext and a single ObjectGrid.

Parameters:

objectGridName - the name of ObjectGrid

Returns:

the ClientProperties instance for this ObjectGrid.

Since:

WAS XD 6.1.0.3

setClientProperties

void setClientProperties(String objectGridName,
                         URL url)

Sets the ClientProperties properties for the selected ObjectGrid using the specified client properies file.

To further adjust the client properties, call the getClientProperties(String) method.

Parameters:

objectGridName - the name of ObjectGrid to apply the ClientProperties to.

url - the URL where the client properties file can be located.

Since:

WAS XD 6.1.0.3