1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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 }