View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.aggregator;
18  
19  import javax.servlet.http.HttpServletResponse;
20  
21  import org.apache.jetspeed.om.page.Fragment;
22  import org.apache.jetspeed.request.RequestContext;
23  import org.apache.pluto.om.window.PortletWindow;
24  
25  /***
26   * <p>The ContentDispatcher control interface used for updating the content of
27   *    a ContentDispatcher</p>
28   *
29   * @author <a href="mailto:raphael@apache.org">Rapha?l Luta</a>
30   * @version $Id: ContentDispatcherCtrl.java 516448 2007-03-09 16:25:47Z ate $
31   */
32  public interface ContentDispatcherCtrl extends ContentDispatcher
33  {
34      /***
35       * Return the HttpServletResponse to use for a given PortletWindow
36       * in order to be able to capture parallel rendering portlets
37       */
38      public HttpServletResponse getResponseForWindow(PortletWindow window, RequestContext request);
39      
40      /***
41       * 
42       * <p>
43       * getResponseForFragment
44       * </p>
45       * <p>
46       *  Return the HttpServletResponse to use for a given Fragment
47       *  in order to be able to capture parallel rendering portlets
48       * </p>
49       * @param fragment
50       * @param request
51       * @return
52       */
53      public HttpServletResponse getResponseForFragment( Fragment fragment, RequestContext request );
54  }