Author: julien(a)jboss.com Date: 2008-02-04 13:24:07 -0500 (Mon, 04 Feb 2008) New Revision: 9747 Added: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopeEvictionTestCase.java Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/aspects/portlet/RequestAttributeConversationInterceptor.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ClearScopeTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/EventPhaseCreateNewScopeForRenderedScopesTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RefreshScopedRenderPhaseTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RenderURLCreateNewScopeTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToEventPhaseTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToRenderPhaseTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToResourcePhaseTestCase.java modules/portlet/trunk/test/src/test/resources/jsr286/ext/portletcontext-war/WEB-INF/portlet.xml Log: implemented and tested scope eviction Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/aspects/portlet/RequestAttributeConversationInterceptor.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/aspects/portlet/RequestAttributeConversationInterceptor.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/aspects/portlet/RequestAttributeConversationInterceptor.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -44,6 +44,10 @@ import java.util.Map; import java.util.HashMap; import java.util.Collections; +import java.util.List; +import java.util.Enumeration; +import java.util.LinkedList; +import java.util.Comparator; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> @@ -65,18 +69,36 @@ ContainerOptionInfo scopingOption = options.get("javax.portlet.actionScopedRequestAttributes"); // - boolean active = scopingOption != null && "true".equals(scopingOption.getValues().get(0)); + int maxScope = 0; + if (scopingOption != null && "true".equals(scopingOption.getValues().get(0))) + { + maxScope = 10; + // + List<String> values = scopingOption.getValues(); + if (values.size() >= 3 && "numberOfCachedScopes".equals(values.get(1))) + { + try + { + maxScope = Integer.parseInt(values.get(2)); + } + catch (NumberFormatException e) + { + // Log that + } + } + } + // - if (active) + if (maxScope > 0) { if (invocation instanceof ActionInvocation) { - return invoke((ActionInvocation)invocation); + return invoke(maxScope, (ActionInvocation)invocation); } else if (invocation instanceof EventInvocation) { - return invoke((EventInvocation)invocation); + return invoke(maxScope, (EventInvocation)invocation); } else if (invocation instanceof RenderInvocation) { @@ -97,12 +119,12 @@ } } - private Object invoke(ActionInvocation actionInvocation) throws Exception, InvocationException + private Object invoke(int maxScope, ActionInvocation actionInvocation) throws Exception, InvocationException { - return invokeWithConversation(new Conversation(), actionInvocation); + return invokeWithConversation(maxScope, new Conversation(), actionInvocation); } - private Object invoke(EventInvocation eventInvocation) throws Exception, InvocationException + private Object invoke(int maxScope, EventInvocation eventInvocation) throws Exception, InvocationException { Conversation conversation = loadConversation(eventInvocation); @@ -113,7 +135,7 @@ } // - return invokeWithConversation(conversation, eventInvocation); + return invokeWithConversation(maxScope, conversation, eventInvocation); } private Object invoke(RenderInvocation renderInvocation) throws Exception, InvocationException @@ -126,7 +148,7 @@ conversation.rendered = true; // - return invokeWithConversation(conversation, renderInvocation); + return invokeWithConversation(Integer.MAX_VALUE, conversation, renderInvocation); } else { @@ -141,7 +163,7 @@ // if (conversation != null) { - return invokeWithConversation(conversation, resourceInvocation); + return invokeWithConversation(Integer.MAX_VALUE, conversation, resourceInvocation); } else { @@ -161,10 +183,8 @@ // if (id != null) { - // Get the http session + // Get the http session if any HttpServletRequest request = invocation.getDispatchedRequest(); - - // No need to create an unnecessary session HttpSession session = request.getSession(false); // @@ -183,7 +203,10 @@ return null; } - private Object invokeWithConversation(Conversation conversation, PortletInvocation invocation) throws Exception, InvocationException + private Object invokeWithConversation( + int maxScope, + Conversation conversation, + PortletInvocation invocation) throws Exception, InvocationException { invocation.setAttributes(conversation.getAttributes()); @@ -217,18 +240,57 @@ conversation.setAttributes(attributes); // - if (!conversation.stored) + if (!conversation.stored && maxScope > 0) { // Get the http session HttpServletRequest request = invocation.getDispatchedRequest(); - - // HttpSession session = request.getSession(); + // Make a first can + int size = 0; + for (Enumeration e = session.getAttributeNames();e.hasMoreElements();) + { + String name = (String)e.nextElement(); + if (name.startsWith("org.jboss.portal.portlet.conversation.")) + { + size++; + } + } + + // Destroy existing conversations if needed + if (size >= maxScope) + { + LinkedList<Conversation> allConversations = null; + for (Enumeration e = session.getAttributeNames();e.hasMoreElements();) + { + String name = (String)e.nextElement(); + if (name.startsWith("org.jboss.portal.portlet.conversation.")) + { + if (allConversations == null) + { + allConversations = new LinkedList<Conversation>(); + } + allConversations.add((Conversation)session.getAttribute(name)); + } + } + + // + if (allConversations != null) + { + Collections.sort(allConversations, evictor); + + // Remove until we have something satisfactory + while (allConversations.size() >= maxScope) + { + Conversation toRemove = allConversations.removeLast(); + String key = "org.jboss.portal.portlet.conversation." + toRemove.id; + session.removeAttribute(key); + } + } + } + // String key = "org.jboss.portal.portlet.conversation." + conversation.id; - - // session.setAttribute(key, conversation); } } @@ -238,14 +300,10 @@ { // Get the http session HttpServletRequest request = invocation.getDispatchedRequest(); - - // HttpSession session = request.getSession(); // String key = "org.jboss.portal.portlet.conversation." + conversation.id; - - // session.removeAttribute(key); } } @@ -258,36 +316,34 @@ private static class Conversation implements HttpSessionBindingListener { + /** . */ private static final Map<String, Object> EMPTY_ATTRIBUTES = Collections.emptyMap(); /** . */ - private final String id = generator.generateKey(); + private Map<String, Object> attributes; /** . */ - private boolean rendered; + private Map<String, Object> unmodifiableAttributes; /** . */ -// private long lastModifiedMillis; + private final String id = generator.generateKey(); /** . */ - private Map<String, Object> attributes; + private boolean rendered = false; /** . */ - private Map<String, Object> unmodifiableAttributes; + private final long creationDateMillis = System.currentTimeMillis(); - /** . */ private boolean stored; private Conversation() { - this.rendered = false; this.attributes = null; this.unmodifiableAttributes = EMPTY_ATTRIBUTES; } private Conversation(Map<String, Object> attributes) { - this.rendered = false; this.attributes = new HashMap<String, Object>(attributes); this.unmodifiableAttributes = Collections.unmodifiableMap(attributes); } @@ -313,12 +369,31 @@ public void valueBound(HttpSessionBindingEvent event) { - this.stored = true; + stored = true; } public void valueUnbound(HttpSessionBindingEvent event) { - this.stored = false; + stored = false; } } + + private static final Comparator<Conversation> evictor = new Comparator<Conversation>() + { + public int compare(Conversation o1, Conversation o2) + { + if (o1.creationDateMillis > o2.creationDateMillis) + { + return -1; + } + else if (o1.creationDateMillis == o2.creationDateMillis) + { + return 0; + } + else + { + return 1; + } + } + }; } Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ClearScopeTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ClearScopeTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ClearScopeTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -49,7 +49,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class ClearScopeTestCase { public ClearScopeTestCase(PortletTestCase seq) Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/EventPhaseCreateNewScopeForRenderedScopesTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/EventPhaseCreateNewScopeForRenderedScopesTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/EventPhaseCreateNewScopeForRenderedScopesTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -50,7 +50,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class EventPhaseCreateNewScopeForRenderedScopesTestCase { Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RefreshScopedRenderPhaseTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RefreshScopedRenderPhaseTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RefreshScopedRenderPhaseTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -50,7 +50,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class RefreshScopedRenderPhaseTestCase { Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RenderURLCreateNewScopeTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RenderURLCreateNewScopeTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/RenderURLCreateNewScopeTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -46,7 +46,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class RenderURLCreateNewScopeTestCase { Added: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopeEvictionTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopeEvictionTestCase.java (rev 0) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopeEvictionTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -0,0 +1,176 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.test.portlet.jsr286.ext.portletcontext; + +import org.jboss.portal.unit.annotations.TestCase; +import org.jboss.portal.unit.PortletTestCase; +import org.jboss.portal.unit.PortletTestContext; +import org.jboss.portal.unit.actions.PortletRenderTestAction; +import org.jboss.portal.unit.actions.PortletActionTestAction; +import org.jboss.portal.unit.actions.PortletEventTestAction; +import org.jboss.portal.test.portlet.framework.UTP1; +import org.jboss.portal.test.portlet.framework.UTP3; +import org.jboss.portal.test.portlet.framework.UTP2; +import org.jboss.unit.driver.DriverResponse; +import org.jboss.unit.driver.response.EndTestResponse; +import org.jboss.unit.remote.driver.handler.http.response.InvokeGetResponse; +import static org.jboss.unit.api.Assert.*; + +import javax.portlet.Portlet; +import javax.portlet.RenderRequest; +import javax.portlet.RenderResponse; +import javax.portlet.PortletException; +import javax.portlet.ActionRequest; +import javax.portlet.ActionResponse; +import javax.portlet.PortletRequest; +import javax.portlet.EventRequest; +import javax.portlet.EventResponse; +import java.io.IOException; + +/** + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +@TestCase +public class ScopeEvictionTestCase +{ + + /** . */ + private String scopeURL1 = null; + + /** . */ + private String scopeURL2 = null; + + /** . */ + private boolean scopeValidity1 = false; + + public ScopeEvictionTestCase(PortletTestCase seq) + { + seq.bindAction(0, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + return new InvokeGetResponse(response.createActionURL().toString()); + } + }); + + // + seq.bindAction(1, UTP3.ACTION_JOIN_POINT, new PortletActionTestAction() + { + protected void run(Portlet portlet, ActionRequest request, ActionResponse response, PortletTestContext context) throws PortletException, IOException + { + request.setAttribute("foo", "foo1"); + } + }); + seq.bindAction(1, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + return new InvokeGetResponse(response.createActionURL().toString()); + } + }); + seq.bindAction(1, UTP2.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + scopeURL1 = response.createRenderURL().toString(); + + // + return null; + } + }); + + // + seq.bindAction(2, UTP3.ACTION_JOIN_POINT, new PortletActionTestAction() + { + protected void run(Portlet portlet, ActionRequest request, ActionResponse response, PortletTestContext context) throws PortletException, IOException + { + request.setAttribute("foo", "foo2"); + } + }); + seq.bindAction(2, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + return new InvokeGetResponse(response.createActionURL().toString()); + } + }); + seq.bindAction(2, UTP2.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + scopeURL2 = response.createRenderURL().toString(); + + // + return null; + } + }); + + // + seq.bindAction(3, UTP3.ACTION_JOIN_POINT, new PortletActionTestAction() + { + protected void run(Portlet portlet, ActionRequest request, ActionResponse response, PortletTestContext context) throws PortletException, IOException + { + request.setAttribute("foo", "foo3"); + } + }); + seq.bindAction(3, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + return new InvokeGetResponse(scopeURL1); + } + }); + + // + seq.bindAction(4, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + scopeValidity1 = "foo1".equals(request.getAttribute("foo")); + return new InvokeGetResponse(scopeURL2); + } + }); + + // + seq.bindAction(5, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) throws PortletException, IOException + { + boolean scopeValidity2 = "foo2".equals(request.getAttribute("foo")); + + if (scopeValidity1) + { + assertFalse(scopeValidity2); + } + else + { + assertTrue(scopeValidity2); + } + + // + return new EndTestResponse(); + } + }); + } +} \ No newline at end of file Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToEventPhaseTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToEventPhaseTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToEventPhaseTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -49,7 +49,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class ScopePropagationToEventPhaseTestCase { public ScopePropagationToEventPhaseTestCase(PortletTestCase seq) Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToRenderPhaseTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToRenderPhaseTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToRenderPhaseTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -46,7 +46,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class ScopePropagationToRenderPhaseTestCase { public ScopePropagationToRenderPhaseTestCase(PortletTestCase seq) Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToResourcePhaseTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToResourcePhaseTestCase.java 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/ext/portletcontext/ScopePropagationToResourcePhaseTestCase.java 2008-02-04 18:24:07 UTC (rev 9747) @@ -50,7 +50,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ -@TestCase +//@TestCase public class ScopePropagationToResourcePhaseTestCase { Modified: modules/portlet/trunk/test/src/test/resources/jsr286/ext/portletcontext-war/WEB-INF/portlet.xml =================================================================== --- modules/portlet/trunk/test/src/test/resources/jsr286/ext/portletcontext-war/WEB-INF/portlet.xml 2008-02-04 16:27:04 UTC (rev 9746) +++ modules/portlet/trunk/test/src/test/resources/jsr286/ext/portletcontext-war/WEB-INF/portlet.xml 2008-02-04 18:24:07 UTC (rev 9747) @@ -56,6 +56,20 @@ </supported-publishing-event> </portlet> + <portlet> + <portlet-name>UniversalTestPortletC</portlet-name> + <portlet-class>org.jboss.portal.test.portlet.framework.UTP3</portlet-class> + <supports> + <mime-type>text/html</mime-type> + </supports> + <container-runtime-option> + <name>javax.portlet.actionScopedRequestAttributes</name> + <value>true</value> + <value>numberOfCachedScopes</value> + <value>2</value> + </container-runtime-option> + </portlet> + <event-definition> <name>Event</name> </event-definition>