Repository: incubator-ignite Updated Branches: refs/heads/ignite-45 77cfef619 -> 385114dfb
http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2bf5da74/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletContextListenerStartup.java ---------------------------------------------------------------------- diff --git a/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletContextListenerStartup.java b/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletContextListenerStartup.java new file mode 100644 index 0000000..ed3c78f --- /dev/null +++ b/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletContextListenerStartup.java @@ -0,0 +1,181 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.startup.servlet; + +import org.apache.ignite.*; +import org.apache.ignite.configuration.*; +import org.apache.ignite.internal.*; +import org.apache.ignite.internal.processors.resource.*; +import org.apache.ignite.internal.util.typedef.*; +import org.apache.ignite.internal.util.typedef.internal.*; +import org.apache.ignite.lang.*; + +import javax.servlet.*; +import java.net.*; +import java.util.*; + +/** + * This class defines Ignite startup based on servlet context listener. + * This startup can be used to start Ignite inside any web container. + * <p> + * This startup must be defined in {@code web.xml} file. + * <pre name="code" class="xml"> + * <listener> + * <listener-class>org.apache.ignite.startup.servlet.IgniteServletContextListenerStartup</listener-class> + * </listener> + * + * <context-param> + * <param-name>IgniteConfigurationFilePath</param-name> + * <param-value>config/default-config.xml</param-value> + * </context-param> + * </pre> + * <p> + * Servlet context listener based startup may be used in any web container like Tomcat, Jetty and etc. + * Depending on the way this startup is deployed the Ignite instance can be accessed + * by either all web applications or by only one. See web container class loading architecture: + * <ul> + * <li><a target=_blank href="http://tomcat.apache.org/tomcat-7.0-doc/class-loader-howto.html";>http://tomcat.apache.org/tomcat-7.0-doc/class-loader-howto.html</a></li> + * <li><a target=_blank href="http://docs.codehaus.org/display/JETTY/Classloading";>http://docs.codehaus.org/display/JETTY/Classloading</a></li> + * </ul> + * <p> + * <h2 class="header">Tomcat</h2> + * There are two ways to start Ignite on Tomcat. + * <ul> + * <li>Ignite started when web container starts and Ignite instance is accessible only to all web applications. + * <ol> + * <li>Add Ignite libraries in Tomcat common loader. + * Add in file {@code $TOMCAT_HOME/conf/catalina.properties} for property {@code common.loader} + * the following {@code $IGNITE_HOME/*.jar,$IGNITE_HOME/libs/*.jar} + * (replace {@code $IGNITE_HOME} with absolute path). + * </li> + * <li>Configure this startup in {@code $TOMCAT_HOME/conf/web.xml} + * <pre name="code" class="xml"> + * <listener> + * <listener-class>org.apache.ignite.startup.servlet.IgniteServletContextListenerStartup</listener-class> + * </listener> + * + * <context-param> + * <param-name>IgniteConfigurationFilePath</param-name> + * <param-value>config/default-config.xml</param-value> + * </context-param> + * </pre> + * </li> + * </ol> + * </li> + * <li> + * Ignite started from WAR-file and Ignite instance is accessible only to that web application. + * Difference with approach described above is that {@code web.xml} file and all libraries should + * be added in WAR file without changes in Tomcat configuration files. + * </li> + * </ul> + */ +public class ServletContextListenerStartup implements ServletContextListener { + /** Configuration file path parameter name. */ + public static final String IGNITE_CFG_FILE_PATH_PARAM = "IgniteConfigurationFilePath"; + + /** Names of started grids. */ + private final Collection<String> gridNames = new ArrayList<>(); + + /** {@inheritDoc} */ + @Override public void contextInitialized(ServletContextEvent evt) { + ServletContext ctx = evt.getServletContext(); + + String cfgFile = ctx.getInitParameter(IGNITE_CFG_FILE_PATH_PARAM); + + Collection<IgniteConfiguration> cfgs; + GridSpringResourceContext rsrcCtx = null; + + if (cfgFile != null) { + URL cfgUrl = null; + + try { + cfgUrl = evt.getServletContext().getResource("/META-INF/" + cfgFile); + } + catch (MalformedURLException ignored) { + // Ignore, we still need to try with IGNITE_HOME. + } + + if (cfgUrl == null) + // Try with IGNITE_HOME and with context class loader. + cfgUrl = U.resolveIgniteUrl(cfgFile); + + if (cfgUrl == null) + throw new IgniteException("Failed to find Spring configuration file (path provided should be " + + "either absolute, relative to IGNITE_HOME, or relative to META-INF folder): " + cfgFile); + + IgniteBiTuple<Collection<IgniteConfiguration>, ? extends GridSpringResourceContext> t; + + try { + t = IgnitionEx.loadConfigurations(cfgUrl); + } + catch (IgniteCheckedException e) { + throw new IgniteException("Failed to load Ignite configuration.", e); + } + + cfgs = t.get1(); + rsrcCtx = t.get2(); + + if (cfgs.isEmpty()) + throw new IgniteException("Can't find grid factory configuration in: " + cfgUrl); + } + else + cfgs = Collections.<IgniteConfiguration>singleton(new IgniteConfiguration()); + + try { + assert !cfgs.isEmpty(); + + for (IgniteConfiguration cfg : cfgs) { + assert cfg != null; + + Ignite ignite; + + synchronized (ServletContextListenerStartup.class) { + try { + ignite = G.ignite(cfg.getGridName()); + } + catch (IgniteIllegalStateException ignored) { + ignite = IgnitionEx.start(new IgniteConfiguration(cfg), rsrcCtx); + } + } + + // Check if grid is not null - started properly. + if (ignite != null) + gridNames.add(ignite.name()); + } + } + catch (IgniteCheckedException e) { + // Stop started grids only. + for (String name : gridNames) + G.stop(name, true); + + throw new IgniteException("Failed to start Ignite.", e); + } + } + + /** {@inheritDoc} */ + @Override public void contextDestroyed(ServletContextEvent evt) { + // Stop started grids only. + for (String name: gridNames) + G.stop(name, true); + } + + /** {@inheritDoc} */ + @Override public String toString() { + return S.toString(ServletContextListenerStartup.class, this); + } +} http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/2bf5da74/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletStartup.java ---------------------------------------------------------------------- diff --git a/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletStartup.java b/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletStartup.java new file mode 100644 index 0000000..34f1669 --- /dev/null +++ b/modules/web/src/main/java/org/apache/ignite/startup/servlet/ServletStartup.java @@ -0,0 +1,187 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.startup.servlet; + +import org.apache.ignite.*; +import org.apache.ignite.configuration.*; +import org.apache.ignite.internal.*; +import org.apache.ignite.internal.processors.resource.*; +import org.apache.ignite.internal.util.typedef.*; +import org.apache.ignite.internal.util.typedef.internal.*; +import org.apache.ignite.lang.*; + +import javax.servlet.*; +import javax.servlet.http.*; +import java.net.*; +import java.util.*; + +/** + * This class defines servlet-based Ignite startup. This startup can be used to start Ignite + * inside any web container as servlet. + * <p> + * This startup must be defined in {@code web.xml} file. + * <pre name="code" class="xml"> + * <servlet> + * <servlet-name>Ignite</servlet-name> + * <servlet-class>org.apache.ignite.startup.servlet.ServletStartup</servlet-class> + * <init-param> + * <param-name>cfgFilePath</param-name> + * <param-value>config/default-config.xml</param-value> + * </init-param> + * <load-on-startup>1</load-on-startup> + * </servlet> + * </pre> + * <p> + * Servlet-based startup may be used in any web container like Tomcat, Jetty and etc. + * Depending on the way this startup is deployed the Ignite instance can be accessed + * by either all web applications or by only one. See web container class loading architecture: + * <ul> + * <li><a target=_blank href="http://tomcat.apache.org/tomcat-7.0-doc/class-loader-howto.html";>http://tomcat.apache.org/tomcat-7.0-doc/class-loader-howto.html</a></li> + * <li><a target=_blank href="http://docs.codehaus.org/display/JETTY/Classloading";>http://docs.codehaus.org/display/JETTY/Classloading</a></li> + * </ul> + * <p> + * <h2 class="header">Tomcat</h2> + * There are two ways to start Ignite on Tomcat. + * <ul> + * <li>Ignite started when web container starts and Ignite instance is accessible only to all web applications. + * <ol> + * <li>Add Ignite libraries in Tomcat common loader. + * Add in file {@code $TOMCAT_HOME/conf/catalina.properties} for property {@code shared.loader} + * the following {@code $IGNITE_HOME/ignite.jar,$IGNITE_HOME/libs/*.jar} + * (replace {@code $IGNITE_HOME} with absolute path). + * </li> + * <li>Configure startup in {@code $TOMCAT_HOME/conf/web.xml} + * <pre name="code" class="xml"> + * <servlet> + * <servlet-name>Ignite</servlet-name> + * <servlet-class>org.apache.ignite.startup.servlet.ServletStartup</servlet-class> + * <init-param> + * <param-name>cfgFilePath</param-name> + * <param-value>config/default-config.xml</param-value> + * </init-param> + * <load-on-startup>1</load-on-startup> + * </servlet> + * </pre> + * </li> + * </ol> + * </li> + * <li> + * Ignite started from WAR-file and Ignite instance is accessible only to that web application. + * Difference with approach described above is that {@code web.xml} file and all libraries should + * be added in WAR file without changes in Tomcat configuration files. + * </li> + * </ul> + * <p> + * <h2 class="header">Jetty</h2> + * Below is Java code example with Jetty API: + * <pre name="code" class="java"> + * Server service = new Server(); + * + * service.addListener("localhost:8090"); + * + * ServletHttpContext ctx = (ServletHttpContext)service.getContext("/"); + * + * ServletHolder servlet = ctx.addServlet("Ignite", "/IgniteStartup", + * "org.apache.ignite.startup.servlet.ServletStartup"); + * + * servlet.setInitParameter("cfgFilePath", "config/default-config.xml"); + * + * servlet.setInitOrder(1); + * + * servlet.start(); + * + * service.start(); + * </pre> + */ +public class ServletStartup extends HttpServlet { + /** */ + private static final long serialVersionUID = 0L; + + /** Grid loaded flag. */ + private static boolean loaded; + + /** Configuration file path variable name. */ + private static final String cfgFilePathParam = "cfgFilePath"; + + /** */ + private Collection<String> gridNames = new ArrayList<>(); + + /** {@inheritDoc} */ + @SuppressWarnings({"unchecked"}) + @Override public void init() throws ServletException { + // Avoid multiple servlet instances. Ignite should be loaded once. + if (loaded) + return; + + String cfgFile = getServletConfig().getInitParameter(cfgFilePathParam); + + if (cfgFile == null) + throw new ServletException("Failed to read property: " + cfgFilePathParam); + + URL cfgUrl = U.resolveIgniteUrl(cfgFile); + + if (cfgUrl == null) + throw new ServletException("Failed to find Spring configuration file (path provided should be " + + "either absolute, relative to IGNITE_HOME, or relative to META-INF folder): " + cfgFile); + + try { + IgniteBiTuple<Collection<IgniteConfiguration>, ? extends GridSpringResourceContext> t = + IgnitionEx.loadConfigurations(cfgUrl); + + Collection<IgniteConfiguration> cfgs = t.get1(); + + if (cfgs == null) + throw new ServletException("Failed to find a single grid factory configuration in: " + cfgUrl); + + for (IgniteConfiguration cfg : cfgs) { + assert cfg != null; + + IgniteConfiguration adapter = new IgniteConfiguration(cfg); + + Ignite ignite = IgnitionEx.start(adapter, t.get2()); + + // Test if grid is not null - started properly. + if (ignite != null) + gridNames.add(ignite.name()); + } + } + catch (IgniteCheckedException e) { + // Stop started grids only. + for (String name: gridNames) + G.stop(name, true); + + throw new ServletException("Failed to start Ignite.", e); + } + + loaded = true; + } + + /** {@inheritDoc} */ + @Override public void destroy() { + // Stop started grids only. + for (String name: gridNames) + G.stop(name, true); + + loaded = false; + } + + /** {@inheritDoc} */ + @Override public String toString() { + return S.toString(ServletStartup.class, this); + } +}
