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.pluto.internal;
18:
19: import org.apache.pluto.PortletContainer;
20:
21: import javax.portlet.PortletRequest;
22: import javax.portlet.PortletContext;
23: import javax.servlet.http.HttpServletRequest;
24:
25: /**
26: * The internal portlet request interface extends PortletRequest and adds
27: * some methods used by Pluto.
28: *
29: */
30: public interface InternalPortletRequest extends PortletRequest {
31:
32: /**
33: * Initializes the portlet request for use within the target context.
34: * This method ensures that the portlet utilizes resources from the
35: * <b>included</b> context, and not those from the intiating (portal)
36: * context.
37: *
38: * @param context the target portlet context.
39: * @param request the servlet request.
40: */
41: void init(PortletContext context, HttpServletRequest request);
42:
43: /**
44: * Recycle the request by rolling the underlying request
45: * back to the originating request.
46: */
47: void release();
48:
49: InternalPortletWindow getInternalPortletWindow();
50:
51: PortletContainer getPortletContainer();
52:
53: HttpServletRequest getHttpServletRequest();
54: }
|