Coverage Report - org.apache.tapestry.engine.DirectService
 
Classes in this File Line Coverage Branch Coverage Complexity
DirectService
0%
0/60
0%
0/34
3
 
 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 org.apache.hivemind.ApplicationRuntimeException;
 18  
 import org.apache.hivemind.util.Defense;
 19  
 import org.apache.tapestry.*;
 20  
 import org.apache.tapestry.event.BrowserEvent;
 21  
 import org.apache.tapestry.services.LinkFactory;
 22  
 import org.apache.tapestry.services.ResponseRenderer;
 23  
 import org.apache.tapestry.services.ServiceConstants;
 24  
 import org.apache.tapestry.web.WebRequest;
 25  
 import org.apache.tapestry.web.WebSession;
 26  
 
 27  
 import java.io.IOException;
 28  
 import java.util.HashMap;
 29  
 import java.util.Map;
 30  
 
 31  
 /**
 32  
  * Implementation of the direct service, which encodes the page and component id in the service
 33  
  * context, and passes application-defined parameters as well.
 34  
  * 
 35  
  * @author Howard Lewis Ship
 36  
  * @since 1.0.9
 37  
  */
 38  
 
 39  0
 public class DirectService implements IEngineService
 40  
 {
 41  
     /** @since 4.0 */
 42  
     protected ResponseRenderer _responseRenderer;
 43  
 
 44  
     /** @since 4.0 */
 45  
     protected LinkFactory _linkFactory;
 46  
 
 47  
     /** @since 4.0 */
 48  
     protected WebRequest _request;
 49  
 
 50  
     /** @since 4.0 */
 51  
     private IRequestCycle _requestCycle;
 52  
 
 53  
     public ILink getLink(boolean post, Object parameter)
 54  
     {
 55  0
         Defense.isAssignable(parameter, DirectServiceParameter.class, "parameter");
 56  
 
 57  0
         DirectServiceParameter dsp = (DirectServiceParameter) parameter;
 58  
 
 59  0
         IComponent component = dsp.getDirect();
 60  0
         IDirect direct = dsp.getDirect();
 61  
 
 62  
         // New since 1.0.1, we use the component to determine
 63  
         // the page, not the cycle. Through the use of tricky
 64  
         // things such as Block/InsertBlock, it is possible
 65  
         // that a component from a page different than
 66  
         // the response page will render.
 67  
         // In 1.0.6, we start to record *both* the render page
 68  
         // and the component page (if different).
 69  
 
 70  0
         IPage activePage = _requestCycle.getPage();
 71  0
         IPage componentPage = component.getPage();
 72  
         
 73  0
         Map parameters = new HashMap();
 74  
 
 75  0
         boolean stateful = _request.getSession(false) != null;
 76  
         
 77  0
         parameters.put(ServiceConstants.PAGE, activePage.getPageName());
 78  0
         parameters.put(ServiceConstants.COMPONENT, component.getIdPath());
 79  0
         parameters.put(ServiceConstants.CONTAINER, componentPage == activePage ? null
 80  
                 : componentPage.getPageName());
 81  0
         parameters.put(ServiceConstants.SESSION, stateful ? "T" : null);
 82  
         
 83  
         // handle dynamic XHR/JSON parameters
 84  0
         if (dsp.isAsync() || dsp.isJson()) {
 85  
             
 86  0
             if (dsp.getUpdateParts() != null && dsp.getUpdateParts().length > 0)
 87  0
                 parameters.put(ServiceConstants.UPDATE_PARTS, dsp.getUpdateParts());
 88  
             
 89  0
             if (dsp.isJson())
 90  0
                 parameters.put("json", String.valueOf(dsp.isJson()));
 91  
             
 92  
             // don't need to put isAsync parameter in as that is handled via http headers
 93  
         }
 94  
         
 95  0
         parameters.put(ServiceConstants.PARAMETER, dsp.getServiceParameters());
 96  
         
 97  0
         return _linkFactory.constructLink(this, post, parameters, direct.isStateful());
 98  
     }
 99  
 
 100  
     public void service(IRequestCycle cycle) throws IOException
 101  
     {
 102  0
         String componentId = cycle.getParameter(ServiceConstants.COMPONENT);
 103  0
         String componentPageName = cycle.getParameter(ServiceConstants.CONTAINER);
 104  0
         String activePageName = cycle.getParameter(ServiceConstants.PAGE);
 105  0
         boolean activeSession = cycle.getParameter(ServiceConstants.SESSION) != null;
 106  
         
 107  0
         IPage page = cycle.getPage(activePageName);
 108  
 
 109  0
         cycle.activate(page);
 110  
 
 111  0
         IPage componentPage = componentPageName == null ? page : cycle.getPage(componentPageName);
 112  
 
 113  0
         IComponent component = componentPage.getNestedComponent(componentId);
 114  
 
 115  0
         IDirect direct = null;
 116  
 
 117  
         try
 118  
         {
 119  0
             direct = (IDirect) component;
 120  
         }
 121  0
         catch (ClassCastException ex)
 122  
         {
 123  0
             throw new ApplicationRuntimeException(EngineMessages.wrongComponentType(
 124  
                     component,
 125  
                     IDirect.class), component, null, ex);
 126  0
         }
 127  
 
 128  
         // Check for a StaleSession only when the session was stateful when
 129  
         // the link was created.
 130  
 
 131  0
         if (activeSession && direct.isStateful())
 132  
         {
 133  0
             WebSession session = _request.getSession(false);
 134  
 
 135  0
             if (session == null || session.isNew())
 136  0
                 throw new StaleSessionException(EngineMessages.requestStateSession(direct),
 137  
                         componentPage);
 138  
         }
 139  
 
 140  0
         Object[] parameters = _linkFactory.extractListenerParameters(cycle);
 141  
 
 142  0
         triggerComponent(cycle, direct, parameters);
 143  
 
 144  
         // Render the response. This will be the active page
 145  
         // unless the direct component (or its delegate) changes it.
 146  
 
 147  0
         _responseRenderer.renderResponse(cycle);
 148  0
     }
 149  
 
 150  
     /** @since 4.0 */
 151  
 
 152  
     protected void triggerComponent(IRequestCycle cycle, IDirect direct, Object[] parameters)
 153  
     {
 154  0
         if (BrowserEvent.hasBrowserEvent(cycle))
 155  
         {    
 156  0
             BrowserEvent event = new BrowserEvent(cycle);
 157  
             
 158  0
             Object[] parms = new Object[parameters.length + 1];
 159  0
             System.arraycopy(parameters, 0, parms, 0, parameters.length);
 160  0
             parms[parms.length - 1] = event;
 161  
             
 162  0
             cycle.setListenerParameters(parms);
 163  0
         } else
 164  0
             cycle.setListenerParameters(parameters);
 165  
         
 166  0
         direct.trigger(cycle);
 167  0
     }
 168  
 
 169  
     public String getName()
 170  
     {
 171  0
         return Tapestry.DIRECT_SERVICE;
 172  
     }
 173  
 
 174  
     /** @since 4.0 */
 175  
     public void setResponseRenderer(ResponseRenderer responseRenderer)
 176  
     {
 177  0
         _responseRenderer = responseRenderer;
 178  0
     }
 179  
 
 180  
     /** @since 4.0 */
 181  
     public void setLinkFactory(LinkFactory linkFactory)
 182  
     {
 183  0
         _linkFactory = linkFactory;
 184  0
     }
 185  
 
 186  
     /** @since 4.0 */
 187  
     public void setRequest(WebRequest request)
 188  
     {
 189  0
         _request = request;
 190  0
     }
 191  
 
 192  
     /** @since 4.0 */
 193  
     public void setRequestCycle(IRequestCycle requestCycle)
 194  
     {
 195  0
         _requestCycle = requestCycle;
 196  0
     }
 197  
 }