trunk/pluto-container/src/main/java/org/apache/pluto/internal/InternalPortletRequest.java

/*
 * Copyright 2003,2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.pluto.internal;

import org.apache.pluto.PortletContainer;

import javax.portlet.PortletRequest;
import javax.portlet.PortletContext;
import javax.servlet.http.HttpServletRequest;

/**
 * The internal portlet request interface extends PortletRequest and adds
 * some methods used by Pluto.
 * 
 * @author <a href="mailto:ddewolf@apache.org">David H. DeWolf</a>
 * @author <a href="mailto:zheng@apache.org">ZHENG Zhong</a>
 */
public interface InternalPortletRequest extends PortletRequest {

    /**
     * Initializes the portlet request for use within the target context.
     * This method ensures that the portlet utilizes resources from the
     * <b>included</b> context, and not those from the intiating (portal)
     * context.
     * 
     * @param context  the target portlet context.
     * @param request  the servlet request.
     */
    public void init(PortletContext context, HttpServletRequest request);

    /**
     * Recycle the request by rolling the underlying request
     * back to the originating request.
     */
    public void release();

    public InternalPortletWindow getInternalPortletWindow();

    public PortletContainer getPortletContainer();

    public HttpServletRequest getHttpServletRequest();
    
}