/**
 * 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.cache;

import javax.portlet.CacheControl;
import javax.servlet.http.HttpServletRequest;
import org.apereo.portal.portlet.om.IPortletWindowId;
import org.apereo.portal.portlet.rendering.PortletRenderResult;

/**
 * Interface defining mechanism for retrieving {@link CacheControl}s.
 */
public interface IPortletCacheControlService {

    /** @return the maximum size of cached portlet output, in bytes */
    int getCacheSizeThreshold();

    /** Get the resource request cache state for the specified portlet */
    CacheState<CachedPortletResourceData<Long>, Long> getPortletResourceState(
            HttpServletRequest request, IPortletWindowId portletWindowId);

    /** Get the render-header cache state for the specified portlet */
    CacheState<CachedPortletData<PortletRenderResult>, PortletRenderResult>
            getPortletRenderHeaderState(
                    HttpServletRequest request, IPortletWindowId portletWindowId);

    /** Get the render cache state for the specified portlet */
    CacheState<CachedPortletData<PortletRenderResult>, PortletRenderResult> getPortletRenderState(
            HttpServletRequest request, IPortletWindowId portletWindowId);

    /**
     * This method checks the {@link CacheControl} to determine if the output should be captured for
     * caching.
     *
     * @return true if the {@link CacheControl} indicates the output should be cached
     */
    boolean shouldOutputBeCached(CacheControl cacheControl);

    /**
     * Store the output of a render header request in the cache for the portlet and request. This
     * method internally will determine if the content needs to be stored in a public or private
     * scoped cache.
     */
    void cachePortletRenderHeaderOutput(
            IPortletWindowId portletWindowId,
            HttpServletRequest httpRequest,
            CacheState<CachedPortletData<PortletRenderResult>, PortletRenderResult> cacheState,
            CachedPortletData<PortletRenderResult> cachedPortletData);

    /**
     * Store the output of a render request in the cache for the portlet and request. This method
     * internally will determine if the content needs to be stored in a public or private scoped
     * cache.
     */
    void cachePortletRenderOutput(
            IPortletWindowId portletWindowId,
            HttpServletRequest httpRequest,
            CacheState<CachedPortletData<PortletRenderResult>, PortletRenderResult> cacheState,
            CachedPortletData<PortletRenderResult> cachedPortletData);

    /**
     * Store the output of a resource request in the cache for the portlet and request. This method
     * internally will determine if the content needs to be stored in a public or private scoped
     * cache.
     */
    void cachePortletResourceOutput(
            IPortletWindowId portletWindowId,
            HttpServletRequest httpRequest,
            CacheState<CachedPortletResourceData<Long>, Long> cacheState,
            CachedPortletResourceData<Long> cachedPortletResourceData);

    /**
     * Purge any {@link CachedPortletRenderData} for the portlet.
     *
     * <p>Should be called on any Action or Event Request.
     */
    boolean purgeCachedPortletData(
            IPortletWindowId portletWindowId, HttpServletRequest httpRequest);
}