CacheControl so umgebaut, dass es sich über Annotationen einbinden lässt
authorKai Moritz <kai@coolibri.de>
Sat, 12 Nov 2011 16:58:38 +0000 (17:58 +0100)
committerKai Moritz <kai@coolibri.de>
Sat, 28 Jan 2012 12:03:30 +0000 (13:03 +0100)
12 files changed:
cachecontrol/pom.xml
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlFilter.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlInterceptor.java
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/Cacheable.java [deleted file]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/Accepts.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/CacheControl.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/CacheSeconds.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/Cacheable.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/ETag.java [new file with mode: 0644]
cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/LastModified.java [new file with mode: 0644]
pom.xml

index 0db7fde..fb5f79e 100644 (file)
@@ -7,7 +7,7 @@
   <parent>
     <groupId>de.halbekunst</groupId>
     <artifactId>juplo</artifactId>
-    <version>1.0.1</version>
+    <version>2.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>${pom.parent.artifactId}-cachecontrol</artifactId>
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControl.java
new file mode 100644 (file)
index 0000000..07f4c58
--- /dev/null
@@ -0,0 +1,481 @@
+package de.halbekunst.juplo.cachecontrol;
+
+import de.halbekunst.juplo.cachecontrol.annotations.CacheSeconds;
+import de.halbekunst.juplo.cachecontrol.annotations.Accepts;
+import de.halbekunst.juplo.cachecontrol.annotations.LastModified;
+import de.halbekunst.juplo.cachecontrol.annotations.ETag;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Date;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.TreeMap;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ *
+ * @author kai
+ */
+public class CacheControl {
+  private final static Logger log = LoggerFactory.getLogger(CacheControl.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";
+
+  private static final ThreadLocal<CacheMethodHandle> tl = new ThreadLocal<CacheMethodHandle>();
+
+  private Integer defaultCacheSeconds;
+  private Long defaultLastModified;
+
+
+  public void init(Object handler) throws Exception {
+    if (CacheControl.tl.get() == null)
+      CacheControl.tl.set(new ReflectionCacheMethodHandle(handler));
+  }
+
+  public boolean decorate(
+      HttpServletRequest request,
+      HttpServletResponse response,
+      Object handler
+      ) throws Exception
+  {
+    try {
+    CacheMethodHandle controller = CacheControl.tl.get();
+
+    /** Doppelte Ausführung verhindern... */
+    if (controller == null) {
+      /** Dekoration wurde bereits durchgeführt! */
+      return true;
+    }
+
+    /**
+     * 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, controller.getTimestamp());
+
+    /** Besondere Maßnahmen für besondere HTTP-Status-Codes ?!? */
+    int status = controller.accepts(request);
+    switch (status) {
+      case HttpServletResponse.SC_OK: // 200
+      case HttpServletResponse.SC_NO_CONTENT: // 204
+      case HttpServletResponse.SC_PARTIAL_CONTENT: // 206
+        /** Normale Antwort! Antwort dekorieren... */
+        break;
+      case HttpServletResponse.SC_BAD_REQUEST: // 400
+      case HttpServletResponse.SC_UNAUTHORIZED: // 401
+      case HttpServletResponse.SC_PAYMENT_REQUIRED: // 402
+      case HttpServletResponse.SC_FORBIDDEN: // 403
+      case HttpServletResponse.SC_NOT_FOUND: // 404
+      case HttpServletResponse.SC_METHOD_NOT_ALLOWED: // 405
+      case HttpServletResponse.SC_NOT_ACCEPTABLE: // 406
+      case HttpServletResponse.SC_PROXY_AUTHENTICATION_REQUIRED: // 407
+      case HttpServletResponse.SC_REQUEST_TIMEOUT: // 408
+      case HttpServletResponse.SC_CONFLICT: // 409
+      case HttpServletResponse.SC_GONE: // 410
+      case HttpServletResponse.SC_LENGTH_REQUIRED: // 411
+      case HttpServletResponse.SC_PRECONDITION_FAILED: // 412
+      case HttpServletResponse.SC_REQUEST_ENTITY_TOO_LARGE: // 413
+      case HttpServletResponse.SC_REQUEST_URI_TOO_LONG: // 414
+      case HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE: // 415
+      case HttpServletResponse.SC_REQUESTED_RANGE_NOT_SATISFIABLE: // 416
+      case HttpServletResponse.SC_INTERNAL_SERVER_ERROR: // 500
+      case HttpServletResponse.SC_NOT_IMPLEMENTED: // 501
+      case HttpServletResponse.SC_SERVICE_UNAVAILABLE: // 503
+      case HttpServletResponse.SC_HTTP_VERSION_NOT_SUPPORTED: // 505
+        /**
+         * Ein Fehlercode kann stellvertretend für den Handler gesendet werden,
+         * da im Fehlerfall eh keine weiteren Daten ausgegeben werden!
+         */
+        response.sendError(status);
+        return true;
+      default:
+        /**
+         * Es ist nicht klar, was der Handler noch machen wird/muss:
+         * Antwort nicht dekorieren und Kontroller an den Handler übergeben...
+         */
+        return false;
+    }
+
+    String url = null;
+    if (log.isDebugEnabled()) {
+      if (request.getQueryString() == null) {
+        url = request.getRequestURI();
+      }
+      else {
+        StringBuilder builder = new StringBuilder();
+        builder.append(request.getRequestURI());
+        builder.append('?');
+        builder.append(request.getQueryString());
+        url = builder.toString();
+      }
+    }
+
+    int cacheSeconds = controller.getCacheSeconds(request);
+    if (cacheSeconds < 1) {
+      log.debug("{}: caching disabled!", url);
+      response.setDateHeader(HEADER_DATE, controller.getTimestamp());
+      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 = controller.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 = controller.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 {}", url, new Date(ifModifiedSince));
+
+      if (ifNoneMatch == null) {
+        /** Neue Anfrage oder HTTP/1.0 Client! */
+        log.debug("{}: ETag nicht gesetzt -> 304", url);
+        response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
+        return false;
+      }
+    }
+
+    if (ifNoneMatch != null && ifNoneMatch.equals(eTag)) {
+      log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
+      response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
+      return false;
+    }
+
+
+    log.debug("{}: first up!", url);
+
+    /** HTTP/1.1-Caching-Header richtig setzen!! */
+    response.setDateHeader(HEADER_LAST_MODIFIED, lastModified);
+
+    /** Cache-Control für HTTP/1.1-Clients generieren */
+    Map<String, String> cacheControl = new TreeMap<String, String>();
+
+    /**
+     * Wenn eins JSESSIONID in der URL enthalten ist, darf die Anfrage nur vom
+     * Browser gecached werden!
+     */
+    if (request.isRequestedSessionIdFromURL()) {
+      cacheControl.put("private", null);
+    }
+    else {
+      /**
+       * Hier muss nicht geprüft werden, ob cacheSeconds > 0 gilt, da in diesem
+       * Fall oben bereits No-Cache-Header generiert und <code>false</code>
+       * zurückgeliefert werden!
+       *
+       * Den Wert als <code>max-age</code> zu den Schlüssel-Wert-Paaren für den
+       * <code>Cache-Control</code>-Header hinzufügen und einen entsprechenden
+       * <code>Expires</code>-Header für HTTP/1.0-Clients setzen.
+       */
+      cacheControl.put("max-age", Integer.toString(cacheSeconds));
+      response.setDateHeader(HEADER_EXPIRES, (controller.getTimestamp() + (long) cacheSeconds * 1000));
+    }
+
+    /** Dem Handler die Gelegenheit geben, den Cache-Controll-Header anzupassen */
+    controller.cacheControl(request, cacheControl);
+
+
+    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");
+    }
+
+    StringBuilder builder = new StringBuilder();
+    for (Entry<String, String> 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;
+    }
+    finally {
+      /**
+       * Thread-Locale-Variable zurücksetzen, damit
+       * 1.) ein doppelter Aufruf dieser Methode pro Request erkannt werden kann
+       * 2.) der nächste Request nicht mit dem selben Handle weiterarbeitet
+       */
+      CacheControl.tl.set(null);
+    }
+  }
+
+  public void release() {
+    CacheControl.tl.set(null);
+  }
+
+
+  interface CacheMethodHandle {
+    long getTimestamp();
+    int accepts(HttpServletRequest request) throws Exception;
+    int getCacheSeconds(HttpServletRequest request) throws Exception;
+    long getLastModified(HttpServletRequest request) throws Exception;
+    String getETag(HttpServletRequest request) throws Exception;
+    void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap) throws Exception;
+  }
+
+  class DefaultCacheMethodHandle implements CacheMethodHandle {
+
+    long now = System.currentTimeMillis();
+    Integer cacheSeconds;
+    Long lastModified;
+    String eTag;
+
+
+    DefaultCacheMethodHandle() {
+      this.cacheSeconds = CacheControl.this.defaultCacheSeconds;
+      this.lastModified = CacheControl.this.defaultLastModified;
+      this.eTag = null;
+    }
+
+
+    @Override
+    public long getTimestamp() {
+      return now;
+    }
+
+    @Override
+    public int accepts(HttpServletRequest request) {
+      return HttpServletResponse.SC_OK;
+    }
+
+    @Override
+    public int getCacheSeconds(HttpServletRequest request) {
+      return cacheSeconds;
+    }
+
+    @Override
+    public long getLastModified(HttpServletRequest request) {
+      return lastModified;
+    }
+
+    @Override
+    public String getETag(HttpServletRequest request) {
+      return eTag;
+    }
+
+    @Override
+    public void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap) {
+    }
+  }
+
+  class ReflectionCacheMethodHandle implements CacheMethodHandle {
+
+    private Object handler;
+    private DefaultCacheMethodHandle defaults = new DefaultCacheMethodHandle();
+    private Method accepts, cacheSeconds, lastModified, eTag, cacheControl;
+    private boolean isAcceptsDefined, isCacheSecondsDefined, isLastModifiedDefined, isETagDefined, isCacheControlDefined;
+
+
+    ReflectionCacheMethodHandle(Object handler) throws NoSuchMethodException {
+      this.handler = handler;
+      /** Class-Level-Annotations auslesen */
+      for (Annotation annotation : handler.getClass().getAnnotations()) {
+        if (annotation.annotationType().equals(CacheSeconds.class)) {
+          defaults.cacheSeconds = ((CacheSeconds)annotation).value();
+          isCacheSecondsDefined = true;
+          continue;
+        }
+        if (annotation.annotationType().equals(LastModified.class)) {
+          defaults.lastModified = ((LastModified)annotation).value();
+          if (defaults.lastModified < 1) {
+            /**
+             * Ein Last-Modified-Header wurde angefordert, aber es wurde kein
+             * statischer Wert spezifiziert:
+             * globalen statischen Default-Wert benutzen!
+             */
+            defaults.lastModified = defaultLastModified;
+          }
+          isLastModifiedDefined = true;
+          continue;
+        }
+        if (annotation.annotationType().equals(ETag.class)) {
+          defaults.eTag = ((ETag)annotation).value();
+          isETagDefined = true;
+          continue;
+        }
+      }
+
+      /** Method-Level-Annotations auslesen */
+      for (Method method : handler.getClass().getMethods()) {
+        for (Annotation annotation : method.getAnnotations()) {
+          if (annotation.annotationType().equals(Accepts.class)) {
+            if (isAcceptsDefined)
+              throw new IllegalArgumentException("Die Annotation @Accept wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+            accepts = method;
+            isAcceptsDefined = true;
+            continue;
+          }
+          if (annotation.annotationType().equals(CacheSeconds.class)) {
+            if (isCacheSecondsDefined)
+              throw new IllegalArgumentException("Die Annotation @CacheSeconds wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+            cacheSeconds = method;
+            isCacheSecondsDefined = true;
+            continue;
+          }
+          if (annotation.annotationType().equals(LastModified.class)) {
+            if (isLastModifiedDefined)
+              throw new IllegalArgumentException("Die Annotation @LastModified wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+            lastModified = method;
+            isLastModifiedDefined = true;
+            continue;
+          }
+          if (annotation.annotationType().equals(ETag.class)) {
+            if (isETagDefined)
+              throw new IllegalArgumentException("Die Annotation @ETag wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+            eTag = method;
+            isETagDefined = true;
+            continue;
+          }
+          if (annotation.annotationType().equals(de.halbekunst.juplo.cachecontrol.annotations.CacheControl.class)) {
+            if (isCacheControlDefined)
+              throw new IllegalArgumentException("Die Annotation @CacheControl wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+            cacheControl = method;
+            isCacheControlDefined = true;
+            continue;
+          }
+        }
+      }
+    }
+
+
+    @Override
+    public long getTimestamp() {
+      return defaults.now;
+    }
+
+    @Override
+    public int accepts(HttpServletRequest request)
+        throws IllegalAccessException,
+               IllegalArgumentException,
+               InvocationTargetException
+    {
+      if (accepts == null)
+        return defaults.accepts(request);
+      else
+        return (Integer)accepts.invoke(handler, request);
+    }
+
+    @Override
+    public int getCacheSeconds(HttpServletRequest request)
+        throws IllegalAccessException,
+               IllegalArgumentException,
+               InvocationTargetException
+    {
+      if (cacheSeconds == null)
+        return defaults.getCacheSeconds(request);
+      else
+        return (Integer)cacheSeconds.invoke(handler, request);
+    }
+
+    @Override
+    public long getLastModified(HttpServletRequest request)
+        throws IllegalAccessException,
+               IllegalArgumentException,
+               InvocationTargetException
+    {
+      if (lastModified == null)
+        return defaults.getLastModified(request);
+      else
+        return (Long)lastModified.invoke(handler, request);
+    }
+
+    @Override
+    public String getETag(HttpServletRequest request)
+        throws IllegalAccessException,
+               IllegalArgumentException,
+               InvocationTargetException
+    {
+      if (eTag == null)
+        return defaults.getETag(request);
+      else
+        return (String)eTag.invoke(handler, request);
+    }
+
+    @Override
+    public void cacheControl(
+        HttpServletRequest request,
+        Map<String, String> cacheControlMap
+        )
+        throws IllegalAccessException,
+               IllegalArgumentException,
+               InvocationTargetException
+    {
+      if (cacheControl == null)
+        defaults.cacheControl(request, cacheControlMap);
+      else
+        cacheControl.invoke(handler, request, cacheControlMap);
+    }
+  }
+
+
+  public void setDefaultCacheSeconds(Integer defaultCacheSeconds) {
+    this.defaultCacheSeconds = defaultCacheSeconds;
+  }
+
+  public void setDefaultLastModified(Long defaultLastModified) {
+    this.defaultLastModified = defaultLastModified;
+  }
+}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlFilter.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/CacheControlFilter.java
new file mode 100644 (file)
index 0000000..549f35c
--- /dev/null
@@ -0,0 +1,209 @@
+package de.halbekunst.juplo.cachecontrol;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.util.Locale;
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletOutputStream;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ *
+ * @author kai
+ */
+public class CacheControlFilter implements Filter {
+
+
+  @Override
+  public void init(FilterConfig filterConfig) throws ServletException {
+    throw new UnsupportedOperationException("Not supported yet.");
+  }
+
+  @Override
+  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
+    throw new UnsupportedOperationException("Not supported yet.");
+  }
+
+  @Override
+  public void destroy() {
+    throw new UnsupportedOperationException("Not supported yet.");
+  }
+
+
+  class HttpServletResponseWrapper implements HttpServletResponse {
+
+    private final HttpServletResponse response;
+
+
+    HttpServletResponseWrapper(HttpServletResponse response) {
+      this.response = response;
+    }
+
+
+    @Override
+    public void addCookie(Cookie cookie) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public boolean containsHeader(String name) {
+      return response.containsHeader(name);
+    }
+
+    @Override
+    public String encodeURL(String url) {
+      return response.encodeURL(url);
+    }
+
+    @Override
+    public String encodeRedirectURL(String url) {
+      return response.encodeRedirectURL(url);
+    }
+
+    @Override
+    public String encodeUrl(String url) {
+      return response.encodeUrl(url);
+    }
+
+    @Override
+    public String encodeRedirectUrl(String url) {
+      return response.encodeRedirectUrl(url);
+    }
+
+    @Override
+    public void sendError(int sc, String msg) throws IOException {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void sendError(int sc) throws IOException {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void sendRedirect(String location) throws IOException {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setDateHeader(String name, long date) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void addDateHeader(String name, long date) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setHeader(String name, String value) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void addHeader(String name, String value) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setIntHeader(String name, int value) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void addIntHeader(String name, int value) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setStatus(int sc) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setStatus(int sc, String sm) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public String getCharacterEncoding() {
+      return response.getCharacterEncoding();
+    }
+
+    @Override
+    public String getContentType() {
+      return response.getContentType();
+    }
+
+    @Override
+    public ServletOutputStream getOutputStream() throws IOException {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public PrintWriter getWriter() throws IOException {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setCharacterEncoding(String charset) {
+      response.setCharacterEncoding(charset);
+    }
+
+    @Override
+    public void setContentLength(int len) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setContentType(String type) {
+      response.setContentType(type);
+    }
+
+    @Override
+    public void setBufferSize(int size) {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public int getBufferSize() {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void flushBuffer() throws IOException {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void resetBuffer() {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public boolean isCommitted() {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void reset() {
+      throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setLocale(Locale loc) {
+      response.setLocale(loc);
+    }
+
+    @Override
+    public Locale getLocale() {
+      return response.getLocale();
+    }
+  }
+}
index a830e3c..fe51187 100644 (file)
@@ -1,13 +1,11 @@
 package de.halbekunst.juplo.cachecontrol;
 
-import java.util.Date;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Map.Entry;
+import de.halbekunst.juplo.cachecontrol.annotations.Cacheable;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.servlet.HandlerInterceptor;
 import org.springframework.web.servlet.ModelAndView;
 
@@ -18,184 +16,58 @@ import org.springframework.web.servlet.ModelAndView;
 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";
+
+  private CacheControl cacheControl;
 
 
   @Override
-  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
-    if (!(handler instanceof Cacheable))
+  public boolean preHandle(
+      HttpServletRequest request,
+      HttpServletResponse response,
+      Object handler
+      ) throws Exception
+  {
+    Cacheable cacheable = handler.getClass().getAnnotation(Cacheable.class);
+    if (cacheable == null) {
+      /** Der Handler ist nicht mit @Cacheable annotiert: keine Dekorationen anbringen! */
       return true;
-
-    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;
+    /** CacheControll initialisieren (Handler nach annotierte Methoden scannen etc.) */
+    cacheControl.init(handler);
 
-    String url = null;
-    if (log.isDebugEnabled()) {
-      if (request.getQueryString() == null) {
-        url = request.getRequestURI();
-      }
-      else {
-        StringBuilder builder = new StringBuilder();
-        builder.append(request.getRequestURI());
-        builder.append('?');
-        builder.append(request.getQueryString());
-        url = builder.toString();
-      }
+    if (cacheable.eager()) {
+      return cacheControl.decorate(request, response, handler);
     }
-
-    int cacheSeconds = cacheable.getCacheSeconds(request);
-    if (cacheSeconds < 0) {
-      log.debug("{}: caching disabled!", url);
-      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");
+    else {
       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 {}", url, new Date(ifModifiedSince));
-
-      if (ifNoneMatch == null) {
-        /** Neue Anfrage oder HTTP/1.0 Client! */
-        log.debug("{}: ETag nicht gesetzt -> 304", url);
-        response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
-        return false;
-      }
-    }
-
-    if (ifNoneMatch != null && ifNoneMatch.equals(eTag)) {
-      log.debug("{}: ETag {} not changed -> 304 ", url, ifNoneMatch);
-      response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
-      return false;
-    }
-
-
-    log.debug("{}: first up!", url);
-
-    /** HTTP/1.1-Caching-Header richtig setzen!! */
-    response.setDateHeader(HEADER_LAST_MODIFIED, lastModified);
-
-    /** Cache-Control für HTTP/1.1-Clients generieren */
-    Map<String, String> cacheControl = new HashMap<String, String>(cacheable.getCacheControl(request));
-
-    /**
-     * Wenn eins JSESSIONID in der URL enthalten ist, darf die Anfrage nur vom
-     * Browser gecached werden!
-     */
-    if (request.isRequestedSessionIdFromURL())
-      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 <code>false</code>
-       * zurückgeliefert werden!
-       *
-       * Den Wert als <code>max-age</code> zu den Schlüssel-Wert-Paaren für den
-       * <code>Cache-Control</code>-Header hinzufügen und einen entsprechenden
-       * <code>Expires</code>-Header für HTTP/1.0-Clients setzen.
-       */
-      cacheControl.put("max-age", Integer.toString(cacheSeconds));
-      response.setDateHeader(HEADER_EXPIRES, (now + (long) cacheSeconds * 1000));
-    }
-
-    StringBuilder builder = new StringBuilder();
-    for (Entry<String, String> 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;
   }
 
   @Override
-  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {}
+  public void postHandle(
+      HttpServletRequest request,
+      HttpServletResponse response,
+      Object handler,
+      ModelAndView modelAndView
+      ) throws Exception
+  {
+    cacheControl.decorate(request, response, handler);
+  }
 
   @Override
-  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {}
+  public void afterCompletion(
+      HttpServletRequest request,
+      HttpServletResponse response,
+      Object handler, Exception ex
+      ) throws Exception
+  {
+    cacheControl.release();
+  }
+
+
+  @Autowired
+  public void setCacheControl(CacheControl cacheControl) {
+    this.cacheControl = cacheControl;
+  }
 }
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/Cacheable.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/Cacheable.java
deleted file mode 100644 (file)
index 75ac110..0000000
+++ /dev/null
@@ -1,153 +0,0 @@
-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 <code>false</code> zurückliefert, werden von
-   * {@link CachingDispatcherServlet#isRessourceModified(HttpServletRequest, HttpServletResponse, Cacheable)}
-   * keinerlei HTTP/1.1-Cache-Header in den Response eingebaut.
-   * <p>
-   * Ü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 <code>true</code>, wenn Caching-Header in den Response geschrieben
-   *         werden sollen, sonst <code>false</code>.
-   * @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.
-   * <ul>
-   * <li>Wenn die Methode den Wert <code>0</code> (oder einen anderen Wert
-   * kleiner <code>1</code>) zurückliefert, werden Cache-Header erzeugt, die das
-   * Cachen der Antwort für HTTP/1.0 und HTTP/1.1 vollständig untersagen,</li>
-   * <li>Wenn die Methode einen Wert größer <code>0</code> zurückliefert, wird
-   * ein für HTTP/1.0-Clients ein <code>Expires</code>-Header generiert und für
-   * HTTP/1.1-Clients ein <code>Cache-Control</code>-Header mit einem
-   * entsprechenden <code>max-age</code>-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.</li>
-   * </ul>
-   * <p>
-   * <strong>Zu beachten:</strong> Wenn die Methode
-   * {@link #getCacheControl(javax.servlet.http.HttpServletRequest)} weitere
-   * Schlüssel-Wert-Paare für den <code>Cache-Control</code>-Header liefert,
-   * werden diese ergänzt. Wenn in der Rückgabe ein Wert für
-   * <code>max-age</code> 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 <code>0</code>, wenn
-   *         Caching aktiv unterbunden werden soll bzw. einen Wert kleiner
-   *         <code>0</code>, wenn kein <code>Expires</code>-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.
-   * <p>
-   * <strong>Zu beachten:</strong>
-   * <ul>
-   * <li>Diese Methode wird nicht aufgerufen, wenn
-   * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)}
-   * <code>0</code> liefert.</li>
-   * </ul>
-   *
-   * @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:
-   * <ul>
-   * <li><code>"24afh2w3848adf"</code>
-   * <li><code>W/"839482"</code>
-   * <li><code>""</code>
-   * </ul>
-   * <strong>Merke:</strong> Der wert ist immer in doppelte Anführungszeichen
-   * einzuschließen!
-   * <p>
-   * <strong>Zu beachten:</strong>
-   * <ul>
-   * <li>Diese Methode wird nicht aufgerufen, wenn
-   * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)}
-   * <code>0</code> liefert.</li>
-   * </ul>
-   *
-   * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest)
-   * @param request
-   *          Der aktuelle HTTP-Request
-   * @return Das zu verwendende ETag, oder <code>null</code>, 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 <code>Cache-Control</code> (s. {@plainlink
-   * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 RFC2616,
-   * Abschnitt 14.9.3}).
-   * <p>
-   * <strong>Zu beachten:</strong>
-   * <ul>
-   * <li>Die Methode darf nie <code>null</code> zurückliefern!</li>
-   * <li>Ein Wert für den Schlüssel <code>max-age</code> wird überschrieben,
-   * wenn die Methode
-   * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)} einen Wert
-   * größer <code>0</code> zurückliefert.</li>
-   * <li>Diese Methode wird nicht aufgerufen, wenn
-   * {@link #getCacheSeconds(javax.servlet.http.HttpServletRequest)}
-   * <code>0</code> liefert.</li>
-   * </ul>
-   *
-   * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest)
-   * @param request
-   *          Der aktuelle HTTP-Request
-   * @return Eine <code>Map</code> mit den Schlüssel-Wert-Paaren für den
-   *         <code>Cache-Control</code>-Header.
-   * @throws IllegalArgumentException
-   *           Wenn zu dem Request keine Ressource existiert.
-   */
-  public Map<String, String> getCacheControl(HttpServletRequest request) throws IllegalArgumentException;
-}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/Accepts.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/Accepts.java
new file mode 100644 (file)
index 0000000..2f6ec30
--- /dev/null
@@ -0,0 +1,30 @@
+package de.halbekunst.juplo.cachecontrol.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Mit dieser Methode kann eine Methode annotiert werden, die Auskunft darüber
+ * erteilt, mit welchem HTTP-Status-Code der Handler die Anfrage beatnworten
+ * wird.
+ * <p>
+ * Die Methode muss eine Instanz von {@link HttpServletRequest} als (einziges!)
+ * Argument akzeptieren und einen Wert liefern, der sich nach
+ * <code>int</code> casten lässt.
+ * <p>
+ * Eine mit dieser Annotation markierte Methode wird nur benötigt, wenn die
+ * Caching-Dekoration im Modus <code>eager=true</code> ausgeführt wird. Sie
+ * wird in diesem Fall benötigt, weil die Entscheidungen zur Cache-Dekoration
+ * dann getroffen werden müssen, <em>bevor</em> die verarbeitende Klasse die
+ * Anfrage verarbeitet hat.
+ * Wenn die Cache-Dekoration im Modus <code>eager=true</code> betrieben wird
+ * und keine Methode mit dieser Annotation annotiert ist, geht {@link CacheControl}
+ * davn aus, dass die verarbeitende Klasse alle Anfragen annimmt.
+ *
+ * @author kai
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface Accepts {}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/CacheControl.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/CacheControl.java
new file mode 100644 (file)
index 0000000..ab5c4a3
--- /dev/null
@@ -0,0 +1,30 @@
+package de.halbekunst.juplo.cachecontrol.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Mit dieser Annotation kann eine Methode markiert werden, die die von Juplo-
+ * CacheControl für den Header <code>Cache-Control</code> generierten
+ * Schlüssel/Wert-Kombinationen manipulieren oder ergänzen kann, bevor der
+ * Header an den Client ausgeliefert wird (s. {@plainlink
+ * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 RFC2616, Abschnitt 14.9.3}).
+ * <p>
+ * Die Methode muss zwei Parameter akzeptieren.
+ * Als ersten Parameter eine Instanz von {@link HttpServletRequest}.
+ * Als zweiten Parameter eine <code>Map<String,String></code>, die die von
+ * Juplo-CacheControl erzeugten Schlüssel/Wert-Paare enthält.
+ * <p>
+ * Diese Methode liefert eine Map mit Schlüssel-Wert-Paaren für den
+ * HTTP/1.1-Header <code>Cache-Control</code> (s. {@plainlink
+ * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3 RFC2616,
+ * Abschnitt 14.9.3}).
+ *
+ * @author kai
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface CacheControl {
+}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/CacheSeconds.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/CacheSeconds.java
new file mode 100644 (file)
index 0000000..e076e08
--- /dev/null
@@ -0,0 +1,52 @@
+package de.halbekunst.juplo.cachecontrol.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Mit dieser Annotation können Klassen oder Methoden merkiert werden.
+ * <p>
+ * Wenn eine Methode markiert wird, muss diese eine Instanz von
+ * {@link HttpServletRequest} als (einziges!) Argument akzeptieren und einen
+ * Wert liefern, der sich nach <code>int</code> casten lässt.
+ * Die annotierte Methode ermöglicht eine einfache, zentrale aber Request-
+ * Abhängige Steuerung des Caching-Verhaltens.
+ * <p>
+ * Wenn eine Klasse annotiert wird, muss der Anotation die dann statisch für
+ * alle von der Klasse erzeugten Antworten gültige Cache-Zeit als Argument
+ * übergeben werden.
+ * Wird keine Cache-Zeit spezifiziert, wird der Wert <code>86400</code>
+ * (ein Tag) verwendet.
+ * <ul>
+ * <li>Wenn negativer Wert als Cache-Seconds festgelet wird, werden Cache-Header
+ * erzeugt, die das Cachen der Antwort für HTTP/1.0 und HTTP/1.1 vollständig
+ * untersagen.</li>
+ * <li>Wenn einen Wert größer oder gleich <code>0</code> festgelegt wird, wird
+ * für HTTP/1.0-Clients ein <code>Expires</code>-Header generiert und für
+ * HTTP/1.1-Clients ein <code>Cache-Control</code>-Header mit einem
+ * entsprechenden <code>max-age</code>-Eintrag. Dies reicht in Kombination mit
+ * der Annotation {@link LastModified} vollständig für ein einfaches aber
+ * effektives Caching aus.</li>
+ * </ul>
+ * <p>
+ * TODO
+ * <strong>Zu beachten:</strong> Wenn die Methode
+ * {@link #getCacheControl(javax.servlet.http.HttpServletRequest)} weitere
+ * Schlüssel-Wert-Paare für den <code>Cache-Control</code>-Header liefert,
+ * werden diese ergänzt. Wenn in der Rückgabe ein Wert für
+ * <code>max-age</code> enthalten ist, wir er allerdings von dem durch diese
+ * Methode vorgegebenen Wert überschrieben!
+ *
+ * @author kai
+ * @See Cacheable
+ * @See LastModified
+ * @See CacheControl
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD })
+public @interface CacheSeconds {
+  int value() default 86400; /** Default: 1 Tag */
+}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/Cacheable.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/Cacheable.java
new file mode 100644 (file)
index 0000000..7a1be26
--- /dev/null
@@ -0,0 +1,45 @@
+package de.halbekunst.juplo.cachecontrol.annotations;
+
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+
+/**
+ * Marker-Annotation für Handler (i.A. eine Impelementierung von
+ * {@link Controller}), deren Antworten vom {@link CachingInterceptor} mit
+ *  HTTP/1.1-Caching-Header nach
+ * {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html RFC 2616}
+ * dekoriert werden sollen.
+ * <p>
+ * Wenn der Parameter <code>eager</code> auf <code>true</code> gesetzt wird,
+ * ermittelt der {@link CachingInterceptor} die Cache-Parameter über die
+ * annotierten Methoden vorab.
+ * <strong>Achtung:</strong>
+ * Dies bedeutet, dass die annotierten Methoden aufgerufen werden <em>bevor</em>
+ * die eigentliche Verarbeitungs-Routine der markierten Klasse aufgerufen wird!
+ * Wenn sich dabei ergiebt, dass die Antwort nicht erneut ausgeliefert werden
+ * muss, wird die eigentliche Verarbeitungs-Routine <em>gar nicht aufgerufen</em>.
+ * <p>
+ * Wenn der Parameter <code>eager</code> nicht gesetzt ist (oder explizit auf
+ * <code>false</code> gesetzt wurde), kapselt der {@link CachingInterceptor}
+ * den Request und den Ausgabestrom für den Response-Body und trifft die
+ * Entscheidung über die zu ergänzenden Header, wenn der Status des
+ * {@link HttpServletResponse} gesetzt oder mit dem Schreiben des Response-Body
+ * begonnen wird.
+ *
+ * @see CacheControl
+ * @see Accepts
+ * @see CacheSeconds
+ * @see LastModified
+ * @see ETag
+ * @see CacheControl
+ * @author kai
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Cacheable {
+  boolean eager() default false;
+}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/ETag.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/ETag.java
new file mode 100644 (file)
index 0000000..d2542dc
--- /dev/null
@@ -0,0 +1,84 @@
+package de.halbekunst.juplo.cachecontrol.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Über diese Annotation kann der Inhalt des <code>ETag/code>-Headers
+ * gesteuert werden.
+ * Mit dieser Annotation können Klassen oder Methoden merkiert werden.
+ * <p>
+ * Wenn eine Methode annotiert wird, muss diese eine Instanz von
+ * {@link HttpServletRequest} als (einziges!) Argument akzeptieren und einen
+ * <code>String</code> liefern.
+ * <p>
+ * Wenn eine Klasse Annotiert wird, muss der Annotation der Wert für den
+ * <code>ETag</code>-Header übergeben werden.
+ * Da dieser Wert somit statisch ist, macht es nur Sinn, Klassen mit dieser
+ * Annotation zu markieren, die ausschließlich statische Ressourcen ausliefern,
+ * die sich nur mit der Neuinstallation der Webanwendung ändern.
+ * Wenn sich (z.B. nach einer Neuinstallation der Webanwendung) die statischen
+ * Ressourcen geändert haben, muss der übergebene statische ETag geändert
+ * werden, da Caches sonst weiterhin die alten Ressourcen ausliefern!
+ * </p>
+ * Frei wählbares ETag nach
+ * {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19 RFC 2616, Abschnitt 14.19 ETag}.
+ * Der gelieferte Wert darf die vom RFC geforderten Anführungszeichen noch nicht
+ * enthalten, da er, wenn <code>vary</code> gesetzt ist, noch um je nach
+ * erfolgter Content-Negotiation varriierende Teile ergänzt wird.
+ * <p>
+ * Die erzeugten <code>ETag</code>'s können über die Annotations-Parameter
+ * <code>weak</code> und <code>vary</code> weiter gesteuert werden.
+ * <ul>
+ * <li>
+ * Wenn der Parameter <strong>weak</strong> auf den wert <code>true</code>
+ * gesetzt wird, wird ein schwaches <code>ETag</code> erezeugt und der
+ * Vergleichs-Algorithmus verhält sich entsprechend anders (siehe:
+ * {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html#sec13.3.3 RFC 2616, Abschnitt 13.3.3 Weak and Strong Validators}).
+ * </li>
+ * <li>
+ * Über den Parameter <strong>vary</strong> kann Juplo-CacheControl damit
+ * beauftragt werden, die Nötigen Maßnahmen für korrektes Content-Negotiating
+ * zu ergreifen (siehe:
+ * {@linkplain http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html#sec13.6 RFC 2616, Abschnitt 13.6 Caching Negotiated Responses}).
+ * Als Eingabe werden die Header-Namen erwertet, die zu unterschiedlichen
+ * Ergebnissen der Content-Negotiation führen können (hier können folgende
+ * Header angegeben werden: <code>Accept</code>, <code>Accept-Charset</code>,
+ * <code>Accept-Encoding</code> und <code>Accept-Language</code>).
+ * Juplo-CacheControl modifizert den übergebenen <code>ETag</code> dann so,
+ * dass unterschiedliche Resultate der Content-Negotiation unterschieden
+ * werden können.
+ * Außerdem wird der <code>Vary</code>-Header entsprechend gesetzt.
+ *</li>
+ * </ul>
+ * <strong>Zu beachten:</strong>
+ * Wenn zugleich die Annotation {@link CacheSeconds} verwendet wird, wird
+ * die mit dieser Annotation markierte Methode nur aufgerufen, wenn die mit
+ * der Annotation {@link CacheSeconds} markierte Methode einen Wert größer
+ * oder gleich <code>0</code> liefert, bzw. für die mit Annotation
+ * {@link CacheSeconds} markierte Klasse eine Cache-Zeit größer oder gleich
+ * <code>0</code> festgelegt wurde.
+ *
+ * @see #getCacheSeconds(javax.servlet.http.HttpServletRequest)
+ *
+ * @author kai
+ * @see Cacheable
+ * @see CacheSeconds
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD })
+public @interface ETag {
+
+  public final static String ACCEPT = "Accept";
+  public final static String ACCEPT_CHARSET = "Accept-Charset";
+  public final static String ACCEPT_ENCODING = "Accept-Encoding";
+  public final static String ACCEPT_LANGUAGE = "Accept-Language";
+
+
+  String value() default "X";
+  boolean weak() default false;
+  String[] vary() default {};
+}
diff --git a/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/LastModified.java b/cachecontrol/src/main/java/de/halbekunst/juplo/cachecontrol/annotations/LastModified.java
new file mode 100644 (file)
index 0000000..be28e0e
--- /dev/null
@@ -0,0 +1,53 @@
+package de.halbekunst.juplo.cachecontrol.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Über diese Annotation kann der Inhalt des <code>Last-Modified</code>-Headers
+ * gesteuert werden.
+ * Mit dieser Annotation können Klassen oder Methoden merkiert werden.
+ * <p>
+ * Wenn eine Methode annotiert wird, muss diese eine Instanz von
+ * {@link HttpServletRequest} als (einziges!) Argument akzeptieren und einen
+ * Wert liefern, der sich nach <code>long</code> casten lässt.
+ * Die Signatur der Methode entspricht der Methode
+ * {@link HttpServlet#getLastModified(javax.servlet.http.HttpServletRequest)}
+ * aus dem <code>HttpServlet</code>-Interface.
+ * Um das Cache-Verhalten ein existierendes Servlet, das diese Methode bereits
+ * implementiert, mit Juplo-CacheControll zu verbessern, kann als erste
+ * Maßnahme daher einfach diese Methode mit dieser Annotation markiert werden.
+ * <p>
+ * Wenn eine Klasse Annotiert wird, muss der Annotation der Wert für den
+ * <code>Last-Modified</code>-Header übergeben werden.
+ * Da dieser Wert somit statisch ist, macht es nur Sinn, Klassen mit dieser
+ * Annotation zu markieren, die ausschließlich statische Ressourcen ausliefern,
+ * die sich nur mit der Neuinstallation der Webanwendung ändern.
+ * </p>
+ * Über diese Annotation wird der Zeitpunkt gesteuert, zu dem die gelieferte
+ * Ressource zuletzt verändert wurde.
+ * Erwartet wird eine Zeitangabe in Millisekunden seit dem Unix-0-Zeitpunkt,
+ * die dann an {@link HttpServletResponse#setDateHeader(String, long)}
+ * weitergegeben wird.
+ * <p>
+ * <strong>Zu beachten:</strong>
+ * Wenn zugleich die Annotation {@link CacheSeconds} verwendet wird, wird
+ * die mit dieser Annotation markierte Methode nur aufgerufen, wenn die mit
+ * der Annotation {@link CacheSeconds} markierte Methode einen Wert größer
+ * oder gleich <code>0</code> liefert, bzw. für die mit Annotation
+ * {@link CacheSeconds} markierte Klasse eine Cache-Zeit größer oder gleich
+ * <code>0</code> festgelegt wurde.
+ *
+ * @author kai
+ * @see Cacheable
+ * @see CacheSeconds
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD })
+public @interface LastModified {
+  long value() default 0;
+}
diff --git a/pom.xml b/pom.xml
index abd2bf7..2db8fc0 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>de.halbekunst</groupId>
   <artifactId>juplo</artifactId>
-  <version>1.0.1</version>
+  <version>2.0-SNAPSHOT</version>
   <name>Juplo</name>
   <packaging>pom</packaging>
   <url>http://www.halbekunst.de</url>
@@ -24,9 +24,7 @@
   </developers>
 
   <modules>
-    <module>test</module>
     <module>cachecontrol</module>
-    <module>utils</module>
   </modules>
 
   <properties>