/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.container;

import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.portlet.ActionParameters;
import javax.portlet.PortletConfig;
import javax.portlet.PortletSession;
import javax.portlet.RenderParameters;
import javax.servlet.DispatcherType;
import javax.servlet.ServletContext;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


/**
 * @author <a href="mailto:ate@douma.nu">Ate Douma</a>
 * @version $Id$
 */
public interface PortletRequestContext
{
    void init(PortletConfig portletConfig, ServletContext servletContext, HttpServletRequest servletRequest,
          HttpServletResponse servletResponse, PortletResponseContext responseContext);
    PortletContainer getContainer();
    PortletConfig getPortletConfig();
    ServletContext getServletContext();
    HttpServletRequest getContainerRequest();
    HttpServletResponse getContainerResponse();
    HttpServletRequest getServletRequest();
    HttpServletResponse getServletResponse();
    PortletWindow getPortletWindow();
    
    Enumeration<String> getAttributeNames();
    Object getAttribute(String name);
    void setAttribute(String name, Object value);

    Locale getPreferredLocale();
    Cookie[] getCookies();
    Map<String, String[]> getProperties();
    PortletSession getPortletSession(boolean create);
    
    // V2 compatibility parameter methods
    
    Map<String, String[]> getParameterMap();
    Map<String, String[]> getPrivateParameterMap();
    Map<String, String[]> getPublicParameterMap();
    
    /**
     * Returns the render parameters for the portlet. V3 method.
     * @return
     */
    RenderParameters getRenderParameters();

    /**
     * Returns the action parameters for the portlet. V3 method.
     * @return
     */
    ActionParameters getActionParameters();
    
    // for render headers support
    void setRenderHeaders(String renderHeaders);
    String getRenderHeaders();
    
    // for async support
    DispatcherType getDispatcherType();
    boolean isExecutingRequestBody();
    void setExecutingRequestBody(boolean executingRequestBody);
    HttpServletRequest getAsyncServletRequest();
    void setAsyncServletRequest(HttpServletRequest asyncServletRequest);
    
    // To provide special handling during portlet request dispatcher and async dispatches
    void endDispatch();
    void startDispatch(HttpServletRequest wrappedServletRequest, Map<String, List<String>> queryParams, String phase);
    Map<String, List<String>> getQueryParams();
    String getPhase();
}