Clover icon

Magnolia Module Cache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:46:50 CET
  2. Package info.magnolia.module.cache.filter

File CachedEntry.java

 

Code metrics

0
0
0
1
68
13
0
-
-
0
-

Classes

Class Line # Actions
CachedEntry 48 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2008-2018 Magnolia International
3    * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10    * This file is distributed in the hope that it will be
11    * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12    * implied warranty of MERCHANTABILITY or FITNESS FOR A
13    * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14    * Redistribution, except as permitted by whichever of the GPL
15    * or MNA you select, is prohibited.
16    *
17    * 1. For the GPL license (GPL), you can redistribute and/or
18    * modify this file under the terms of the GNU General
19    * Public License, Version 3, as published by the Free Software
20    * Foundation. You should have received a copy of the GNU
21    * General Public License, Version 3 along with this program;
22    * if not, write to the Free Software Foundation, Inc., 51
23    * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24    *
25    * 2. For the Magnolia Network Agreement (MNA), this file
26    * and the accompanying materials are made available under the
27    * terms of the MNA which accompanies this distribution, and
28    * is available at http://www.magnolia-cms.com/mna.html
29    *
30    * Any modifications to this file must keep this entire header
31    * intact.
32    *
33    */
34    package info.magnolia.module.cache.filter;
35   
36    import java.io.IOException;
37    import java.io.Serializable;
38   
39    import javax.servlet.FilterChain;
40    import javax.servlet.ServletException;
41    import javax.servlet.http.HttpServletRequest;
42    import javax.servlet.http.HttpServletResponse;
43   
44    /**
45    * A cached entry used to store content produced by the filter chain. The cache can be replayed.
46    * @version $Revision: $ ($Author: $)
47    */
 
48    public interface CachedEntry extends Serializable {
49   
50    /**
51    * @param chain a cache entry might want to delegate to the filter chain, see {@link DelegatingBlobCachedEntry#replay(HttpServletRequest, HttpServletResponse, FilterChain)}
52    */
53    void replay(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException;
54   
55    /**
56    * Entry might be required to produce url used to create it in the first place.
57    * @return URL that triggered cache entry creation.
58    */
59    String getOriginalURL();
60   
61    /**
62    * Produce last modification date of the cache entry. If no other time can be discerned, the time of entry creation should be returned.
63    * @return time when cached entry was last modified. This time should reflect real modification time of the cached content.
64    */
65    long getLastModificationTime();
66   
67    int getTimeToLiveInSeconds();
68    }