IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.deployment
Interface DeploymentPolicy


public interface DeploymentPolicy

Defines a policy for use by the ObjectGrid Placement Service to place partitions across the set of available containers.

Since:
WAS XD 6.1 FIX3

Method Summary
 void addObjectGridDeployment(ObjectGridDeployment objectGridDeployment)
          Add an ObjectGridDeployment to this DeploymentPolicy.
 ObjectGridDeployment getObjectGridDeployment(String objectGridName)
          Get an ObjectGridDeployment that has been added to this DeploymentPolicy.
 Collection getObjectGridDeployments()
          Get the Collection of ObjectGridDeployment objects that have been added to this DeploymentPolicy.
 ObjectGridDeployment removeObjectGridDeployment(String objectGridName)
          Remove an ObjectGridDeployment object from this DeploymentPolicy.
 

Method Detail

addObjectGridDeployment

void addObjectGridDeployment(ObjectGridDeployment objectGridDeployment)
Add an ObjectGridDeployment to this DeploymentPolicy.

Parameters:
objectGridDeployment - - the ObjectGridDeployment to add to this DeploymentPolicy. Must not be null.

getObjectGridDeployment

ObjectGridDeployment getObjectGridDeployment(String objectGridName)
Get an ObjectGridDeployment that has been added to this DeploymentPolicy. Null is returned if no ObjectGridDeployment is found with a name that matches the objectGridName.

The objectGridName is the name of the ObjectGridDeployment's underlying ObjectGridConfiguration object.

Parameters:
objectGridName - the name of the ObjectGridDeployment to retrieve.
Returns:
the ObjectGridDeployment object that contains an ObjectGridConfiguration with a name that matches the objectGridName.
See Also:
ObjectGridConfiguration

getObjectGridDeployments

Collection getObjectGridDeployments()
Get the Collection of ObjectGridDeployment objects that have been added to this DeploymentPolicy.

Returns:
a Collection of ObjectGridDeployment objects

removeObjectGridDeployment

ObjectGridDeployment removeObjectGridDeployment(String objectGridName)
Remove an ObjectGridDeployment object from this DeploymentPolicy.

Parameters:
objectGridName - the name of the ObjectGridDeployment to remove
Returns:
the ObjectGridDeployment that was removed. Null is returned if no ObjectGridDeployment was found with a matching objectGridName.

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

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