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.portlet;
18  
19  import java.util.Map;
20  
21  import javax.portlet.PortletException;
22  
23  import org.apache.jetspeed.headerresource.HeaderResource;
24  
25  
26  public interface PortletHeaderResponse
27  {    
28      /***
29       * Retrieves the header resource for this request
30       * 
31       * @return a per request HeaderResource
32       */
33      HeaderResource getHeaderResource();
34      
35      /***
36       * Is request for /desktop rather than /portal
37       * 
38       * @return true if request is for /desktop, false if request is for /portal
39       */
40      boolean isDesktop();
41      
42      
43      /***
44       * Configuration data for use by HeaderResource
45       * 
46       * @return an immutable Map
47       */
48      Map getHeaderConfiguration();
49      
50      /***
51       * Map containing overrides of content for header statements
52       * 
53       * @return an immutable Map
54       */
55      Map getHeaderResourceRegistry();
56      
57      /***
58       * Temporary solution: get the content after calling include
59       * this will be deprecated
60       * 
61       */
62      String getContent();
63  
64      
65      /***
66       * Dispatch to a servlet or resource to generate and include the header content
67       * 
68       * @param request
69       * @param response
70       * @param headerResource
71       * @return
72       * @throws PortletException
73       */
74      void include(PortletHeaderRequest request, PortletHeaderResponse response, String headerResource) 
75          throws PortletException;
76  }