Author: julien_viet Date: 2010-09-16 12:22:29 -0400 (Thu, 16 Sep 2010) New Revision: 4228 Added: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ControllerURL.java Removed: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ResourceURL.java Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/application/RequestContext.java portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouteDescriptor.java portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouterDescriptor.java portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/LocatorProvider.java portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalRequestContext.java portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalURLBuilder.java portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/url/PortalURL.java portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/application/ExoPortletInvocationContext.java portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/workspace/UIPortalApplication.java portal/branches/navcontroller/webui/portlet/src/main/java/org/exoplatform/webui/application/portlet/PortletRequestContext.java Log: - rename ResourceURL to ControllerURL - a bit of javadoc Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/application/RequestContext.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/application/RequestContext.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/application/RequestContext.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -20,10 +20,10 @@ package org.exoplatform.web.application; import org.exoplatform.services.resources.Orientation; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.web.url.LocatorProvider; import org.exoplatform.web.url.ResourceLocator; import org.exoplatform.web.url.ResourceType; -import org.exoplatform.web.url.ResourceURL; import java.io.Writer; import java.util.HashMap; @@ -86,11 +86,11 @@ */ public abstract LocatorProvider getLocatorProvider(); - public abstract <R, L extends ResourceLocator<R>> ResourceURL<R, L> newURL(ResourceType<R, L> resourceType, L locator); + public abstract <R, L extends ResourceLocator<R>> ControllerURL<R, L> newURL(ResourceType<R, L> resourceType, L locator); - public final <R, L extends ResourceLocator<R>> ResourceURL<R, L> createURL(ResourceType<R, L> resourceType, R resource) + public final <R, L extends ResourceLocator<R>> ControllerURL<R, L> createURL(ResourceType<R, L> resourceType, R resource) { - ResourceURL<R, L> url = createURL(resourceType); + ControllerURL<R, L> url = createURL(resourceType); // Set the resource on the URL url.setResource(resource); @@ -99,7 +99,7 @@ return url; } - public final <R, L extends ResourceLocator<R>> ResourceURL<R, L> createURL(ResourceType<R, L> resourceType) + public final <R, L extends ResourceLocator<R>> ControllerURL<R, L> createURL(ResourceType<R, L> resourceType) { // Get the provider LocatorProvider provider = getLocatorProvider(); Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouteDescriptor.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouteDescriptor.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouteDescriptor.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -27,6 +27,8 @@ import java.util.Map; /** + * Describes a route. + * * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> * @version $Revision$ */ Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouterDescriptor.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouterDescriptor.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/metadata/RouterDescriptor.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -23,6 +23,8 @@ import java.util.List; /** + * Describe a router. + * * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> * @version $Revision$ */ Copied: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ControllerURL.java (from rev 4221, portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ResourceURL.java) =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ControllerURL.java (rev 0) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ControllerURL.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -0,0 +1,214 @@ +/* + * Copyright (C) 2010 eXo Platform SAS. + * + * 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.exoplatform.web.url; + +import org.gatein.common.util.ParameterMap; + +import java.util.Map; + +/** + * An URL for a resource managed by the controller. + * + * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> + * @version $Revision$ + */ +public abstract class ControllerURL<R, L extends ResourceLocator<R>> +{ + + /** . */ + private static final ParameterMap.AccessMode ACCES_MODE = ParameterMap.AccessMode.get(false, false); + + /** . */ + protected final L locator; + + /** . */ + protected Boolean ajax; + + /** . */ + protected String confirm; + + /** . */ + protected ParameterMap queryParams; + + /** + * Create a resource URL instance. + * + * @param locator the resource locator that can't be null + * @param ajax the ajax mode + * @throws NullPointerException if the resource locator is null + */ + public ControllerURL(L locator, Boolean ajax) throws NullPointerException + { + if (locator == null) + { + throw new NullPointerException("No null locator"); + } + + // + this.locator = locator; + this.ajax = ajax; + this.confirm = null; + this.queryParams = null; + } + + /** + * Returns the resource locator of this URL. + * + * @return the resource locator + */ + public final L getResourceLocator() + { + return locator; + } + + /** + * Returns the ajax mode. + * + * @return the ajax mode + */ + public final Boolean getAjax() + { + return ajax; + } + + /** + * Update the ajax mode. + * + * @param ajax the new ajax mode + * @return this object + */ + public final ControllerURL setAjax(Boolean ajax) + { + this.ajax = ajax; + return this; + } + + /** + * Returns the confirm message. + * + * @return the confirm message + */ + public String getConfirm() + { + return confirm; + } + + /** + * Updates the confirm message. + * + * @param confirm the new confirm message + * @return this object + */ + public final ControllerURL setConfirm(String confirm) + { + this.confirm = confirm; + return this; + } + + /** + * Returns the current resource associated with this URL. + * + * @return the resource + */ + public final R getResource() + { + return locator.getResource(); + } + + /** + * Set a new resource on this URL. + * + * @param resource the new resource + * @return this object + */ + public final ControllerURL setResource(R resource) + { + locator.setResource(resource); + return this; + } + + public Map<String, String[]> getQueryParameters() + { + if (queryParams == null) + { + queryParams = new ParameterMap(ACCES_MODE); + } + return queryParams; + } + + public String getQueryParameterValue(String parameterName) + { + if (parameterName == null) + { + throw new NullPointerException(""); + } + else if (queryParams == null) + { + return null; + } + else + { + String[] parameterValues = queryParams.get(parameterName); + return parameterValues != null ? parameterValues[0] : null; + } + } + + public void setQueryParameterValue(String parameterName, String parameterValue) + { + if (parameterName == null) + { + throw new NullPointerException("No null parameter name"); + } + if (queryParams == null) + { + queryParams = new ParameterMap(ACCES_MODE); + } + queryParams.setValue(parameterName, parameterValue); + } + + public String[] getQueryParameterValues(String parameterName) + { + if (parameterName == null) + { + throw new NullPointerException("No null parameter name"); + } + return queryParams != null ? queryParams.getValues(parameterName) : null; + } + + public void setQueryParameterValues(String parameterName, String[] parameterValues) + { + if (parameterName == null) + { + throw new NullPointerException("No null parameter name"); + } + if (queryParams == null) + { + queryParams = new ParameterMap(ACCES_MODE); + } + queryParams.setValues(parameterName, parameterValues); + } + + /** + * Generates the URL value. + * + * @return the URL value + */ + public abstract String toString(); +} Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/LocatorProvider.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/LocatorProvider.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/LocatorProvider.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -20,6 +20,8 @@ package org.exoplatform.web.url; /** + * A provider for locator. + * * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> * @version $Revision$ */ Deleted: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ResourceURL.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ResourceURL.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/url/ResourceURL.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -1,214 +0,0 @@ -/* - * Copyright (C) 2010 eXo Platform SAS. - * - * 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.exoplatform.web.url; - -import org.gatein.common.util.ParameterMap; - -import java.util.Map; - -/** - * An URL for a resource. - * - * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> - * @version $Revision$ - */ -public abstract class ResourceURL<R, L extends ResourceLocator<R>> -{ - - /** . */ - private static final ParameterMap.AccessMode ACCES_MODE = ParameterMap.AccessMode.get(false, false); - - /** . */ - protected final L locator; - - /** . */ - protected Boolean ajax; - - /** . */ - protected String confirm; - - /** . */ - protected ParameterMap queryParams; - - /** - * Create a resource URL instance. - * - * @param locator the resource locator that can't be null - * @param ajax the ajax mode - * @throws NullPointerException if the resource locator is null - */ - public ResourceURL(L locator, Boolean ajax) throws NullPointerException - { - if (locator == null) - { - throw new NullPointerException("No null locator"); - } - - // - this.locator = locator; - this.ajax = ajax; - this.confirm = null; - this.queryParams = null; - } - - /** - * Returns the resource locator of this URL. - * - * @return the resource locator - */ - public final L getResourceLocator() - { - return locator; - } - - /** - * Returns the ajax mode. - * - * @return the ajax mode - */ - public final Boolean getAjax() - { - return ajax; - } - - /** - * Update the ajax mode. - * - * @param ajax the new ajax mode - * @return this object - */ - public final ResourceURL setAjax(Boolean ajax) - { - this.ajax = ajax; - return this; - } - - /** - * Returns the confirm message. - * - * @return the confirm message - */ - public String getConfirm() - { - return confirm; - } - - /** - * Updates the confirm message. - * - * @param confirm the new confirm message - * @return this object - */ - public final ResourceURL setConfirm(String confirm) - { - this.confirm = confirm; - return this; - } - - /** - * Returns the current resource associated with this URL. - * - * @return the resource - */ - public final R getResource() - { - return locator.getResource(); - } - - /** - * Set a new resource on this URL. - * - * @param resource the new resource - * @return this object - */ - public final ResourceURL setResource(R resource) - { - locator.setResource(resource); - return this; - } - - public Map<String, String[]> getQueryParameters() - { - if (queryParams == null) - { - queryParams = new ParameterMap(ACCES_MODE); - } - return queryParams; - } - - public String getQueryParameterValue(String parameterName) - { - if (parameterName == null) - { - throw new NullPointerException(""); - } - else if (queryParams == null) - { - return null; - } - else - { - String[] parameterValues = queryParams.get(parameterName); - return parameterValues != null ? parameterValues[0] : null; - } - } - - public void setQueryParameterValue(String parameterName, String parameterValue) - { - if (parameterName == null) - { - throw new NullPointerException("No null parameter name"); - } - if (queryParams == null) - { - queryParams = new ParameterMap(ACCES_MODE); - } - queryParams.setValue(parameterName, parameterValue); - } - - public String[] getQueryParameterValues(String parameterName) - { - if (parameterName == null) - { - throw new NullPointerException("No null parameter name"); - } - return queryParams != null ? queryParams.getValues(parameterName) : null; - } - - public void setQueryParameterValues(String parameterName, String[] parameterValues) - { - if (parameterName == null) - { - throw new NullPointerException("No null parameter name"); - } - if (queryParams == null) - { - queryParams = new ParameterMap(ACCES_MODE); - } - queryParams.setValues(parameterName, parameterValues); - } - - /** - * Generates the URL value. - * - * @return the URL value - */ - public abstract String toString(); -} Modified: portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalRequestContext.java =================================================================== --- portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalRequestContext.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalRequestContext.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -40,10 +40,10 @@ import org.exoplatform.web.application.JavascriptManager; import org.exoplatform.web.application.URLBuilder; import org.exoplatform.web.controller.QualifiedName; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.web.url.LocatorProvider; import org.exoplatform.web.url.ResourceLocator; import org.exoplatform.web.url.ResourceType; -import org.exoplatform.web.url.ResourceURL; import org.exoplatform.webui.application.WebuiApplication; import org.exoplatform.webui.application.WebuiRequestContext; import org.exoplatform.webui.core.UIComponent; @@ -265,7 +265,7 @@ } @Override - public <R, L extends ResourceLocator<R>> ResourceURL<R, L> newURL(ResourceType<R, L> resourceType, L locator) + public <R, L extends ResourceLocator<R>> ControllerURL<R, L> newURL(ResourceType<R, L> resourceType, L locator) { return new PortalURL<R, L>(this, locator, false, portalOwner_, access); } Modified: portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalURLBuilder.java =================================================================== --- portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalURLBuilder.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/application/PortalURLBuilder.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -21,7 +21,7 @@ import org.exoplatform.web.application.Parameter; import org.exoplatform.web.application.URLBuilder; -import org.exoplatform.web.url.ResourceURL; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.webui.core.UIComponent; import org.exoplatform.webui.url.ComponentLocator; @@ -33,12 +33,12 @@ { /** . */ - private final ResourceURL<UIComponent, ComponentLocator> url; + private final ControllerURL<UIComponent, ComponentLocator> url; /** . */ private final ComponentLocator locator; - public PortalURLBuilder(PortalRequestContext ctx, ResourceURL<UIComponent, ComponentLocator> url) + public PortalURLBuilder(PortalRequestContext ctx, ControllerURL<UIComponent, ComponentLocator> url) { String path = ctx.getNodePath(); url.getResourceLocator().setPath(path); Modified: portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/url/PortalURL.java =================================================================== --- portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/url/PortalURL.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/url/PortalURL.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -21,15 +21,12 @@ import org.exoplatform.portal.application.PortalRequestContext; import org.exoplatform.portal.application.PortalRequestHandler; -import org.exoplatform.web.ControllerContext; import org.exoplatform.web.WebAppController; import org.exoplatform.web.controller.QualifiedName; -import org.exoplatform.web.controller.router.RenderContext; import org.exoplatform.web.controller.router.SimpleRenderContext; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.web.url.ResourceLocator; -import org.exoplatform.web.url.ResourceURL; -import java.io.IOException; import java.util.HashMap; import java.util.Map; @@ -37,7 +34,7 @@ * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> * @version $Revision$ */ -public class PortalURL<R, L extends ResourceLocator<R>> extends ResourceURL<R, L> +public class PortalURL<R, L extends ResourceLocator<R>> extends ControllerURL<R, L> { /** . */ Modified: portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/application/ExoPortletInvocationContext.java =================================================================== --- portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/application/ExoPortletInvocationContext.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/application/ExoPortletInvocationContext.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -21,8 +21,7 @@ import org.exoplatform.Constants; import org.exoplatform.portal.application.PortalRequestContext; -import org.exoplatform.portal.application.PortalRequestHandler; -import org.exoplatform.webui.application.WebuiRequestContext; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.webui.core.UIComponent; import org.exoplatform.webui.url.ComponentLocator; import org.gatein.common.net.media.MediaType; @@ -61,14 +60,14 @@ private final HttpServletRequest request; /** . */ - private final org.exoplatform.web.url.ResourceURL<UIComponent, ComponentLocator> url; + private final ControllerURL<UIComponent, ComponentLocator> url; public ExoPortletInvocationContext(PortalRequestContext portalRequestContext, UIPortlet portlet) { super(new MarkupInfo(MediaType.create("text/html"), "UTF-8")); // - org.exoplatform.web.url.ResourceURL<UIComponent,ComponentLocator> url = portalRequestContext.createURL(ComponentLocator.TYPE, portlet); + ControllerURL<UIComponent,ComponentLocator> url = portalRequestContext.createURL(ComponentLocator.TYPE, portlet); String path = portalRequestContext.getNodePath(); url.getResourceLocator().setPath(path); Modified: portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/workspace/UIPortalApplication.java =================================================================== --- portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/workspace/UIPortalApplication.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/webui/portal/src/main/java/org/exoplatform/portal/webui/workspace/UIPortalApplication.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -48,7 +48,7 @@ import org.exoplatform.services.resources.Orientation; import org.exoplatform.services.resources.ResourceBundleManager; import org.exoplatform.web.application.javascript.JavascriptConfigService; -import org.exoplatform.web.url.ResourceURL; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.webui.application.WebuiRequestContext; import org.exoplatform.webui.config.annotation.ComponentConfig; import org.exoplatform.webui.config.annotation.EventConfig; @@ -544,7 +544,7 @@ isAjaxInLastRequest = false; if (nodePath.equals(lastNonAjaxUri) && !nodePath.equals(lastNodePath)) { - ResourceURL<PageNode, NavigationLocator> nodeURL = + ControllerURL<PageNode, NavigationLocator> nodeURL = pcontext.createURL(org.exoplatform.portal.url.navigation.NavigationLocator.TYPE); nodeURL.setResource(getShowedUIPortal().getSelectedNode()); pcontext.sendRedirect(nodeURL.toString()); Modified: portal/branches/navcontroller/webui/portlet/src/main/java/org/exoplatform/webui/application/portlet/PortletRequestContext.java =================================================================== --- portal/branches/navcontroller/webui/portlet/src/main/java/org/exoplatform/webui/application/portlet/PortletRequestContext.java 2010-09-16 15:21:53 UTC (rev 4227) +++ portal/branches/navcontroller/webui/portlet/src/main/java/org/exoplatform/webui/application/portlet/PortletRequestContext.java 2010-09-16 16:22:29 UTC (rev 4228) @@ -26,7 +26,7 @@ import org.exoplatform.web.url.LocatorProvider; import org.exoplatform.web.url.ResourceLocator; import org.exoplatform.web.url.ResourceType; -import org.exoplatform.web.url.ResourceURL; +import org.exoplatform.web.url.ControllerURL; import org.exoplatform.webui.application.WebuiApplication; import org.exoplatform.webui.application.WebuiRequestContext; import org.exoplatform.webui.core.UIApplication; @@ -81,7 +81,7 @@ } @Override - public <R, L extends ResourceLocator<R>> ResourceURL<R, L> newURL(ResourceType<R, L> resourceType, L locator) + public <R, L extends ResourceLocator<R>> ControllerURL<R, L> newURL(ResourceType<R, L> resourceType, L locator) { return parentAppRequestContext_.newURL(resourceType, locator); }