Author: julien(a)jboss.com Date: 2008-01-17 17:42:31 -0500 (Thu, 17 Jan 2008) New Revision: 9530 Added: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/ modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/ modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/web.xml Removed: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/RequestParameters.java Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/PortletParameterMap.java modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletRequestImpl.java modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java modules/portlet/trunk/test/src/test/build.xml modules/portlet/trunk/test/src/test/resources/test/remote-jboss-unit.xml Log: an initial test case for public render parameter Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/PortletParameterMap.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/PortletParameterMap.java 2008-01-17 22:32:44 UTC (rev 9529) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/PortletParameterMap.java 2008-01-17 22:42:31 UTC (rev 9530) @@ -212,7 +212,12 @@ public Map<String, String[]> getPrivateMapSnapshot() { - Map<String, String[]> snapshot = getMapSnapshot(PortletParameter.Scope.PRIVATE); + return getMapSnapshot(PortletParameter.Scope.PRIVATE); + } + + public Map<String, String[]> getPublicMapSnapshot() + { + Map<String, String[]> snapshot = getMapSnapshot(PortletParameter.Scope.PUBLIC); for (String removal : publicEntryRemovals) { snapshot.put(removal, EMPTY_STRINGS); @@ -220,11 +225,6 @@ return snapshot; } - public Map<String, String[]> getPublicMapSnapshot() - { - return getMapSnapshot(PortletParameter.Scope.PUBLIC); - } - private Map<String, String[]> getMapSnapshot(PortletParameter.Scope scope) { Map<String, String[]> snapshot = new HashMap<String, String[]>(); Deleted: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/RequestParameters.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/RequestParameters.java 2008-01-17 22:32:44 UTC (rev 9529) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/RequestParameters.java 2008-01-17 22:42:31 UTC (rev 9530) @@ -1,196 +0,0 @@ -/****************************************************************************** - * 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.portlet.impl.jsr168; - -import org.jboss.portal.common.util.ParameterMap; -import org.jboss.portal.portlet.spi.PortletInvocationContext; -import org.jboss.portal.portlet.spi.ActionContext; -import org.jboss.portal.portlet.StateString; -import org.jboss.portal.portlet.ParametersStateString; - -/** - * The main responsibility of this class is to combine the different parameter sources (private navigational state, - * public navigational state, interaction state, form) into the private map, public map and parameter map. - * - * @author <a href="mailto:julien@jboss.org">Julien Viet</a> - * @version $Revision: 630 $ - */ -public class RequestParameters -{ - - /** . */ - protected final ParameterMap parameters; - - /** . */ - protected final ParameterMap privateParameters; - - /** . */ - protected final ParameterMap publicParameters; - - public RequestParameters(PortletInvocationContext context) - { - if (context instanceof ActionContext) - { - ActionContext actionContext = (ActionContext)context; - - // Get the possibly null interaction state - StateString interactionState = actionContext.getInteractionState(); - - // Take care of the interaction state if any - ParameterMap privateParameters = null; - - // - if (interactionState != null) - { - // Unserialize the interaction state if necessary - ParametersStateString parametersState; - if (interactionState instanceof ParametersStateString) - { - parametersState = (ParametersStateString)interactionState; - } - else - { - parametersState = new ParametersStateString(interactionState.getStringValue()); - } - - // - privateParameters = parametersState.getParameters(); - } - - // - ParameterMap form = actionContext.getForm(); - if (form != null) - { - if (privateParameters == null) - { - privateParameters = form; - } - else - { - privateParameters = ParameterMap.clone(privateParameters); - privateParameters.append(form); - } - } - - // - ParameterMap publicParameters = actionContext.getPublicNavigationalState(); - - // - ParameterMap parameters; - if (publicParameters != null) - { - if (privateParameters != null) - { - ParameterMap tmp = ParameterMap.clone(privateParameters); - tmp.append(publicParameters); - parameters = tmp; - } - else - { - parameters = publicParameters; - } - } - else - { - if (privateParameters != null) - { - parameters = privateParameters; - } - else - { - parameters = null; - } - } - - // - this.privateParameters = privateParameters; - this.publicParameters = publicParameters; - this.parameters = parameters; - } - else - { - // Get the possibly null navigational state - StateString navigationalState = context.getNavigationalState(); - - // - ParameterMap privateParameters; - if (navigationalState == null) - { - privateParameters = null; - } - else - { - privateParameters = ParametersStateString.create(navigationalState).getParameters(); - } - - // - ParameterMap publicParameters = context.getPublicNavigationalState(); - - // Build combined map - ParameterMap parameters; - if (publicParameters != null) - { - if (privateParameters != null) - { - parameters = ParameterMap.clone(privateParameters); - parameters.putAll(publicParameters); - } - else - { - parameters = publicParameters; - } - } - else - { - if (privateParameters != null) - { - parameters = privateParameters; - } - else - { - parameters = null; - } - } - - // - this.privateParameters = privateParameters; - this.publicParameters = publicParameters; - this.parameters = parameters; - } - } - - public ParameterMap getParameters() - { - return parameters; - } - - public ParameterMap getPrivateParameters() - { - return privateParameters; - } - - public ParameterMap getPublicParameters() - { - return publicParameters; - } -} Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletRequestImpl.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletRequestImpl.java 2008-01-17 22:32:44 UTC (rev 9529) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletRequestImpl.java 2008-01-17 22:42:31 UTC (rev 9530) @@ -103,20 +103,22 @@ PreferencesValidator validator = container.getPreferencesValidator(); ContainerPortletInfo info = container.getInfo(); ContainerPreferencesInfo containerPrefs = info.getPreferences(); + ContainerNavigationInfo navigationInfo = info.getNavigation(); + UserContext userContext = invocation.getUserContext(); // this.invocation = invocation; - this.requestParameterMap = new PortletRequestParameterMap(navigationInfo, invocation.getPortletContext()); - this.userContext = invocation.getUserContext(); + this.userContext = userContext; this.securityContext = invocation.getSecurityContext(); this.requestContext = invocation.getRequestContext(); this.windowContext = invocation.getWindowContext(); this.container = container; this.dreq = invocation.getDispatchedRequest(); this.portalContext = new PortalContextImpl(invocation.getPortalContext()); - this.attributes = new PortletRequestAttributes(this.container, userContext); + this.attributes = new PortletRequestAttributes(container, userContext); this.preferences = new PortletPreferencesImpl(prefs, containerPrefs, validator, mode); - this.navigationInfo = info.getNavigation(); + this.navigationInfo = navigationInfo; + this.requestParameterMap = new PortletRequestParameterMap(navigationInfo, invocation.getPortletContext()); } // PLT.11.1.1 Added: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java (rev 0) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java 2008-01-17 22:42:31 UTC (rev 9530) @@ -0,0 +1,134 @@ +/****************************************************************************** + * 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.tck.portletrequests; + +import org.jboss.portal.unit.annotations.TestCase; +import org.jboss.portal.unit.Assertion; +import org.jboss.portal.unit.PortletTestCase; +import org.jboss.portal.unit.PortletTestContext; +import org.jboss.portal.unit.base.AbstractUniversalTestPortlet; +import org.jboss.portal.unit.actions.PortletRenderTestAction; +import org.jboss.portal.unit.actions.PortletActionTestAction; +import org.jboss.portal.test.portlet.framework.UTP9; +import org.jboss.portal.test.portlet.framework.UTP1; +import org.jboss.portal.test.portlet.framework.UTP2; +import org.jboss.portal.common.util.Tools; +import static org.jboss.unit.api.Assert.*; +import org.jboss.unit.driver.DriverResponse; +import org.jboss.unit.driver.response.EndTestResponse; +import org.jboss.unit.remote.driver.handler.http.response.InvokeGetResponse; + +import javax.portlet.RenderRequest; +import javax.portlet.RenderResponse; +import javax.portlet.Portlet; +import javax.portlet.PortletConfig; +import javax.portlet.ActionRequest; +import javax.portlet.ActionResponse; +import javax.portlet.PortletException; +import javax.portlet.PortletURL; +import java.util.Enumeration; +import java.util.Locale; +import java.util.List; +import java.util.HashSet; +import java.io.IOException; + +/** + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +(a)TestCase({Assertion.JSR168_1000}) +public class PublicRenderParameterTestCase +{ + + /** . */ + int renderCount = 0; + + public PublicRenderParameterTestCase(PortletTestCase seq) + { + seq.bindAction(0, UTP1.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + return new InvokeGetResponse(response.createActionURL().toString()); + } + }); + seq.bindAction(1, UTP1.ACTION_JOIN_POINT, new PortletActionTestAction() + { + protected void run(Portlet portlet, ActionRequest request, ActionResponse response, PortletTestContext context) throws PortletException, IOException + { + response.setRenderParameter("foo", "foo"); + } + }); + seq.bindAction(1, UTP1.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + String foo = request.getParameter("foo"); + assertEquals("foo", foo); + renderCount++; + PortletURL url = response.createActionURL(); + url.setParameter("foo", "bar"); + return new InvokeGetResponse(url.toString()); + } + }); + seq.bindAction(1, UTP2.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + String foo = request.getParameter("foo"); + assertEquals("foo", foo); + renderCount++; + return null; + } + }); + seq.bindAction(2, UTP1.ACTION_JOIN_POINT, new PortletActionTestAction() + { + protected void run(Portlet portlet, ActionRequest request, ActionResponse response, PortletTestContext context) throws PortletException, IOException + { + assertEquals(2, renderCount); + assertEquals(new String[]{"bar","foo"}, request.getParameterMap().get("foo")); + response.removePublicRenderParameter("foo"); + renderCount = 0; + } + }); + seq.bindAction(2, UTP1.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + String foo = request.getParameter("foo"); + assertEquals(null, foo); + return ++renderCount == 2 ? new EndTestResponse() : null; + } + }); + seq.bindAction(2, UTP2.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + String foo = request.getParameter("foo"); + assertEquals(null, foo); + renderCount++; + return ++renderCount == 2 ? new EndTestResponse() : null; + } + }); + } +} \ No newline at end of file Modified: modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java =================================================================== --- modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java 2008-01-17 22:32:44 UTC (rev 9529) +++ modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java 2008-01-17 22:42:31 UTC (rev 9530) @@ -502,23 +502,32 @@ portalNS.setWindowNavigationalState(portletId, windowNS); // Now update shared state scoped at page -// Map<String, String[]> publicNS = update.getPublicNavigationalStateUpdates(); -// if (publicNS != null) -// { -// NavigationInfo navigationInfo = portlet.getInfo().getNavigation(); -// for (Map.Entry<String, String[]> entry : publicNS.entrySet()) -// { -// String id = entry.getKey(); -// ParameterInfo parameterInfo = navigationInfo.getPublicParameter(id); -// -// // -// if (parameterInfo != null) -// { -// QName name = parameterInfo.getName(); -// portalNS.getPageNavigationalState().put(name, entry.getValue()); -// } -// } -// } + Map<String, String[]> publicNS = update.getPublicNavigationalStateUpdates(); + if (publicNS != null) + { + NavigationInfo navigationInfo = portlet.getInfo().getNavigation(); + Map<QName, String[]> pageNS = portalNS.getPageNavigationalState(); + for (Map.Entry<String, String[]> entry : publicNS.entrySet()) + { + String id = entry.getKey(); + ParameterInfo parameterInfo = navigationInfo.getPublicParameter(id); + + // + if (parameterInfo != null) + { + QName name = parameterInfo.getName(); + String[] value = entry.getValue(); + if (value.length > 0) + { + pageNS.put(name, value); + } + else + { + pageNS.remove(name); + } + } + } + } } static class Action Modified: modules/portlet/trunk/test/src/test/build.xml =================================================================== --- modules/portlet/trunk/test/src/test/build.xml 2008-01-17 22:32:44 UTC (rev 9529) +++ modules/portlet/trunk/test/src/test/build.xml 2008-01-17 22:42:31 UTC (rev 9530) @@ -229,6 +229,7 @@ <package-jsr286-tck-test test="event"/> <package-jsr286-tck-test test="eventnonamespace"/> <package-jsr286-tck-test test="stateawareresponse"/> + <package-jsr286-tck-test test="portletrequests"/> <package-jsr286-api-test test="event"/> Added: modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml =================================================================== --- modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml (rev 0) +++ modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml 2008-01-17 22:42:31 UTC (rev 9530) @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ 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. ~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--> + +<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2... http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" + version="2.0"> + + <portlet> + <portlet-name>UniversalTestPortletA</portlet-name> + <portlet-class>org.jboss.portal.test.portlet.framework.UTP1</portlet-class> + <supports> + <mime-type>text/html</mime-type> + </supports> + <supported-public-render-parameter>foo</supported-public-render-parameter> + </portlet> + + <portlet> + <portlet-name>UniversalTestPortletB</portlet-name> + <portlet-class>org.jboss.portal.test.portlet.framework.UTP2</portlet-class> + <supports> + <mime-type>text/html</mime-type> + </supports> + <supported-public-render-parameter>foo</supported-public-render-parameter> + </portlet> + + <public-render-parameter> + <identifier>foo</identifier> + <name>Foo</name> + </public-render-parameter> + +</portlet-app> Added: modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/web.xml =================================================================== --- modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/web.xml (rev 0) +++ modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/web.xml 2008-01-17 22:42:31 UTC (rev 9530) @@ -0,0 +1,32 @@ +<?xml version="1.0"?> +<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ 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. ~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--> + +<!DOCTYPE web-app PUBLIC + "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" + "http://java.sun.com/dtd/web-app_2_3.dtd"> +<web-app> + <listener> + <listener-class>org.jboss.portal.unit.PortletTestSuite</listener-class> + </listener> +</web-app> Modified: modules/portlet/trunk/test/src/test/resources/test/remote-jboss-unit.xml =================================================================== --- modules/portlet/trunk/test/src/test/resources/test/remote-jboss-unit.xml 2008-01-17 22:32:44 UTC (rev 9529) +++ modules/portlet/trunk/test/src/test/resources/test/remote-jboss-unit.xml 2008-01-17 22:42:31 UTC (rev 9530) @@ -167,6 +167,10 @@ <class name="org.jboss.unit.remote.driver.RemoteTestDriverClient"/> <property name="archiveId" value="test-jsr286-tck-stateawareresponse.war"/> </generic> + <generic> + <class name="org.jboss.unit.remote.driver.RemoteTestDriverClient"/> + <property name="archiveId" value="test-jsr286-tck-portletrequests.war"/> + </generic> <!--Spec API Assertions tests--> <generic>