Coverage Report - org.apache.tapestry.engine.DirectEventService
 
Classes in this File Line Coverage Branch Coverage Complexity
DirectEventService
95% 
100% 
2.125
 
 1  
 // Copyright 2004, 2005 The Apache Software Foundation
 2  
 //
 3  
 // Licensed under the Apache License, Version 2.0 (the "License");
 4  
 // you may not use this file except in compliance with the License.
 5  
 // You may obtain a copy of the License at
 6  
 //
 7  
 //     http://www.apache.org/licenses/LICENSE-2.0
 8  
 //
 9  
 // Unless required by applicable law or agreed to in writing, software
 10  
 // distributed under the License is distributed on an "AS IS" BASIS,
 11  
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12  
 // See the License for the specific language governing permissions and
 13  
 // limitations under the License.
 14  
 
 15  
 package org.apache.tapestry.engine;
 16  
 
 17  
 import java.io.IOException;
 18  
 import java.util.HashMap;
 19  
 import java.util.Map;
 20  
 
 21  
 import org.apache.hivemind.ApplicationRuntimeException;
 22  
 import org.apache.hivemind.util.Defense;
 23  
 import org.apache.tapestry.IComponent;
 24  
 import org.apache.tapestry.IDirectEvent;
 25  
 import org.apache.tapestry.IPage;
 26  
 import org.apache.tapestry.IRequestCycle;
 27  
 import org.apache.tapestry.StaleSessionException;
 28  
 import org.apache.tapestry.Tapestry;
 29  
 import org.apache.tapestry.event.BrowserEvent;
 30  
 import org.apache.tapestry.services.LinkFactory;
 31  
 import org.apache.tapestry.services.ResponseRenderer;
 32  
 import org.apache.tapestry.services.ServiceConstants;
 33  
 import org.apache.tapestry.web.WebRequest;
 34  
 import org.apache.tapestry.web.WebSession;
 35  
 
 36  
 /**
 37  
  * Implementation of the direct event service, which encodes the page and component id in the service
 38  
  * context, and passes application-defined parameters as well.
 39  
  * 
 40  
  * @author jkuhnert
 41  
  * @since 4.1
 42  
  */
 43  
 
 44  10
 public class DirectEventService implements IEngineService
 45  
 {   
 46  
     /** @since 4.0 */
 47  
     private ResponseRenderer _responseRenderer;
 48  
 
 49  
     /** @since 4.0 */
 50  
     private LinkFactory _linkFactory;
 51  
 
 52  
     /** @since 4.0 */
 53  
     private WebRequest _request;
 54  
 
 55  
     /** @since 4.0 */
 56  
     private IRequestCycle _requestCycle;
 57  
 
 58  
     public ILink getLink(boolean post, Object parameter)
 59  
     {
 60  6
         Defense.isAssignable(parameter, DirectEventServiceParameter.class, "parameter");
 61  
 
 62  4
         DirectEventServiceParameter dsp = (DirectEventServiceParameter) parameter;
 63  
 
 64  4
         IComponent component = dsp.getDirect();
 65  
 
 66  
         // New since 1.0.1, we use the component to determine
 67  
         // the page, not the cycle. Through the use of tricky
 68  
         // things such as Block/InsertBlock, it is possible
 69  
         // that a component from a page different than
 70  
         // the response page will render.
 71  
         // In 1.0.6, we start to record *both* the render page
 72  
         // and the component page (if different).
 73  
 
 74  4
         IPage activePage = _requestCycle.getPage();
 75  4
         IPage componentPage = component.getPage();
 76  
         
 77  4
         Map parameters = new HashMap();
 78  
         
 79  4
         boolean stateful = _request.getSession(false) != null;
 80  
         
 81  4
         parameters.put(ServiceConstants.PAGE, activePage.getPageName());
 82  4
         parameters.put(ServiceConstants.COMPONENT, component.getIdPath());
 83  4
         parameters.put(ServiceConstants.CONTAINER, componentPage == activePage ? null
 84  
                 : componentPage.getPageName());
 85  4
         parameters.put(ServiceConstants.SESSION, stateful ? "T" : null);
 86  4
         if (dsp.getUpdateParts() != null && dsp.getUpdateParts().length > 0)
 87  0
             parameters.put(ServiceConstants.UPDATE_PARTS, dsp.getUpdateParts());
 88  4
         if (dsp.isJSON())
 89  0
             parameters.put("json", String.valueOf(dsp.isJSON()));
 90  4
         parameters.put(ServiceConstants.PARAMETER, dsp.getServiceParameters());
 91  
         
 92  4
         return _linkFactory.constructLink(this, post, parameters, true);
 93  
     }
 94  
 
 95  
     public void service(IRequestCycle cycle) throws IOException
 96  
     {
 97  6
         String componentId = cycle.getParameter(ServiceConstants.COMPONENT);
 98  6
         String componentPageName = cycle.getParameter(ServiceConstants.CONTAINER);
 99  6
         String activePageName = cycle.getParameter(ServiceConstants.PAGE);
 100  6
         boolean activeSession = cycle.getParameter(ServiceConstants.SESSION) != null;
 101  
         
 102  6
         IPage page = cycle.getPage(activePageName);
 103  
 
 104  6
         cycle.activate(page);
 105  
 
 106  6
         IPage componentPage = componentPageName == null ? page : cycle.getPage(componentPageName);
 107  
 
 108  6
         IComponent component = componentPage.getNestedComponent(componentId);
 109  
 
 110  6
         IDirectEvent direct = null;
 111  
 
 112  
         try
 113  
         {
 114  6
             direct = (IDirectEvent) component;
 115  
         }
 116  1
         catch (ClassCastException ex)
 117  
         {
 118  1
             throw new ApplicationRuntimeException(EngineMessages.wrongComponentType(
 119  
                     component,
 120  
                     IDirectEvent.class), component, null, ex);
 121  5
         }
 122  
 
 123  
         // Check for a StaleSession only when the session was stateful when
 124  
         // the link was created.
 125  
 
 126  5
         if (activeSession && direct.isStateful())
 127  
         {
 128  2
             WebSession session = _request.getSession(false);
 129  
 
 130  2
             if (session == null || session.isNew())
 131  1
                 throw new StaleSessionException(EngineMessages.requestStateSession(direct),
 132  
                         componentPage);
 133  
         }
 134  
         
 135  4
         Object[] parameters = _linkFactory.extractListenerParameters(cycle);
 136  
         
 137  4
         triggerComponent(cycle, direct, parameters);
 138  
         
 139  
         // Render the response. This will be the active page
 140  
         // unless the direct component (or its delegate) changes it.
 141  
         
 142  3
         _responseRenderer.renderResponse(cycle);
 143  3
     }
 144  
 
 145  
     /** @since 4.0 */
 146  
 
 147  
     protected void triggerComponent(IRequestCycle cycle, IDirectEvent direct, Object[] parameters)
 148  
     {
 149  4
         if (!BrowserEvent.hasBrowserEvent(cycle))
 150  1
             throw new ApplicationRuntimeException(EngineMessages.noBrowserEvent());
 151  
         
 152  3
         BrowserEvent event = new BrowserEvent(cycle);
 153  
         
 154  3
         Object[] parms = new Object[parameters.length + 1];
 155  3
         System.arraycopy(parameters, 0, parms, 0, parameters.length);
 156  3
         parms[parms.length - 1] = event;
 157  
         
 158  3
         cycle.setListenerParameters(parms);
 159  
         
 160  3
         direct.triggerEvent(cycle, event);
 161  3
     }
 162  
 
 163  
     public String getName()
 164  
     {
 165  0
         return Tapestry.DIRECT_EVENT_SERVICE;
 166  
     }
 167  
 
 168  
     /** @since 4.0 */
 169  
     public void setResponseRenderer(ResponseRenderer responseRenderer)
 170  
     {
 171  4
         _responseRenderer = responseRenderer;
 172  4
     }
 173  
 
 174  
     /** @since 4.0 */
 175  
     public void setLinkFactory(LinkFactory linkFactory)
 176  
     {
 177  8
         _linkFactory = linkFactory;
 178  8
     }
 179  
 
 180  
     /** @since 4.0 */
 181  
     public void setRequest(WebRequest request)
 182  
     {
 183  6
         _request = request;
 184  6
     }
 185  
 
 186  
     /** @since 4.0 */
 187  
     public void setRequestCycle(IRequestCycle requestCycle)
 188  
     {
 189  4
         _requestCycle = requestCycle;
 190  4
     }
 191  
 }