import de.halbekunst.juplo.cachecontrol.annotations.CacheSeconds;
import de.halbekunst.juplo.cachecontrol.annotations.Accepts;
+import de.halbekunst.juplo.cachecontrol.annotations.AdditionalHeaders;
import de.halbekunst.juplo.cachecontrol.annotations.LastModified;
import de.halbekunst.juplo.cachecontrol.annotations.ETag;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Date;
+import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
import javax.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Component;
/**
*
* @author kai
*/
+@Component
public class CacheControl {
private final static Logger log = LoggerFactory.getLogger(CacheControl.class);
private static final ThreadLocal<CacheMethodHandle> tl = new ThreadLocal<CacheMethodHandle>();
- private Integer defaultCacheSeconds;
- private Long defaultLastModified;
+ @Autowired @Qualifier("cacheSeconds") private Integer defaultCacheSeconds;
+ @Autowired @Qualifier("lastModified") private Long defaultLastModified;
public void init(CacheMethodHandle handle) {
* http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18 RFC 2616,
* Abschnitt 14.18} einen Date-Header enthalten
*/
- response.setDateHeader(HeaderNames.HEADER_DATE, controller.getTimestamp());
+ response.setDateHeader(Headers.HEADER_DATE, controller.getTimestamp());
/** Besondere Maßnahmen für besondere HTTP-Status-Codes ?!? */
int status = controller.accepts(request);
return false;
}
+ Map<String,String> headers = controller.getAdditionalHeaders(request);
+ for (String name : headers.keySet())
+ response.addHeader(name, headers.get(name));
+
String url = null;
if (log.isDebugEnabled()) {
if (request.getQueryString() == null) {
int cacheSeconds = controller.getCacheSeconds(request);
if (cacheSeconds < 1) {
log.debug("{}: caching disabled!", url);
- response.setDateHeader(HeaderNames.HEADER_DATE, controller.getTimestamp());
- response.setDateHeader(HeaderNames.HEADER_EXPIRES, 0);
- response.addHeader(HeaderNames.HEADER_PRAGMA, "no-cache");
- response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "private");
- response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "no-cache");
- response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "no-store");
- response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "max-age=0");
- response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, "s-max-age=0");
+ response.setDateHeader(Headers.HEADER_DATE, controller.getTimestamp());
+ response.setDateHeader(Headers.HEADER_EXPIRES, 0);
+ response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
+ response.addHeader(Headers.HEADER_CACHE_CONTROL, "private");
+ response.addHeader(Headers.HEADER_CACHE_CONTROL, "no-cache");
+ response.addHeader(Headers.HEADER_CACHE_CONTROL, "no-store");
+ response.addHeader(Headers.HEADER_CACHE_CONTROL, "max-age=0");
+ response.addHeader(Headers.HEADER_CACHE_CONTROL, "s-max-age=0");
return true;
}
long ifModifiedSince = -1;
try {
- ifModifiedSince = request.getDateHeader(HeaderNames.HEADER_IF_MODIFIED_SINCE);
+ ifModifiedSince = request.getDateHeader(Headers.HEADER_IF_MODIFIED_SINCE);
}
catch (Exception e) {
log.error("Exception while fetching If-Modified-Since: {}", e);
*/
lastModified = lastModified - (lastModified % 1000);
- String ifNoneMatch = request.getHeader(HeaderNames.HEADER_IF_NONE_MATCH);
+ String ifNoneMatch = request.getHeader(Headers.HEADER_IF_NONE_MATCH);
String eTag = controller.getETag(request);
/**
builder.append('"');
builder.append(eTag);
builder.append('"');
- response.setHeader(HeaderNames.HEADER_ETAG, builder.toString());
+ response.setHeader(Headers.HEADER_ETAG, builder.toString());
}
ifNoneMatch = ifNoneMatch.substring(1, ifNoneMatch.length() - 1);
}
- if (!weak || (request.getMethod().equals("GET") && request.getHeader(HeaderNames.HEADER_RANGE) == null)) {
+ if (!weak || (request.getMethod().equals("GET") && request.getHeader(Headers.HEADER_RANGE) == null)) {
/**
* Die Gleichheit gilt nur, wenn die ETag's der Anfrage _und_ der
* Antwort stark sind (starke Gleichheit!), oder wenn die Antwort nur
log.debug("{}: first up!", url);
/** HTTP/1.1-Caching-Header richtig setzen!! */
- response.setDateHeader(HeaderNames.HEADER_LAST_MODIFIED, lastModified);
+ response.setDateHeader(Headers.HEADER_LAST_MODIFIED, lastModified);
/** Cache-Control für HTTP/1.1-Clients generieren */
Map<String, String> cacheControl = new TreeMap<String, String>();
* <code>Expires</code>-Header für HTTP/1.0-Clients setzen.
*/
cacheControl.put("max-age", Integer.toString(cacheSeconds));
- response.setDateHeader(HeaderNames.HEADER_EXPIRES, (controller.getTimestamp() + (long) cacheSeconds * 1000));
+ response.setDateHeader(Headers.HEADER_EXPIRES, (controller.getTimestamp() + (long) cacheSeconds * 1000));
}
/** Dem Handler die Gelegenheit geben, den Cache-Controll-Header anzupassen */
* http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32
* Abschnitt 14.32})
*/
- response.setDateHeader(HeaderNames.HEADER_EXPIRES, 0l);
- response.addHeader(HeaderNames.HEADER_PRAGMA, "no-cache");
+ response.setDateHeader(Headers.HEADER_EXPIRES, 0l);
+ response.addHeader(Headers.HEADER_PRAGMA, "no-cache");
}
StringBuilder builder = new StringBuilder();
builder.append('=');
builder.append(entry.getValue());
}
- response.addHeader(HeaderNames.HEADER_CACHE_CONTROL, builder.toString());
+ response.addHeader(Headers.HEADER_CACHE_CONTROL, builder.toString());
}
return true;
String getETag(HttpServletRequest request);
boolean isETagWeak();
void cacheControl(HttpServletRequest request, Map<String, String> cacheControlMap);
+ Map<String,String> getAdditionalHeaders(HttpServletRequest request);
}
private Integer cacheSeconds;
private Long lastModified;
private String eTag;
+ private Map<String,String> additionalHeaders;
private Method acceptsMethod;
private Method cacheSecondsMethod;
private Method lastModifiedMethod;
private Method eTagMethod;
private Method cacheControlMethod;
+ private Method additionalHeadersMethod;
private boolean isAcceptsMethodDefined;
private boolean isCacheSecondsMethodDefined;
private boolean isLastModifiedMethodDefined;
private boolean isETagMethodDefined;
private boolean isCacheControlMethodDefined;
+ private boolean isAdditionalHeadersMethodDefined;
private boolean weak;
isETagMethodDefined = true;
continue;
}
+ if (annotation.annotationType().equals(AdditionalHeaders.class)) {
+ AdditionalHeaders additionalHeadersAnnotation = (AdditionalHeaders)annotation;
+ additionalHeaders = new HashMap<String,String>();
+ for (String header : additionalHeadersAnnotation.value()) {
+ int i = header.indexOf(':');
+ if (i < 0) {
+ log.error("invalid header: [{}]", header);
+ }
+ else {
+ String name = header.substring(0,i).trim();
+ String value = header.substring(i+1,header.length()).trim();
+ additionalHeaders.put(name, value);
+ }
+ }
+ isAdditionalHeadersMethodDefined = true;
+ continue;
+ }
}
/** Method-Level-Annotations auslesen */
isCacheControlMethodDefined = true;
continue;
}
+ if (annotation.annotationType().equals(AdditionalHeaders.class)) {
+ if (isAdditionalHeadersMethodDefined)
+ throw new IllegalArgumentException("Die Annotation @AdditionalHeaders wurde in der Klasse " + handler.getClass().getSimpleName() + " mehrfach verwendet!");
+ additionalHeadersMethod = method;
+ isAdditionalHeadersMethodDefined = true;
+ continue;
+ }
}
}
+
+ if (!isAdditionalHeadersMethodDefined)
+ additionalHeaders = new HashMap<String,String>();
}
}
}
}
- }
-
-
- public void setDefaultCacheSeconds(Integer defaultCacheSeconds) {
- this.defaultCacheSeconds = defaultCacheSeconds;
- }
- public void setDefaultLastModified(Long defaultLastModified) {
- this.defaultLastModified = defaultLastModified;
+ @Override
+ public Map<String,String> getAdditionalHeaders(HttpServletRequest request) throws IllegalArgumentException {
+ if (additionalHeadersMethod == null) {
+ return additionalHeaders;
+ }
+ else {
+ try {
+ return (Map<String,String>)additionalHeadersMethod.invoke(handler, request);
+ }
+ catch (Exception e) {
+ throw new IllegalArgumentException(e);
+ }
+ }
+ }
}
}
projects / percentcodec / blobdiff