01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: public interface PortletHeaderResponse {
26: /**
27: * Retrieves the header resource for this request
28: *
29: * @return a per request HeaderResource
30: */
31: HeaderResource getHeaderResource();
32:
33: /**
34: * Is request for /desktop rather than /portal
35: *
36: * @return true if request is for /desktop, false if request is for /portal
37: */
38: boolean isDesktop();
39:
40: /**
41: * Configuration data for use by HeaderResource
42: *
43: * @return an immutable Map
44: */
45: Map getHeaderConfiguration();
46:
47: /**
48: * Map containing overrides of content for header statements
49: *
50: * @return an immutable Map
51: */
52: Map getHeaderResourceRegistry();
53:
54: /**
55: * Temporary solution: get the content after calling include
56: * this will be deprecated
57: *
58: */
59: String getContent();
60:
61: /**
62: * Dispatch to a servlet or resource to generate and include the header content
63: *
64: * @param request
65: * @param response
66: * @param headerResource
67: * @return
68: * @throws PortletException
69: */
70: void include(PortletHeaderRequest request,
71: PortletHeaderResponse response, String headerResource)
72: throws PortletException;
73: }
|