1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package com.xpn.xwiki.web.sx

File SxSource.java

 

Code metrics

0
0
0
2
71
14
0
-
-
0
-

Classes

Class Line # Actions
SxSource 28 0 - 0 0
-1.0 -
SxSource.CachePolicy 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package com.xpn.xwiki.web.sx;
21   
22    /**
23    * Skin extension source. Can be a document, a resource file, or anything else.
24    *
25    * @since 1.7M2
26    * @version $Id: d98074ebf472ee81c0c6701a6b1d9d8803ac9dcd $
27    */
 
28    public interface SxSource
29    {
30    /** Cache policies available for extensions. */
 
31    enum CachePolicy
32    {
33    /**
34    * Cache for a long time.
35    *
36    * @see AbstractSxAction#LONG_CACHE_DURATION
37    */
38    LONG,
39   
40    /**
41    * Cache for a short time.
42    *
43    * @see AbstractSxAction#SHORT_CACHE_DURATION
44    */
45    SHORT,
46   
47    /**
48    * Cache for the proxy/browser's default time, It will be held in the server cache an amount of time specified
49    * in AbstractSxAction.
50    */
51    DEFAULT,
52   
53    /** Do not cache at all in server cache or in proxy/browser. */
54    FORBID
55    }
56   
57    /**
58    * @return the last date at which the extension source has been modified.
59    */
60    long getLastModifiedDate();
61   
62    /**
63    * @return the content of the extension source. For example, a javascript script for a javascript extension.
64    */
65    String getContent();
66   
67    /**
68    * @return the cache policy associated with this extension source.
69    */
70    CachePolicy getCachePolicy();
71    }