GridServletLoader (GridGain 2.1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

GridGain™ 2.1.0
Java API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gridgain.grid.loaders.servlet
Class GridServletLoader

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.gridgain.grid.loaders.servlet.GridServletLoader

All Implemented Interfaces:: Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class GridServletLoader
extends javax.servlet.http.HttpServlet
extends javax.servlet.http.HttpServlet

This class defines servlet-based GridGain loader. This loader can be used to start GridGain inside any web container as servlet. Loader must be defined in web.xml file.

 <servlet>
     <servlet-name>GridGain</servlet-name>
     <servlet-class>org.gridgain.grid.loaders.servlet.GridServletLoader</servlet-class>
     <init-param>
         <param-name>cfgFilePath</param-name>
         <param-value>config/default-spring.xml</param-value>
     </init-param>
     <load-on-startup>1</load-on-startup>
 </servlet>

Servlet-based loader may be used in any web container like Tomcat, Jetty and etc. Depending on the way this loader is deployed the GridGain instance can be accessed by either all web applications or by only one. See web container class loading architecture:

There are two ways to start GridGain on Tomcat.

GridGain started when web container starts and GridGain instance is accessible only to all web applications.

Add GridGain libraries in Tomcat common loader. Add in file ${TOMCAT_HOME}/conf/catalina.properties for property common.loader the following ${GRIDGAIN_HOME}/gridgain.jar,${GRIDGAIN_HOME}/libs/*.jar (replace ${GRIDGAIN_HOME} with absolute path).

GridGain servlet-based loader in ${TOMCAT_HOME}/conf/web.xml

          <servlet>
              <servlet-name>GridGain</servlet-name>
              <servlet-class>org.gridgain.grid.loaders.servlet.GridServletLoader</servlet-class>
              <init-param>
                  <param-name>cfgFilePath</param-name>
                  <param-value>config/default-spring.xml</param-value>
              </init-param>
              <load-on-startup>1</load-on-startup>
          </servlet>

GridGain started from WAR-file and GridGain instance is accessible only to that web application. Difference with approach described above is that all libraries should be added in WAR file without changes in Tomcat configuration files.

Below is Java code example with Jetty API:

 Server service = new Server();

 service.addListener("localhost:8090");

 ServletHttpContext ctx = (ServletHttpContext)service.getContext("/");

 ServletHolder servlet = ctx.addServlet("GridGain", "/GridGainLoader",
      "org.gridgain.grid.loaders.servlet.GridServletLoader");

 servlet.setInitParameter("cfgFilePath", "config/default-spring.xml");

 servlet.setInitOrder(1);

 servlet.start();

 service.start();

For more information see Configuring and Starting GridGain

Constructor Summary
`GridServletLoader()`

Method Summary
`void`	`destroy()`
`void`	`init()`
`String`	`toString()`

Methods inherited from class javax.servlet.http.HttpServlet
`doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service`

Methods inherited from class javax.servlet.GenericServlet
`getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`