/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.portlet.container;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.pluto.container.PortletContainer;
import org.apache.pluto.container.PortletRequestContext;
import org.apache.pluto.container.PortletResponseContext;
import org.apache.pluto.container.PortletWindow;
import org.apache.pluto.container.driver.PortletServlet;
import org.apereo.portal.portlet.container.services.IPortletCookieService;
import org.apereo.portal.portlet.om.IPortletWindow;
import org.springframework.util.Assert;

/**
 * Base class for both {@link PortletRequestContext} and {@link PortletResponseContext}
 * implementations
 *
 */
public abstract class AbstractPortletContextImpl {
    protected final PortletContainer portletContainer;
    protected final HttpServletRequest containerRequest;
    protected final HttpServletResponse containerResponse;
    protected final IPortletWindow portletWindow;
    protected final IPortletCookieService portletCookieService;

    //Objects provided by the PortletServlet via the init method
    //The servlet objects are from the scope of the cross-context dispatch
    protected HttpServletRequest servletRequest;
    protected HttpServletResponse servletResponse;

    public AbstractPortletContextImpl(
            PortletContainer portletContainer,
            IPortletWindow portletWindow,
            HttpServletRequest containerRequest,
            HttpServletResponse containerResponse,
            IPortletCookieService portletCookieService) {

        Assert.notNull(portletContainer, "portletContainer cannot be null");
        Assert.notNull(containerRequest, "containerRequest cannot be null");
        Assert.notNull(containerResponse, "containerResponse cannot be null");
        Assert.notNull(portletWindow, "portletWindow cannot be null");
        Assert.notNull(portletCookieService, "portletCookieService cannot be null");

        this.portletContainer = portletContainer;
        this.containerRequest = containerRequest;
        this.containerResponse = containerResponse;
        this.portletWindow = portletWindow;
        this.portletCookieService = portletCookieService;
    }

    /**
     * @see org.apache.pluto.container.PortletRequestContext#getContainer()
     * @see org.apache.pluto.container.PortletResponseContext#getContainer()
     */
    public PortletContainer getContainer() {
        return this.portletContainer;
    }

    /**
     * @see org.apache.pluto.container.PortletRequestContext#getContainerRequest()
     * @see org.apache.pluto.container.PortletResponseContext#getContainerRequest()
     */
    public HttpServletRequest getContainerRequest() {
        return this.containerRequest;
    }

    /**
     * @see org.apache.pluto.container.PortletRequestContext#getContainerResponse()
     * @see org.apache.pluto.container.PortletResponseContext#getContainerResponse()
     */
    public HttpServletResponse getContainerResponse() {
        return this.containerResponse;
    }

    /**
     * @see org.apache.pluto.container.PortletRequestContext#getPortletWindow()
     * @see org.apache.pluto.container.PortletResponseContext#getPortletWindow()
     */
    public PortletWindow getPortletWindow() {
        return this.portletWindow.getPlutoPortletWindow();
    }

    /**
     * Called by {@link PortletServlet} after the cross context dispatch but before the portlet
     * invocation
     *
     * @see org.apache.pluto.container.PortletRequestContext#init(javax.portlet.PortletConfig,
     *     javax.servlet.ServletContext, HttpServletRequest, HttpServletResponse)
     * @see
     *     org.apache.pluto.container.PortletResponseContext#init(javax.servlet.http.HttpServletRequest,
     *     javax.servlet.http.HttpServletResponse)
     */
    public void init(HttpServletRequest servletRequest, HttpServletResponse servletResponse) {
        Assert.notNull(servletRequest, "servletRequest cannot be null");
        Assert.notNull(servletResponse, "servletResponse cannot be null");

        this.servletRequest = servletRequest;
        this.servletResponse = servletResponse;
    }

    /**
     * @see org.apache.pluto.container.PortletRequestContext#getServletRequest()
     * @see org.apache.pluto.container.PortletResponseContext#getServletRequest()
     */
    public HttpServletRequest getServletRequest() {
        return this.servletRequest;
    }

    /**
     * @see org.apache.pluto.container.PortletRequestContext#getServletResponse()
     * @see org.apache.pluto.container.PortletResponseContext#getServletResponse()
     */
    public HttpServletResponse getServletResponse() {
        return this.servletResponse;
    }
}