users@jersey.java.net

Re: [Jersey] Grizzly-in-process-based deployments

From: Paul Sandoz <Paul.Sandoz_at_Sun.COM>
Date: Wed, 28 Oct 2009 08:01:40 +0100

On Oct 27, 2009, at 10:37 PM, Jeanfrancois Arcand wrote:

> Salut,
>
> Raist wrote:
>> Hi all,
>> I have little problem, and i can't find a solution.
>> I need to add new root resources to instance of Grizzly server
>> (without restart). Is this possible?
>
> Can you cut&paste how you embed/start Grizzly? Technically it should
> be doable as it just consist of adding a new instance of
> ServletAdapter. But do you need to keep the previously "deployed"
> root resources alive?
>

Jersey has a ContainerNotifier and ContainerListener that can perform
reload. At the end of the email are two unit tests that use the low-
level and servlet Grizzly support using Jersey's ContainerNotifier and
ContainerListener. Hopefully that should give a good indication on how
to use it.

A reload will cause Jersey to destroy all previous state and then
reload. Any singletons you have configured will have their @PreDestroy
method called. No client connections will be lost and requests being
served when a reload occurs will use the previous state.

It is currently not possible to dynamically add/remove root resource
and provider classes without a complete reload.

Paul.

/*
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common
Development
  * and Distribution License("CDDL") (collectively, the "License"). You
  * may not use this file except in compliance with the License. You
can obtain
  * a copy of the License at https://jersey.dev.java.net/CDDL+GPL.html
  * or jersey/legal/LICENSE.txt. See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice
in each
  * file and include the License file at jersey/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath"
exception
  * as provided by Sun in the GPL Version 2 section of the License
file that
  * accompanied this code. If applicable, add the following below the
License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [year]
  * [name of copyright owner]"
  *
  * Contributor(s):
  *
  * If you wish your version of this file to be governed by only the
CDDL or
  * only the GPL Version 2, indicate your decision by adding
"[Contributor]
  * elects to include this software in this distribution under the
[CDDL or GPL
  * Version 2] license." If you don't indicate a single choice of
license, a
  * recipient has the option to distribute your version of this file
under
  * either the CDDL, the GPL Version 2 or to extend the choice of
license to
  * its licensees as provided above. However, if you add GPL Version
2 code
  * and therefore, elected the GPL Version 2 license, then the option
applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */

package com.sun.jersey.impl.container.grizzly;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import javax.ws.rs.Path;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.core.DefaultResourceConfig;
import com.sun.jersey.api.core.ResourceConfig;
import com.sun.jersey.spi.container.ContainerListener;
import com.sun.jersey.spi.container.ContainerNotifier;
import java.util.ArrayList;
import java.util.List;
import javax.ws.rs.GET;
import junit.framework.*;

/**
  *
  * @author Paul.Sandoz_at_Sun.Com
  */
public class ReloadTest extends AbstractGrizzlyServerTester {
     @Path("/one")
     public static class One {
         @GET
         public String get() {
             return "one";
         }
     }

     @Path("/two")
     public static class Two {
         @GET
         public String get() {
             return "two";
         }
     }

     private static class Reloader implements ContainerNotifier {
         List<ContainerListener> ls;

         public Reloader() {
             ls = new ArrayList<ContainerListener>();
         }

         public void addListener(ContainerListener l) {
             ls.add(l);
         }

         public void reload() {
             for (ContainerListener l : ls) {
                 l.onReload();
             }
         }
     }

     public ReloadTest(String testName) {
         super(testName);
     }

     public void testReload() {
         ResourceConfig rc = new DefaultResourceConfig(One.class);
         Reloader cr = new Reloader();
          
rc.getProperties().put(ResourceConfig.PROPERTY_CONTAINER_NOTIFIER, cr);
         startServer(rc);

         assertEquals(1, cr.ls.size());

         WebResource r =
Client.create().resource(getUri().path("/").build());

         assertEquals("one", r.path("one").get(String.class));
         assertEquals(404,
r.path("two").get(ClientResponse.class).getStatus());

         rc.getClasses().add(Two.class);
         cr.reload();

         assertEquals("one", r.path("one").get(String.class));
         assertEquals("two", r.path("two").get(String.class));
     }
}


/*
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common
Development
  * and Distribution License("CDDL") (collectively, the "License"). You
  * may not use this file except in compliance with the License. You
can obtain
  * a copy of the License at https://jersey.dev.java.net/CDDL+GPL.html
  * or jersey/legal/LICENSE.txt. See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice
in each
  * file and include the License file at jersey/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath"
exception
  * as provided by Sun in the GPL Version 2 section of the License
file that
  * accompanied this code. If applicable, add the following below the
License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [year]
  * [name of copyright owner]"
  *
  * Contributor(s):
  *
  * If you wish your version of this file to be governed by only the
CDDL or
  * only the GPL Version 2, indicate your decision by adding
"[Contributor]
  * elects to include this software in this distribution under the
[CDDL or GPL
  * Version 2] license." If you don't indicate a single choice of
license, a
  * recipient has the option to distribute your version of this file
under
  * either the CDDL, the GPL Version 2 or to extend the choice of
license to
  * its licensees as provided above. However, if you add GPL Version
2 code
  * and therefore, elected the GPL Version 2 license, then the option
applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */

package com.sun.jersey.impl.container.grizzly.web;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import javax.ws.rs.Path;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.core.ResourceConfig;
import com.sun.jersey.spi.container.ContainerListener;
import com.sun.jersey.spi.container.ContainerNotifier;
import com.sun.jersey.spi.container.WebApplication;
import com.sun.jersey.spi.container.servlet.ServletContainer;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.GET;

/**
  *
  * @author Paul.Sandoz_at_Sun.Com
  */
public class ReloadTest extends AbstractGrizzlyWebContainerTester {
     @Path("/one")
     public static class One {
         @GET
         public String get() {
             return "one";
         }
     }

     @Path("/two")
     public static class Two {
         @GET
         public String get() {
             return "two";
         }
     }

     private static class Reloader implements ContainerNotifier {
         List<ContainerListener> ls;

         public Reloader() {
             ls = new ArrayList<ContainerListener>();
         }

         public void addListener(ContainerListener l) {
             ls.add(l);
         }

         public void reload() {
             for (ContainerListener l : ls) {
                 l.onReload();
             }
         }
     }

     public static class ReloadServletContainer extends
ServletContainer {
         ResourceConfig rc;
         Reloader cr;
         int i = 0;

         @Override
         public void service(HttpServletRequest req,
HttpServletResponse resp)
         throws ServletException, IOException {
             i++;
             super.service(req, resp);

             if (i == 2) {
                 rc.getClasses().add(Two.class);
                 cr.reload();
             }
         }

         @Override
         protected void configure(final ServletConfig sc,
ResourceConfig rc, WebApplication wa) {
             super.configure(sc, rc, wa);
             this.rc = rc;

             cr = new Reloader();
              
rc.getProperties().put(ResourceConfig.PROPERTY_CONTAINER_NOTIFIER, cr);
         }
     }

     public ReloadTest(String testName) {
         super(testName);
     }


     public void testReload() {
         setServletClass(ReloadServletContainer.class);
         startServer(One.class);

         WebResource r =
Client.create().resource(getUri().path("/").build());

         assertEquals("one", r.path("one").get(String.class));
         assertEquals(404,
r.path("two").get(ClientResponse.class).getStatus());

         assertEquals("one", r.path("one").get(String.class));
         assertEquals("two", r.path("two").get(String.class));
     }
}