IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.deployment
Interface ObjectGridDeployment


public interface ObjectGridDeployment

A component of the DeploymentPolicy that defines how an ObjectGrid should be placed across the set of available containers. Each ObjectGridDeployment must have an underlying ObjectGridConfiguration object. The ObjectGridConfiguration is necessary for dividing the ObjectGrid's maps into MapSets.

Since:
WAS XD 6.1 FIX3

Method Summary
 void addMapSet(MapSet mapSet)
          Add a MapSet to this ObjectGridDeployment.
 MapSet getMapSet(String mapSetName)
          Get a MapSet that has been added to this ObjectGridDeployment
 Collection getMapSets()
          Get a Collection of MapSets that have been added to this ObjectGridDeployment
 ObjectGridConfiguration getObjectGridConfiguration()
          Get the ObjectGridConfiguration object that will be used to configure the ObjectGrid as it deployed to the containers.
 String getObjectGridName()
          Get the name of the ObjectGrid represented by this ObjectGridDeployment.
 MapSet removeMapSet(String mapSetName)
          Remove a MapSet from this ObjectGridDeployment.
 

Method Detail

getObjectGridConfiguration

ObjectGridConfiguration getObjectGridConfiguration()
Get the ObjectGridConfiguration object that will be used to configure the ObjectGrid as it deployed to the containers. This ObjectGridConfiguration object contains the BackingMapConfiguration objects that are eligible for inclusion in this ObjectGridDeployment's MapSets.

Returns:
the ObjectGridConfiguration object

getObjectGridName

String getObjectGridName()
Get the name of the ObjectGrid represented by this ObjectGridDeployment.

This is the name of the underlying ObjectGridConfiguration object.

Returns:
the ObjectGrid name

addMapSet

void addMapSet(MapSet mapSet)
Add a MapSet to this ObjectGridDeployment. Each ObjectGridDeployment must have one or more MapSets. The MapSet must not be null.

Parameters:
mapSet - the MapSet to add to this ObjectGridDeployment

getMapSet

MapSet getMapSet(String mapSetName)
Get a MapSet that has been added to this ObjectGridDeployment

Parameters:
mapSetName - - the name of the MapSet to retrieve
Returns:
the MapSet with the mapSetName specified

getMapSets

Collection getMapSets()
Get a Collection of MapSets that have been added to this ObjectGridDeployment

Returns:
a Collection of MapSet objects

removeMapSet

MapSet removeMapSet(String mapSetName)
Remove a MapSet from this ObjectGridDeployment.

Parameters:
mapSetName - the name of the MapSet to remove
Returns:
the MapSet that was removed or null if no MapSet was found with a name that matches the mapSetName.

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.