WebSphere Extended Deployment, Version 6.0.x
             Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, z/OS


Starting an ObjectGrid server in an application server

You can configure an ObjectGrid server to start within an application server. WebSphere Application Server detects the ObjectGrid component and automatically starts the ObjectGrid server.

Before you begin

You can configure ObjectGrid servers in WebSphere Application Server Version 6.0.2 and later, including when add-ons such as WebSphere Extended Deployment or WebSphere Business Integration Server are installed. Earlier versions of WebSphere Application Server, such as WebSphere Application Server Version 5.0.2, can have applications that use the ObjectGrid as clients, but the ObjectGrid server function cannot be collocated with the earlier application server versions.

If you are using cluster configurations that enable replication, the high availability manager is required. ObjectGrid servers use the high availability manager differently than normal application servers. When the ObjectGrid server is in an application server, the ObjectGrid server does not configure, initialize or create the high availability manager service, but uses the existing high availability service in the application server. For replication between ObjectGrid servers, the ObjectGrid servers must be running in application servers that are members of the same core group.

All other functions of the ObjectGrid server are the same when the server runs in WebSphere Application Server. If your ObjectGrid cluster specification includes three servers, any three application servers in a single core group can host these ObjectGrid servers. The application servers can also span clusters, as long as the clusters belong to the same core group. The most important step is to correlate the server TCP/IP host name and port information in the cluster.xml file.

About this task

Use this task to run ObjectGrid servers within the application servers in your WebSphere Application Server environment.

Procedure

  1. Add the required custom properties on the Java virtual machine (JVM). In the administrative console, click Servers > Application servers > server_name > Java and Process Management > Process Definition > Java Virtual Machine > Custom Properties. Click New. Create the following custom properties:
    Table 1. JVM custom properties for ObjectGrid servers
    Custom property name Description Example value
    objectgrid.server.name
    Specifies the ObjectGrid server name to use within this application server. The name that is provided must be one of the server names that is defined in the ObjectGrid cluster XML file.

    For more information about the cluster XML file, see the "Distributed ObjectGrid configuration" topic in the ObjectGrid programming guide.

    server1
    objectgrid.xml.url
    Specifies the Universal Resource Locator (URL) for the ObjectGrid XML file. This property is required.

    For more information about the cluster XML file, see the "Distributed ObjectGrid configuration" topic in the ObjectGrid programming guide.

    file:///d:/was/etc/test/
    objectGridMatch.xml
    objectgrid.cluster.xml.url
    Specifies the URL for the ObjectGrid cluster XML file. This property is required.

    For more information about the cluster XML file, see the "Distributed ObjectGrid configuration" topic in the ObjectGrid programming guide.

    file:///d:/was/etc/test/
    csCluster0.xml
    objectgrid.security.
    server.props
    Specifies the URL for the ObjectGrid server security properties file. This property is required only if security is enabled in the ObjectGrid cluster xml file. To determine if security is enabled in your cluster XML file, look for the following text:
    <cluster name="cluster1"
     securityEnabled="true"
    ....
    If the securityEnabled attribute is set to false, you do not need to define this property.

    Use the security.ogserver.props file as a template. See the security section in the ObjectGrid programming guide for the meaning of these properties in this file and how they can be used.

    file:///d:/was/
    optionalLibraries/
    ObjectGrid/properties/
    security.ogserver.props 
    You can also define these JVM properties in the Generic JVM Arguments field on the Java Virtual Machine panel in the administrative console. The following example shows a value for the Generic JVM Arguments field:
    -Dobjectgrid.server.name=server1 
    -Dobjectgrid.xml.url=file:///<INSTALL_ROOT>\optionalLibraries\ObjectGrid\
    META-INF\cluster-objectgrid-definition.xml 
    -Dobjectgrid.cluster.xml.url=file:///<INSTALL_ROOT>\optionalLibraries\
    ObjectGrid\META-INF\cluster-config-1.xml 
  2. Save the changes and restart the application server. WebSphere Application Server detects the ObjectGrid component and automatically starts the ObjectGrid server.

    The ObjectGrid in the application server uses the channel framework to interact with ObjectGrid clients, specifically called the client access port. When the ObjectGrid server is started, it detects collocation with WebSphere Application Server and uses the channel framework that is already running in the application server. The ObjectGrid server creates and starts its own channel framework only if a channel framework is not created or started in the application server.

  3. Stop the ObjectGrid server. Stop the ObjectGrid server by stopping the associated application server. You cannot stop the ObjectGrid server by using the ObjectGrid system management commands.

Results

The application servers in your WebSphere Application Server environment are running ObjectGrid servers.



Related tasks
Loading and running the ObjectGrid sample application with WebSphere Extended Deployment
Task topic    

Terms of Use | Feedback

Last updated: Nov 30, 2007 4:06:03 PM EST
http://publib.boulder.ibm.com/infocenter/wxdinfo/v6r0/index.jsp?topic=/com.ibm.websphere.xd.doc/info/objectgrid/tobgstartobgserver.html