Author: chris.laprun(a)jboss.com Date: 2010-01-19 08:07:44 -0500 (Tue, 19 Jan 2010) New Revision: 1368 Added: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/ConsumerController.java Removed: portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpConsoleContent.gtmpl portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpPortlet.gtmpl Modified: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsole.java portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerEditor.java portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerOverview.java portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpPortlet.java Log: - Display consumer editor on error so that we can display updated information if appropriate (or let user correct any mistake). - Started extracting business logic into a UI-independent controller class. - Cleaned-up UI classes by removing useless extra elements and refactoring things to reuse more code. Added: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/ConsumerController.java =================================================================== --- portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/ConsumerController.java (rev 0) +++ portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/ConsumerController.java 2010-01-19 13:07:44 UTC (rev 1368) @@ -0,0 +1,85 @@ +/* + * JBoss, a division of Red Hat + * Copyright 2010, 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.exoplatform.wsrp.webui.component; + +import org.gatein.pc.api.PortletInvokerException; +import org.gatein.wsrp.WSRPConsumer; +import org.gatein.wsrp.consumer.RefreshResult; +import org.gatein.wsrp.consumer.registry.ConsumerRegistry; + +import java.util.List; + +/** + * @author <a href="mailto:chris.laprun@jboss.com">Chris Laprun</a> + * @version $Revision$ + */ +public class ConsumerController +{ + private ConsumerRegistry registry; + + public ConsumerController(ConsumerRegistry registry) + { + this.registry = registry; + } + + public ConsumerRegistry getRegistry() + { + return registry; + } + + public WSRPConsumer getConsumer(String id) + { + return registry.getConsumer(id); + } + + public List<WSRPConsumer> getConfiguredConsumers() + { + return registry.getConfiguredConsumers(); + } + + public RefreshResult refreshConsumer(WSRPConsumer consumer) throws PortletInvokerException + { + RefreshResult result = consumer.refresh(true); + + if (result.hasIssues()) + { + // refresh had issues, we should deactivate this consumer + registry.deactivateConsumerWith(consumer.getProducerId()); + } + else + { + // activate the consumer if it's supposed to be active + if (consumer.isActive()) + { + registry.activateConsumerWith(consumer.getProducerId()); + } + else + { + registry.deactivateConsumerWith(consumer.getProducerId()); + } + } + + return result; + } +} Modified: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsole.java =================================================================== --- portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsole.java 2010-01-19 12:42:54 UTC (rev 1367) +++ portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsole.java 2010-01-19 13:07:44 UTC (rev 1368) @@ -23,29 +23,21 @@ package org.exoplatform.wsrp.webui.component; import org.exoplatform.webui.config.annotation.ComponentConfig; -import org.exoplatform.webui.config.annotation.ComponentConfigs; -import org.exoplatform.webui.config.annotation.EventConfig; import org.exoplatform.webui.core.UIContainer; import org.exoplatform.webui.core.UITabPane; import org.exoplatform.webui.core.lifecycle.UIApplicationLifecycle; -/** @author Wesley Hales */ -@ComponentConfigs({ - @ComponentConfig( - lifecycle = UIApplicationLifecycle.class, - template = "app:/groovy/wsrp/webui/component/UIWsrpConsole.gtmpl"), - @ComponentConfig( - id = "UIWsrpConsoleTab", - type = UITabPane.class, - template = "app:/groovy/wsrp/webui/component/UIWsrpConsoleContent.gtmpl", - events = {@EventConfig(listeners = UITabPane.SelectTabActionListener.class)})}) +@ComponentConfig( + lifecycle = UIApplicationLifecycle.class, + template = "app:/groovy/wsrp/webui/component/UIWsrpConsole.gtmpl" +) public class UIWsrpConsole extends UIContainer { public UIWsrpConsole() throws Exception { - UITabPane uiTabPane = addChild(UITabPane.class, "UIWsrpConsoleTab", null); - uiTabPane.addChild(UIWsrpConsumerOverview.class, null, "Manage Consumers").setRendered(true); - uiTabPane.addChild(UIWsrpProducerOverview.class, null, "Producer Configuration").setRendered(false); + UITabPane uiTabPane = addChild(UITabPane.class, null, null); + uiTabPane.addChild(UIWsrpConsumerOverview.class, null, "Manage Consumers"); + uiTabPane.addChild(UIWsrpProducerOverview.class, null, "Producer Configuration"); if (uiTabPane.getSelectedTabId().equals("")) { Modified: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerEditor.java =================================================================== --- portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerEditor.java 2010-01-19 12:42:54 UTC (rev 1367) +++ portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerEditor.java 2010-01-19 13:07:44 UTC (rev 1368) @@ -25,8 +25,6 @@ import org.exoplatform.commons.utils.LazyPageList; import org.exoplatform.container.ExoContainer; import org.exoplatform.container.ExoContainerContext; -import org.exoplatform.portal.application.PortalRequestContext; -import org.exoplatform.portal.webui.portal.UIPortal; import org.exoplatform.web.application.ApplicationMessage; import org.exoplatform.webui.application.WebuiRequestContext; import org.exoplatform.webui.config.annotation.ComponentConfig; @@ -37,7 +35,6 @@ import org.exoplatform.webui.core.lifecycle.UIFormLifecycle; import org.exoplatform.webui.event.Event; import org.exoplatform.webui.event.EventListener; -import org.exoplatform.webui.event.MonitorEvent; import org.exoplatform.webui.form.UIForm; import org.exoplatform.webui.form.UIFormInputBase; import org.exoplatform.webui.form.UIFormStringInput; @@ -121,7 +118,7 @@ this.newConsumer = newConsumer; } - public void setConsumer(WSRPConsumer consumer) throws Exception + public void setConsumer(WSRPConsumer consumer) { if (consumer == null) { @@ -139,13 +136,6 @@ setNewConsumer(false); } - private void bindingFields(WSRPConsumer consumer) - { - ProducerInfo producerInfo = consumer.getProducerInfo(); - producerInfo.setId(getConsumerName()); - producerInfo.setExpirationCacheSeconds(getCacheExpiration()); - } - static public class SaveActionListener extends EventListener<UIWsrpConsumerEditor> { public void execute(Event<UIWsrpConsumerEditor> event) throws Exception Modified: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerOverview.java =================================================================== --- portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerOverview.java 2010-01-19 12:42:54 UTC (rev 1367) +++ portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpConsumerOverview.java 2010-01-19 13:07:44 UTC (rev 1368) @@ -24,23 +24,21 @@ import org.exoplatform.commons.utils.LazyPageList; import org.exoplatform.commons.utils.ListAccess; -import org.exoplatform.container.ExoContainer; import org.exoplatform.container.ExoContainerContext; import org.exoplatform.web.application.ApplicationMessage; -import org.exoplatform.webui.application.WebuiRequestContext; import org.exoplatform.webui.config.annotation.ComponentConfig; import org.exoplatform.webui.config.annotation.ComponentConfigs; import org.exoplatform.webui.config.annotation.EventConfig; import org.exoplatform.webui.core.UIApplication; import org.exoplatform.webui.core.UIContainer; import org.exoplatform.webui.core.UIGrid; +import org.exoplatform.webui.core.UIPageIterator; import org.exoplatform.webui.core.UIPopupWindow; import org.exoplatform.webui.core.lifecycle.UIApplicationLifecycle; import org.exoplatform.webui.event.Event; import org.exoplatform.webui.event.EventListener; import org.gatein.wsrp.WSRPConsumer; import org.gatein.wsrp.consumer.RefreshResult; -import org.gatein.wsrp.consumer.RegistrationInfo; import org.gatein.wsrp.consumer.registry.ConsumerRegistry; import java.util.List; @@ -74,12 +72,13 @@ // public static String[] SELECT_ACTIONS = {"Edit", "Delete", "Refresh", "Activate", "Deactivate"}; - private RegistrationInfo expectedRegistrationInfo; + private ConsumerController controller; + private UIPopupWindow consumerEditorPopup; + private UIPageIterator consumersIterator; public List getConfiguredConsumers() throws Exception { - ConsumerRegistry consumerRegistry = getConsumerRegistry(); - return consumerRegistry.getConfiguredConsumers(); + return controller.getConfiguredConsumers(); } public LazyPageList createPageList(final List pageList) @@ -92,7 +91,7 @@ return pageList.size(); } - public WSRPConsumer[] load(int index, int length) throws Exception, IllegalArgumentException + public WSRPConsumer[] load(int index, int length) throws Exception { WSRPConsumer[] pcs = new WSRPConsumer[pageList.size()]; @@ -125,30 +124,28 @@ public UIWsrpConsumerOverview() throws Exception { + // controller + ConsumerRegistry registry = (ConsumerRegistry)ExoContainerContext.getCurrentContainer().getComponentInstanceOfType(ConsumerRegistry.class); + controller = new ConsumerController(registry); + //setSelectedTab(1); - UIPopupWindow popup = addChild(UIPopupWindow.class, null, null); - popup.setWindowSize(450, 0); + consumerEditorPopup = addChild(UIPopupWindow.class, null, null); + consumerEditorPopup.setWindowSize(450, 0); UIWsrpConsumerEditor consumerForm = createUIComponent(UIWsrpConsumerEditor.class, null, "Consumer Editor"); - popup.setUIComponent(consumerForm); - popup.setRendered(false); + consumerEditorPopup.setUIComponent(consumerForm); + consumerEditorPopup.setRendered(false); - UIGrid uiGrid = addChild(UIGrid.class, "ConsumerSelector", null); + UIGrid consumers = addChild(UIGrid.class, "ConsumerSelector", null); //configure the edit and delete buttons based on an id from the data list - this will also be passed as param to listener - uiGrid.configure("producerId", FIELDS, SELECT_ACTIONS); + consumers.configure("producerId", FIELDS, SELECT_ACTIONS); - uiGrid.getUIPageIterator().setId("ChangeConsumerPageIterator"); - addChild(uiGrid.getUIPageIterator()); - uiGrid.getUIPageIterator().setRendered(false); + consumersIterator = consumers.getUIPageIterator(); + consumersIterator.setId("ChangeConsumerPageIterator"); + consumersIterator.setRendered(false); - LazyPageList pageList = createPageList(getConfiguredConsumers()); - uiGrid.getUIPageIterator().setPageList(pageList); + refreshConsumersList(); } - private void setExpectedRegistrationInfo(RegistrationInfo expectedRegistrationInfo) - { - this.expectedRegistrationInfo = expectedRegistrationInfo; - } - static public class RefreshGridActionListener extends EventListener<UIWsrpConsumerOverview> { public void execute(Event<UIWsrpConsumerOverview> event) throws Exception @@ -160,34 +157,37 @@ public void refreshGrid(Event<UIWsrpConsumerOverview> event) throws Exception { - UIWsrpConsumerOverview consumerOverview = event.getSource(); - WebuiRequestContext ctx = event.getRequestContext(); - - UIGrid uiGrid = consumerOverview.getChild(UIGrid.class); //refresh the list - LazyPageList pageList = consumerOverview.createPageList(consumerOverview.getConfiguredConsumers()); - uiGrid.getUIPageIterator().setPageList(pageList); + refreshConsumersList(); - ctx.addUIComponentToUpdateByAjax(consumerOverview); + event.getRequestContext().addUIComponentToUpdateByAjax(this); } + private void refreshConsumersList() throws Exception + { + LazyPageList pageList = createPageList(getConfiguredConsumers()); + consumersIterator.setPageList(pageList); + } + static public class OpenPopupActionListener extends EventListener<UIWsrpConsumerOverview> { public void execute(Event<UIWsrpConsumerOverview> event) throws Exception { UIWsrpConsumerOverview consumerOverview = event.getSource(); - UIPopupWindow popup = consumerOverview.getChild(UIPopupWindow.class); - UIWsrpConsumerEditor editor = (UIWsrpConsumerEditor)popup.getUIComponent(); + consumerOverview.displayConsumerEditor(null); + } + } - //reset the form - editor.reset(); - editor.setConsumer(null); - popup.setRendered(true); - popup.setShow(true); - popup.setShowCloseButton(true); - //popup.setShowMask(true); + private void displayConsumerEditor(WSRPConsumer consumer) throws Exception + { + UIWsrpConsumerEditor editor = (UIWsrpConsumerEditor)consumerEditorPopup.getUIComponent(); - } + //reset the form + editor.reset(); + editor.setConsumer(consumer); + consumerEditorPopup.setRendered(true); + consumerEditorPopup.setShow(true); + consumerEditorPopup.setShowCloseButton(true); } static public class EditActionListener extends EventListener<UIWsrpConsumerOverview> @@ -197,24 +197,9 @@ UIWsrpConsumerOverview consumerOverview = event.getSource(); WSRPConsumer consumer = consumerOverview.getConsumerFromEvent(event); - UIApplication uiApp = event.getRequestContext().getUIApplication(); - if (consumer != null) { - UIPopupWindow popup = consumerOverview.getChild(UIPopupWindow.class); - UIWsrpConsumerEditor editor = (UIWsrpConsumerEditor)popup.getUIComponent(); - - try - { - editor.setConsumer(consumer); - } - catch (Exception e) - { - e.printStackTrace(); - } - popup.setUIComponent(editor); - popup.setRendered(true); - popup.setShow(true); + consumerOverview.displayConsumerEditor(consumer); } } } @@ -308,35 +293,18 @@ if (consumer != null) { - ConsumerRegistry registry = consumerOverview.getConsumerRegistry(); - RefreshResult result = consumer.refresh(true); + RefreshResult result = consumerOverview.controller.refreshConsumer(consumer); if (result.hasIssues()) { - // create the expected registration info and make it available - RegistrationInfo expected = new RegistrationInfo(consumer.getProducerInfo().getRegistrationInfo()); - expected.refresh(result.getServiceDescription(), consumer.getProducerId(), true, true, true); - consumerOverview.setExpectedRegistrationInfo(expected); - - // refresh had issues, we should deactivate this consumer - registry.deactivateConsumerWith(consumer.getProducerId()); - - uiApp.addMessage(new ApplicationMessage("UIWsrp.consumer.grid.action.refresh.fail", - new Object[]{result.getStatus()}, ApplicationMessage.ERROR)); + consumerOverview.displayConsumerEditor(consumer); } else { - // activate the consumer if it's supposed to be active - if (consumer.isActive()) - { - registry.activateConsumerWith(consumer.getProducerId()); - } - else - { - registry.deactivateConsumerWith(consumer.getProducerId()); - } uiApp.addMessage(new ApplicationMessage("UIWsrp.consumer.grid.action.refresh.success", null, ApplicationMessage.INFO)); } + + // refresh consumers consumerOverview.refreshGrid(event); } } @@ -348,25 +316,14 @@ } } - public void processRender(WebuiRequestContext context) throws Exception - { -// UITabPane uiTabPane = context.getUIApplication().findComponentById("UIWsrpConsoleTab"); -// uiTabPane.setSelectedTab(1); - super.processRender(context); - } - - public WSRPConsumer getConsumerFromEvent(Event<?> event) throws Exception { - ConsumerRegistry consumerRegistry = getConsumerRegistry(); String id = event.getRequestContext().getRequestParameter(OBJECTID); - return consumerRegistry.getConsumer(id); + return controller.getConsumer(id); } public ConsumerRegistry getConsumerRegistry() throws Exception { - // todo: this lookup shouldn't be done on each invocation, store it if possible - ExoContainer manager = ExoContainerContext.getCurrentContainer(); - return (ConsumerRegistry)manager.getComponentInstanceOfType(ConsumerRegistry.class); + return controller.getRegistry(); } } Modified: portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpPortlet.java =================================================================== --- portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpPortlet.java 2010-01-19 12:42:54 UTC (rev 1367) +++ portal/trunk/portlet/exoadmin/src/main/java/org/exoplatform/wsrp/webui/component/UIWsrpPortlet.java 2010-01-19 13:07:44 UTC (rev 1368) @@ -23,24 +23,20 @@ package org.exoplatform.wsrp.webui.component; import org.exoplatform.webui.config.annotation.ComponentConfig; -import org.exoplatform.webui.config.annotation.EventConfig; import org.exoplatform.webui.core.UIPortletApplication; import org.exoplatform.webui.core.lifecycle.UIApplicationLifecycle; /** @author Wesley Hales */ @ComponentConfig( - lifecycle = UIApplicationLifecycle.class, - template = "app:/groovy/wsrp/webui/component/UIWsrpPortlet.gtmpl" + lifecycle = UIApplicationLifecycle.class ) public class UIWsrpPortlet extends UIPortletApplication { public UIWsrpPortlet() throws Exception { - addChild(UIWsrpConsole.class,null,null); + addChild(UIWsrpConsole.class, null, null); } - - } Deleted: portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpConsoleContent.gtmpl =================================================================== --- portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpConsoleContent.gtmpl 2010-01-19 12:42:54 UTC (rev 1367) +++ portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpConsoleContent.gtmpl 2010-01-19 13:07:44 UTC (rev 1368) @@ -1,50 +0,0 @@ -<% - import org.exoplatform.wsrp.webui.component.UIWsrpConsumerOverview; - import org.exoplatform.wsrp.webui.component.UIWsrpProducerOverview; - - - def rcontext = _ctx.getRequestContext(); - rcontext.getJavascriptManager().importJavascript('eXo.webui.UIHorizontalTabs'); -%> - -<div class="UITabPane" id="$uicomponent.id"> - <div class="UIHorizontalTabs"> - <div class="TabsContainer"> - <% - String url = uicomponent.url("SelectTab"); - String selTabId = uicomponent.getSelectedTabId(); - - UIWsrpConsumerOverview consumerOverview = uicomponent.getChild(UIWsrpConsumerOverview.class); - UIWsrpProducerOverview producerOverview = uicomponent.getChild(UIWsrpProducerOverview.class); - %> - <div class="UITab GrayTabStyle"> - <div class="<%= consumerOverview.getId().equals(selTabId) ? "SelectedTab" : "NormalTab" %>"> - <div class="LeftTab"> - <div class="RightTab"> - <% String consumerLink = "ajaxAsyncGetRequest('" + uicomponent.url("SelectTab",consumerOverview.getId()) + "', true)" %> - <div class="MiddleTab" onclick="eXo.webui.UIHorizontalTabs.changeTabForUITabPane(this, '${consumerOverview.getId()}', '$url');$consumerLink;"> - <%=_ctx.appRes("UITabPane.title." + consumerOverview.getId());%> - </div> - </div> - </div> - </div> - </div> - <div class="UITab GrayTabStyle"> - <div class="<%= producerOverview.getId().equals(selTabId) ? "SelectedTab" : "NormalTab" %>"> - <div class="LeftTab"> - <div class="RightTab"> - <% String producerLink = "ajaxAsyncGetRequest('" + uicomponent.url("SelectTab",producerOverview.getId()) + "', true)" %> - <div class="MiddleTab" onclick="eXo.webui.UIHorizontalTabs.changeTabForUITabPane(this, '${producerOverview.getId()}', '$url');$producerLink;"> - <%=_ctx.appRes("UITabPane.title." + producerOverview.getId());%> - </div> - </div> - </div> - </div> - </div> - </div> - </div> - <div class="UITabContentContainer GrayTabContainer"> - <div class="UITabContent" style="display: <%=consumerOverview.getId().equals(selTabId) ? "block": "none"%>;overflow:auto;clear:both"><% uicomponent.renderUIComponent(consumerOverview); %></div> - <div class="UITabContent" style="display: <%=producerOverview.getId().equals(selTabId) ? "block": "none"%>;overflow:auto;clear:both"><% uicomponent.renderUIComponent(producerOverview); %></div> - </div> -</div> Deleted: portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpPortlet.gtmpl =================================================================== --- portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpPortlet.gtmpl 2010-01-19 12:42:54 UTC (rev 1367) +++ portal/trunk/portlet/exoadmin/src/main/webapp/groovy/wsrp/webui/component/UIWsrpPortlet.gtmpl 2010-01-19 13:07:44 UTC (rev 1368) @@ -1,4 +0,0 @@ - -<div class="<%=uicomponent.getId()%>"> - <% uicomponent.renderChildren(); %> -</div> \ No newline at end of file