From: Kai Moritz Date: Thu, 23 Jun 2011 18:05:46 +0000 (+0200) Subject: Unterprojekt Utils von Fotos in eigenständiges Projekt Juplo verwandelt X-Git-Tag: 1.0~3 X-Git-Url: https://juplo.de/gitweb/?p=percentcodec;a=commitdiff_plain;h=f3ec05942f7f5cbf3417bf71b5727b9007739bfd Unterprojekt Utils von Fotos in eigenständiges Projekt Juplo verwandelt --- diff --git a/cachecontrol/pom.xml b/cachecontrol/pom.xml new file mode 100644 index 00000000..f7863064 --- /dev/null +++ b/cachecontrol/pom.xml @@ -0,0 +1,30 @@ + + + + 4.0.0 + + + de.halbekunst + juplo + 1.0-SNAPSHOT + + + ${pom.parent.artifactId}-cachecontrol + Juplo - CacheControl + + + + org.springframework + spring-webmvc + ${springframework.version} + + + javax.servlet + servlet-api + ${servlet-api.version} + provided + + + + diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlInterceptor.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlInterceptor.java new file mode 100644 index 00000000..aeda87a6 --- /dev/null +++ b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlInterceptor.java @@ -0,0 +1,189 @@ +package de.halbekunst.juplo.cachecontrol; + +import java.util.Date; +import java.util.HashMap; +import java.util.Map; +import java.util.Map.Entry; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.web.servlet.HandlerInterceptor; +import org.springframework.web.servlet.ModelAndView; + +/** + * + * @author kai + */ +public class CacheControlInterceptor implements HandlerInterceptor { + private final static Logger log = LoggerFactory.getLogger(CacheControlInterceptor.class); + + public static final String HEADER_DATE = "Date"; + public static final String HEADER_CACHE_CONTROL = "Cache-Control"; + public static final String HEADER_LAST_MODIFIED = "Last-Modified"; + public static final String HEADER_ETAG = "ETag"; + public static final String HEADER_EXPIRES = "Expires"; + public static final String HEADER_PRAGMA = "Pragma"; + public static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since"; + public static final String HEADER_IF_NONE_MATCH = "If-None-Match"; + + + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { + try { + Cacheable cacheable = (Cacheable)handler; + + long now = System.currentTimeMillis(); + + /** + * Alle Antworten (insbesondere auch 304) sollen nach dem {@plainlink + * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18 RFC 2616, + * Abschnitt 14.18} einen Date-Header enthalten + */ + response.setDateHeader(HEADER_DATE, now); + + /** Prüfen, ob der Handler willig ist, den Request zu verarbeiten */ + if (!cacheable.accepts(request)) { + response.sendError(HttpServletResponse.SC_NOT_FOUND); + return false; + } + + /** Nichts weiter unternehmen, wenn der Handler dies nicht will */ + if (!cacheable.isGenerateCacheHeaders(request)) + return true; + + int cacheSeconds = cacheable.getCacheSeconds(request); + if (cacheSeconds == 0) { + response.setDateHeader(HEADER_DATE, now); + response.setDateHeader(HEADER_EXPIRES, 0); + response.addHeader(HEADER_PRAGMA, "no-cache"); + response.addHeader(HEADER_CACHE_CONTROL, "private"); + response.addHeader(HEADER_CACHE_CONTROL, "no-cache"); + response.addHeader(HEADER_CACHE_CONTROL, "no-store"); + response.addHeader(HEADER_CACHE_CONTROL, "max-age=0"); + response.addHeader(HEADER_CACHE_CONTROL, "s-max-age=0"); + return true; + } + + long ifModifiedSince = -1; + try { + ifModifiedSince = request.getDateHeader(HEADER_IF_MODIFIED_SINCE); + } + catch (Exception e) { + log.error("Exception while fetching If-Modified-Since: {}", e); + } + + long lastModified = cacheable.getLastModified(request); + + /** + * Sicherstellen, dass der Wert keine Millisekunden enthält, da die + * Zeitangabe aus dem Modified-Since-Header keine Millisekunden enthalten + * kann und der Test unten dann stets fehlschlagen würde! + */ + lastModified = lastModified - (lastModified % 1000); + + String ifNoneMatch = request.getHeader(HEADER_IF_NONE_MATCH); + String eTag = cacheable.getETag(request); + + /** + * 304-Antworten sollen nach dem {@plainlink + * http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5 RFC + * 2616, Abschnitt 10.3.5} einen ETag-Header enthalten, wenn auch die + * 200-Antwort einen enthalten hätte. + */ + if (eTag != null) { + response.setHeader(HEADER_ETAG, eTag); + } + + + if (ifModifiedSince >= lastModified && lastModified > 0) { + /** + * request.getDateHeader liefert die Zeit als long, oder -1, wenn der + * Header nicht existiert. D.h., wenn "If-Modified-Since" nicht gesetzt + * ist, wird die komplette Seite ausgeliefert. + * Der zusätzliche Test, ob lastModified größer 0 ist, ist nötig, um + * Fehler auszuschließen, wenn die Implementierung von Cachable + * negative Werte für Last-Modified zurückliefert. + */ + if (log.isDebugEnabled()) + log.debug("Not modified since {}: {}", new Date(ifModifiedSince), request.getRequestURI()); + + if (ifNoneMatch == null) { + /** Neue Anfrage oder HTTP/1.0 Client! */ + log.debug("ETag nicht gesetzt: 304 {}", request.getRequestURI()); + response.setStatus(HttpServletResponse.SC_NOT_MODIFIED); + return false; + } + } + + if (ifNoneMatch != null && ifNoneMatch.equals(eTag)) { + log.debug("{}: ETag {} not changed -> 304 ", request.getRequestURI(), ifNoneMatch); + response.setStatus(HttpServletResponse.SC_NOT_MODIFIED); + return false; + } + + /** HTTP/1.1-Caching-Header richtig setzen!! */ + response.setDateHeader(HEADER_LAST_MODIFIED, lastModified); + + /** Cache-Control für HTTP/1.1-Clients generieren */ + Map cacheControl = new HashMap(cacheable.getCacheControl(request)); + + /** + * Wenn eins JSESSIONID in der URL enthalten ist, darf die Anfrage nur vom + * Browser gecached werden! + */ + if (request.isRequestedSessionIdFromURL()) { + cacheSeconds = 0; + cacheControl.put("private", null); + } + + if (cacheControl.containsKey("private")) { + /** + * HTTP/1.0 Caches davon abhalten, die Ressource zu cachen (vgl.: RFC + * 2616, {@plainlink + * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 + * Abschnitt 14.9.3} und {@plainlink + * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32 + * Abschnitt 14.32}) + */ + response.setDateHeader(HEADER_EXPIRES, 0l); + response.addHeader(HEADER_PRAGMA, "no-cache"); + } + else { + /** + * Hier muss nicht geprüft werden, ob cacheSeconds > 0 gilt, da in diesem + * Fall oben bereits No-Cache-Header generiert und false + * zurückgeliefert werden! + * + * Den Wert als max-age zu den Schlüssel-Wert-Paaren für den + * Cache-Control-Header hinzufügen und einen entsprechenden + * Expires-Header für HTTP/1.0-Clients setzen. + */ + cacheControl.put("max-age", Integer.toString(cacheSeconds)); + response.setDateHeader(HEADER_EXPIRES, (now + cacheSeconds * 1000)); + } + + StringBuilder builder = new StringBuilder(); + for (Entry entry : cacheControl.entrySet()) { + builder.setLength(0); + builder.append(entry.getKey()); + if (entry.getValue() != null) { + builder.append('='); + builder.append(entry.getValue()); + } + response.addHeader(HEADER_CACHE_CONTROL, builder.toString()); + } + + return true; + } + catch (ClassCastException e) { + return true; + } + } + + @Override + public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {} + + @Override + public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {} +} diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/Cacheable.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/Cacheable.java new file mode 100644 index 00000000..75ac1102 --- /dev/null +++ b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/Cacheable.java @@ -0,0 +1,153 @@ +package de.halbekunst.juplo.cachecontrol; + + +import java.util.Map; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + + +/** + * Wenn ein Handler (i.A. eine Impelementierung von {@Controller}), + * dieses Interface implementiert, dann schreibt + * {@link CachingInterceptor} HTTP/1.1-Caching-Header nach + * {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html RFC 2616} + * in den Response. + * + * @see CachingInterceptor + * @author kai + */ +public interface Cacheable { + public boolean accepts(HttpServletRequest request); + + /** + * Wenn die Methode false zurückliefert, werden von + * {@link CachingDispatcherServlet#isRessourceModified(HttpServletRequest, HttpServletResponse, Cacheable)} + * keinerlei HTTP/1.1-Cache-Header in den Response eingebaut. + *

+ * Über diese Methode kann z.B. gesteuert werden, dass für eine bestimmte + * HTTP-Methode (z.B. POST) keine Cache-Header generiert werden. + * + * @see CachingDispatcherServlet + * @param request + * Der aktuelle HTTP-Request + * @return true, wenn Caching-Header in den Response geschrieben + * werden sollen, sonst false. + * @throws IllegalArgumentException + * Wenn zu dem Request keine Ressource existiert. + */ + public boolean isGenerateCacheHeaders(HttpServletRequest request) throws IllegalArgumentException; + + /** + * Diese Methode ermöglicht eine einfache, zentrale Steuerung des + * Caching-Verhaltens. + *

    + *
  • Wenn die Methode den Wert 0 (oder einen anderen Wert + * kleiner 1) zurückliefert, werden Cache-Header erzeugt, die das + * Cachen der Antwort für HTTP/1.0 und HTTP/1.1 vollständig untersagen,
    • + *
  • Wenn die Methode einen Wert größer 0 zurückliefert, wird + * ein für HTTP/1.0-Clients ein Expires-Header generiert und für + * HTTP/1.1-Clients ein Cache-Control-Header mit einem + * entsprechenden max-age-Eintrag. Dies reicht in Kombination mit + * einem sinnvollen Rückgabewert der Methode + * {@link #getLastModified(javax.servlet.http.HttpServletRequest)} vollständig + * für ein einfaches Caching aus.
    • + *
+ *

+ * Zu beachten: Wenn die Methode + * {@link #getCacheControl(javax.servlet.http.HttpServletRequest)} weitere + * Schlüssel-Wert-Paare für den Cache-Control-Header liefert, + * werden diese ergänzt. Wenn in der Rückgabe ein Wert für + * max-age enthalten ist, wir er allerdings von dem durch diese + * Methode vorgegebenen Wert überschrieben! + * + * @see #getLastModified(javax.servlet.http.HttpServletRequest) + * @see #getCacheControl(javax.servlet.http.HttpServletRequest) + * @param request + * Der aktuelle HTTP-Request + * @return Die gewünschte Cache-Zeit in Sekunden, oder 0, wenn + * Caching aktiv unterbunden werden soll bzw. einen Wert kleiner + * 0, wenn kein Expires-Header generiert + * werden soll. + * @throws IllegalArgumentException + * Wenn zu dem Request keine Ressource existiert. + */ + public int getCacheSeconds(HttpServletRequest request) throws IllegalArgumentException; + + /** + * Zeitpunkt, zu dem die Ressource zuletzt verändert wurde. Erwartet wird eine + * Zeitangabe in Millisekunden seit dem Unix-0-Zeitpunkt, wie sie von + * {@link HttpServletResponse#setDateHeader(String, long)} erwartet wird. + *

+ * Zu beachten: + *

    + *
  • Diese Methode wird nicht aufgerufen, wenn + * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} + * 0 liefert.
    • + *
+ * + * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest) + * @param request + * Der aktuelle HTTP-Request + * @return Zeitstempel, zu dem die Ressource zuletzt modifiziert wurde. + * @throws IllegalArgumentException + * Wenn zu dem Request keine Ressource existiert. + */ + public long getLastModified(HttpServletRequest request) throws IllegalArgumentException; + + /** + * Frei wählbares ETag nach {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19 RFC 2616, + * Abschnitt 14.19 ETag}. Der ETag wird unverändert übernommen und muss den + * Bedingungen aus dem RFC 2616 entsprechen. Beispiele für erlaubte Werte: + *
    + *
  • "24afh2w3848adf" + *
  • W/"839482" + *
  • "" + *
+ * Merke: Der wert ist immer in doppelte Anführungszeichen + * einzuschließen! + *

+ * Zu beachten: + *

    + *
  • Diese Methode wird nicht aufgerufen, wenn + * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} + * 0 liefert.
    • + *
+ * + * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest) + * @param request + * Der aktuelle HTTP-Request + * @return Das zu verwendende ETag, oder null, wenn der Header + * nicht generiert werden soll. + * @throws IllegalArgumentException + * Wenn zu dem Request keine Ressource existiert. + */ + public String getETag(HttpServletRequest request) throws IllegalArgumentException; + + /** + * Diese Methode liefert eine Map mit Schlüssel-Wert-Paaren für den + * HTTP/1.1-Header Cache-Control (s. {@plainlink + * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 RFC2616, + * Abschnitt 14.9.3}). + *

+ * Zu beachten: + *

    + *
  • Die Methode darf nie null zurückliefern!
    • + *
  • Ein Wert für den Schlüssel max-age wird überschrieben, + * wenn die Methode + * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} einen Wert + * größer 0 zurückliefert.
    • + *
  • Diese Methode wird nicht aufgerufen, wenn + * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} + * 0 liefert.
    • + *
+ * + * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest) + * @param request + * Der aktuelle HTTP-Request + * @return Eine Map mit den Schlüssel-Wert-Paaren für den + * Cache-Control-Header. + * @throws IllegalArgumentException + * Wenn zu dem Request keine Ressource existiert. + */ + public Map getCacheControl(HttpServletRequest request) throws IllegalArgumentException; +} diff --git a/pom.xml b/pom.xml index 7fa47c45..4913a0ef 100644 --- a/pom.xml +++ b/pom.xml @@ -5,9 +5,9 @@ 4.0.0 de.halbekunst - fotos + juplo 1.0-SNAPSHOT - Fotos + Juplo pom http://www.halbekunst.de @@ -24,7 +24,7 @@ - utils + cachecontrol diff --git a/utils/cachecontrol/pom.xml b/utils/cachecontrol/pom.xml deleted file mode 100644 index ea6d6da1..00000000 --- a/utils/cachecontrol/pom.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - 4.0.0 - - - de.halbekunst - utils - 1.0-SNAPSHOT - - - ${pom.parent.artifactId}-cachecontrol - Utils - CacheControl - - - - org.springframework - spring-webmvc - ${springframework.version} - - - javax.servlet - servlet-api - ${servlet-api.version} - provided - - - - diff --git a/utils/cachecontrol/src/main/java/de/halbekunst/utils/cachecontrol/CacheControlInterceptor.java b/utils/cachecontrol/src/main/java/de/halbekunst/utils/cachecontrol/CacheControlInterceptor.java deleted file mode 100644 index 088e775c..00000000 --- a/utils/cachecontrol/src/main/java/de/halbekunst/utils/cachecontrol/CacheControlInterceptor.java +++ /dev/null @@ -1,189 +0,0 @@ -package de.halbekunst.utils.cachecontrol; - -import java.util.Date; -import java.util.HashMap; -import java.util.Map; -import java.util.Map.Entry; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.web.servlet.HandlerInterceptor; -import org.springframework.web.servlet.ModelAndView; - -/** - * - * @author kai - */ -public class CacheControlInterceptor implements HandlerInterceptor { - private final static Logger log = LoggerFactory.getLogger(CacheControlInterceptor.class); - - public static final String HEADER_DATE = "Date"; - public static final String HEADER_CACHE_CONTROL = "Cache-Control"; - public static final String HEADER_LAST_MODIFIED = "Last-Modified"; - public static final String HEADER_ETAG = "ETag"; - public static final String HEADER_EXPIRES = "Expires"; - public static final String HEADER_PRAGMA = "Pragma"; - public static final String HEADER_IF_MODIFIED_SINCE = "If-Modified-Since"; - public static final String HEADER_IF_NONE_MATCH = "If-None-Match"; - - - @Override - public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { - try { - Cacheable cacheable = (Cacheable)handler; - - long now = System.currentTimeMillis(); - - /** - * Alle Antworten (insbesondere auch 304) sollen nach dem {@plainlink - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18 RFC 2616, - * Abschnitt 14.18} einen Date-Header enthalten - */ - response.setDateHeader(HEADER_DATE, now); - - /** Prüfen, ob der Handler willig ist, den Request zu verarbeiten */ - if (!cacheable.accepts(request)) { - response.sendError(HttpServletResponse.SC_NOT_FOUND); - return false; - } - - /** Nichts weiter unternehmen, wenn der Handler dies nicht will */ - if (!cacheable.isGenerateCacheHeaders(request)) - return true; - - int cacheSeconds = cacheable.getCacheSeconds(request); - if (cacheSeconds == 0) { - response.setDateHeader(HEADER_DATE, now); - response.setDateHeader(HEADER_EXPIRES, 0); - response.addHeader(HEADER_PRAGMA, "no-cache"); - response.addHeader(HEADER_CACHE_CONTROL, "private"); - response.addHeader(HEADER_CACHE_CONTROL, "no-cache"); - response.addHeader(HEADER_CACHE_CONTROL, "no-store"); - response.addHeader(HEADER_CACHE_CONTROL, "max-age=0"); - response.addHeader(HEADER_CACHE_CONTROL, "s-max-age=0"); - return true; - } - - long ifModifiedSince = -1; - try { - ifModifiedSince = request.getDateHeader(HEADER_IF_MODIFIED_SINCE); - } - catch (Exception e) { - log.error("Exception while fetching If-Modified-Since: {}", e); - } - - long lastModified = cacheable.getLastModified(request); - - /** - * Sicherstellen, dass der Wert keine Millisekunden enthält, da die - * Zeitangabe aus dem Modified-Since-Header keine Millisekunden enthalten - * kann und der Test unten dann stets fehlschlagen würde! - */ - lastModified = lastModified - (lastModified % 1000); - - String ifNoneMatch = request.getHeader(HEADER_IF_NONE_MATCH); - String eTag = cacheable.getETag(request); - - /** - * 304-Antworten sollen nach dem {@plainlink - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5 RFC - * 2616, Abschnitt 10.3.5} einen ETag-Header enthalten, wenn auch die - * 200-Antwort einen enthalten hätte. - */ - if (eTag != null) { - response.setHeader(HEADER_ETAG, eTag); - } - - - if (ifModifiedSince >= lastModified && lastModified > 0) { - /** - * request.getDateHeader liefert die Zeit als long, oder -1, wenn der - * Header nicht existiert. D.h., wenn "If-Modified-Since" nicht gesetzt - * ist, wird die komplette Seite ausgeliefert. - * Der zusätzliche Test, ob lastModified größer 0 ist, ist nötig, um - * Fehler auszuschließen, wenn die Implementierung von Cachable - * negative Werte für Last-Modified zurückliefert. - */ - if (log.isDebugEnabled()) - log.debug("Not modified since {}: {}", new Date(ifModifiedSince), request.getRequestURI()); - - if (ifNoneMatch == null) { - /** Neue Anfrage oder HTTP/1.0 Client! */ - log.debug("ETag nicht gesetzt: 304 {}", request.getRequestURI()); - response.setStatus(HttpServletResponse.SC_NOT_MODIFIED); - return false; - } - } - - if (ifNoneMatch != null && ifNoneMatch.equals(eTag)) { - log.debug("{}: ETag {} not changed -> 304 ", request.getRequestURI(), ifNoneMatch); - response.setStatus(HttpServletResponse.SC_NOT_MODIFIED); - return false; - } - - /** HTTP/1.1-Caching-Header richtig setzen!! */ - response.setDateHeader(HEADER_LAST_MODIFIED, lastModified); - - /** Cache-Control für HTTP/1.1-Clients generieren */ - Map cacheControl = new HashMap(cacheable.getCacheControl(request)); - - /** - * Wenn eins JSESSIONID in der URL enthalten ist, darf die Anfrage nur vom - * Browser gecached werden! - */ - if (request.isRequestedSessionIdFromURL()) { - cacheSeconds = 0; - cacheControl.put("private", null); - } - - if (cacheControl.containsKey("private")) { - /** - * HTTP/1.0 Caches davon abhalten, die Ressource zu cachen (vgl.: RFC - * 2616, {@plainlink - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 - * Abschnitt 14.9.3} und {@plainlink - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32 - * Abschnitt 14.32}) - */ - response.setDateHeader(HEADER_EXPIRES, 0l); - response.addHeader(HEADER_PRAGMA, "no-cache"); - } - else { - /** - * Hier muss nicht geprüft werden, ob cacheSeconds > 0 gilt, da in diesem - * Fall oben bereits No-Cache-Header generiert und false - * zurückgeliefert werden! - * - * Den Wert als max-age zu den Schlüssel-Wert-Paaren für den - * Cache-Control-Header hinzufügen und einen entsprechenden - * Expires-Header für HTTP/1.0-Clients setzen. - */ - cacheControl.put("max-age", Integer.toString(cacheSeconds)); - response.setDateHeader(HEADER_EXPIRES, (now + cacheSeconds * 1000)); - } - - StringBuilder builder = new StringBuilder(); - for (Entry entry : cacheControl.entrySet()) { - builder.setLength(0); - builder.append(entry.getKey()); - if (entry.getValue() != null) { - builder.append('='); - builder.append(entry.getValue()); - } - response.addHeader(HEADER_CACHE_CONTROL, builder.toString()); - } - - return true; - } - catch (ClassCastException e) { - return true; - } - } - - @Override - public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {} - - @Override - public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {} -} diff --git a/utils/cachecontrol/src/main/java/de/halbekunst/utils/cachecontrol/Cacheable.java b/utils/cachecontrol/src/main/java/de/halbekunst/utils/cachecontrol/Cacheable.java deleted file mode 100644 index c24e79fc..00000000 --- a/utils/cachecontrol/src/main/java/de/halbekunst/utils/cachecontrol/Cacheable.java +++ /dev/null @@ -1,153 +0,0 @@ -package de.halbekunst.utils.cachecontrol; - - -import java.util.Map; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - - -/** - * Wenn ein Handler (i.A. eine Impelementierung von {@Controller}), - * dieses Interface implementiert, dann schreibt - * {@link CachingInterceptor} HTTP/1.1-Caching-Header nach - * {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html RFC 2616} - * in den Response. - * - * @see CachingInterceptor - * @author kai - */ -public interface Cacheable { - public boolean accepts(HttpServletRequest request); - - /** - * Wenn die Methode false zurückliefert, werden von - * {@link CachingDispatcherServlet#isRessourceModified(HttpServletRequest, HttpServletResponse, Cacheable)} - * keinerlei HTTP/1.1-Cache-Header in den Response eingebaut. - *

- * Über diese Methode kann z.B. gesteuert werden, dass für eine bestimmte - * HTTP-Methode (z.B. POST) keine Cache-Header generiert werden. - * - * @see CachingDispatcherServlet - * @param request - * Der aktuelle HTTP-Request - * @return true, wenn Caching-Header in den Response geschrieben - * werden sollen, sonst false. - * @throws IllegalArgumentException - * Wenn zu dem Request keine Ressource existiert. - */ - public boolean isGenerateCacheHeaders(HttpServletRequest request) throws IllegalArgumentException; - - /** - * Diese Methode ermöglicht eine einfache, zentrale Steuerung des - * Caching-Verhaltens. - *

    - *
  • Wenn die Methode den Wert 0 (oder einen anderen Wert - * kleiner 1) zurückliefert, werden Cache-Header erzeugt, die das - * Cachen der Antwort für HTTP/1.0 und HTTP/1.1 vollständig untersagen,
    • - *
  • Wenn die Methode einen Wert größer 0 zurückliefert, wird - * ein für HTTP/1.0-Clients ein Expires-Header generiert und für - * HTTP/1.1-Clients ein Cache-Control-Header mit einem - * entsprechenden max-age-Eintrag. Dies reicht in Kombination mit - * einem sinnvollen Rückgabewert der Methode - * {@link #getLastModified(javax.servlet.http.HttpServletRequest)} vollständig - * für ein einfaches Caching aus.
    • - *
- *

- * Zu beachten: Wenn die Methode - * {@link #getCacheControl(javax.servlet.http.HttpServletRequest)} weitere - * Schlüssel-Wert-Paare für den Cache-Control-Header liefert, - * werden diese ergänzt. Wenn in der Rückgabe ein Wert für - * max-age enthalten ist, wir er allerdings von dem durch diese - * Methode vorgegebenen Wert überschrieben! - * - * @see #getLastModified(javax.servlet.http.HttpServletRequest) - * @see #getCacheControl(javax.servlet.http.HttpServletRequest) - * @param request - * Der aktuelle HTTP-Request - * @return Die gewünschte Cache-Zeit in Sekunden, oder 0, wenn - * Caching aktiv unterbunden werden soll bzw. einen Wert kleiner - * 0, wenn kein Expires-Header generiert - * werden soll. - * @throws IllegalArgumentException - * Wenn zu dem Request keine Ressource existiert. - */ - public int getCacheSeconds(HttpServletRequest request) throws IllegalArgumentException; - - /** - * Zeitpunkt, zu dem die Ressource zuletzt verändert wurde. Erwartet wird eine - * Zeitangabe in Millisekunden seit dem Unix-0-Zeitpunkt, wie sie von - * {@link HttpServletResponse#setDateHeader(String, long)} erwartet wird. - *

- * Zu beachten: - *

    - *
  • Diese Methode wird nicht aufgerufen, wenn - * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} - * 0 liefert.
    • - *
- * - * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest) - * @param request - * Der aktuelle HTTP-Request - * @return Zeitstempel, zu dem die Ressource zuletzt modifiziert wurde. - * @throws IllegalArgumentException - * Wenn zu dem Request keine Ressource existiert. - */ - public long getLastModified(HttpServletRequest request) throws IllegalArgumentException; - - /** - * Frei wählbares ETag nach {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19 RFC 2616, - * Abschnitt 14.19 ETag}. Der ETag wird unverändert übernommen und muss den - * Bedingungen aus dem RFC 2616 entsprechen. Beispiele für erlaubte Werte: - *
    - *
  • "24afh2w3848adf" - *
  • W/"839482" - *
  • "" - *
- * Merke: Der wert ist immer in doppelte Anführungszeichen - * einzuschließen! - *

- * Zu beachten: - *

    - *
  • Diese Methode wird nicht aufgerufen, wenn - * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} - * 0 liefert.
    • - *
- * - * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest) - * @param request - * Der aktuelle HTTP-Request - * @return Das zu verwendende ETag, oder null, wenn der Header - * nicht generiert werden soll. - * @throws IllegalArgumentException - * Wenn zu dem Request keine Ressource existiert. - */ - public String getETag(HttpServletRequest request) throws IllegalArgumentException; - - /** - * Diese Methode liefert eine Map mit Schlüssel-Wert-Paaren für den - * HTTP/1.1-Header Cache-Control (s. {@plainlink - * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 RFC2616, - * Abschnitt 14.9.3}). - *

- * Zu beachten: - *

    - *
  • Die Methode darf nie null zurückliefern!
    • - *
  • Ein Wert für den Schlüssel max-age wird überschrieben, - * wenn die Methode - * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} einen Wert - * größer 0 zurückliefert.
    • - *
  • Diese Methode wird nicht aufgerufen, wenn - * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} - * 0 liefert.
    • - *
- * - * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest) - * @param request - * Der aktuelle HTTP-Request - * @return Eine Map mit den Schlüssel-Wert-Paaren für den - * Cache-Control-Header. - * @throws IllegalArgumentException - * Wenn zu dem Request keine Ressource existiert. - */ - public Map getCacheControl(HttpServletRequest request) throws IllegalArgumentException; -} diff --git a/utils/pom.xml b/utils/pom.xml deleted file mode 100644 index 1feaad13..00000000 --- a/utils/pom.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - - 4.0.0 - - - de.halbekunst - fotos - 1.0-SNAPSHOT - - - utils - Utils - pom - - - cachecontrol - - -