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 java.util.List;
20  
21  import org.apache.pluto.om.window.PortletWindow;
22  
23  
24  /***
25   * <h4>PortletRendererService<br />
26   * Jetspeed-2 Rendering service.</h4>
27   * <p>This service process all portlet rendering requests and interfaces with the portlet
28   * container to generate the resulting markup</p>
29   *
30   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
31   * @version $Id: $
32   */
33  public interface PortletTrackingManager
34  {
35      /***
36       *  Get the default timeout for rendering a portlet in milliseconds
37       *
38       */
39      long getDefaultPortletTimeout();
40  
41      /***
42       * Out of service limit, if a portlet entity times out past its limit (or default limit) n consecutive times,
43       *  it is taken out of service
44       *  
45       * @return
46       */
47      int getOutOfServiceLimit();
48      
49      boolean isOutOfService(PortletWindow window);
50      
51      boolean exceededTimeout(long renderTime, PortletWindow window);
52      
53      void incrementRenderTimeoutCount(PortletWindow window);
54  
55      void setExpiration(PortletWindow window, long expiration);
56      
57      void success(PortletWindow window);
58        
59      void takeOutOfService(PortletWindow window);
60      
61      void putIntoService(PortletWindow window);
62      /***
63       * 
64       * @param fullPortletNames a list of Strings of full portlet names
65       */
66      void putIntoService(List fullPortletNames);
67      
68      List getOutOfServiceList(String fullPortletName);
69      
70      List getOutOfServiceList();
71  }