IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.spring
Class ObjectGridClientBean

java.lang.Object
  extended by com.ibm.websphere.objectgrid.spring.ObjectGridClientBean
All Implemented Interfaces:
InitializingBean

public final class ObjectGridClientBean
extends Object
implements InitializingBean

This class is a Spring bean representing an ObjectGrid client instance for use with the WebSphere eXtreme Scale implementation of Spring's cache abstraction.

Users must provide a ObjectGridCatalogServiceDomainBean to configure this client. The ObjectGrid name is optional when using the provided XML configuration files.

Since:
8.5, XC10

Constructor Summary
ObjectGridClientBean()
           
 
Method Summary
 void afterPropertiesSet()
          Initializes the client bean.
 void setCatalogServiceDomain(ObjectGridCatalogServiceDomainBean catalogServiceDomain)
          Sets the ObjectGridCatalogServiceDomainBean used by the client.
 void setObjectGridName(String objectGridName)
          Sets the name of the ObjectGrid for the client.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ObjectGridClientBean

public ObjectGridClientBean()
Method Detail

setObjectGridName

public void setObjectGridName(String objectGridName)
Sets the name of the ObjectGrid for the client. This is optional when using the provided XML configuration files.

Parameters:
objectGridName - The name of the ObjectGrid to connect to.

setCatalogServiceDomain

public void setCatalogServiceDomain(ObjectGridCatalogServiceDomainBean catalogServiceDomain)
Sets the ObjectGridCatalogServiceDomainBean used by the client.

Parameters:
catalogServiceDomain - The ObjectGridCatalogServiceDomainBean for the client.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception
Initializes the client bean. This method is to be called after all setter methods have been called and will throw an IllegalArgumentException if setCatalogServiceDomain(ObjectGridCatalogServiceDomainBean) has not been called prior.

Specified by:
afterPropertiesSet in interface InitializingBean
Throws:
Exception - if setCatalogServiceDomain(ObjectGridCatalogServiceDomainBean) has not been called prior or an error occurs retrieving the ObjectGrid.
See Also:
InitializingBean.afterPropertiesSet()

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

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