org.swisspush.gateleen.queue.expiry.ExpiryCheckHandler Maven / Gradle / Ivy
package org.swisspush.gateleen.queue.expiry;
import io.vertx.core.http.CaseInsensitiveHeaders;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.Instant;
import org.joda.time.LocalDateTime;
import org.joda.time.format.DateTimeFormatter;
import org.joda.time.format.ISODateTimeFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.vertx.core.MultiMap;
import io.vertx.core.http.HttpServerRequest;
import org.swisspush.gateleen.core.http.HttpRequest;
/**
* The ExpiryCheckHandler allows you to check the expiry
* of a request.
* It also offers methods for setting default
* values for expiration and timestamps to the request header.
*
* @author https://github.com/ljucam [Mario Ljuca]
*/
public final class ExpiryCheckHandler {
public static final String SERVER_TIMESTAMP_HEADER = "X-Server-Timestamp";
public static final String EXPIRE_AFTER_HEADER = "X-Expire-After";
private static Logger log = LoggerFactory.getLogger(ExpiryCheckHandler.class);
private static DateTimeFormatter dfISO8601 = ISODateTimeFormat.dateTime().withZone(DateTimeZone.forID("Europe/Zurich"));
private static DateTimeFormatter dfISO8601Parser = ISODateTimeFormat.dateTimeParser().withZone(DateTimeZone.forID("Europe/Zurich"));
private static DateTimeFormatter isoDateTimeParser = ISODateTimeFormat.dateTimeParser();
private ExpiryCheckHandler() {
// Prevent instantiation
}
/**
* Checks if a "X-Server-Timestamp" header is set or not.
* If no valid value is found, the actual timestamp is set.
*
* @param request request
*/
public static void updateServerTimestampHeader(HttpRequest request) {
if (request.getHeaders() == null) {
request.setHeaders(new CaseInsensitiveHeaders());
}
updateServerTimestampHeader(request.getHeaders());
}
/**
* Checks if a "X-Server-Timestamp" header is set or not.
* If no valid value is found, the actual timestamp is set.
*
* @param request request
*/
public static void updateServerTimestampHeader(HttpServerRequest request) {
updateServerTimestampHeader(request.headers());
}
/**
* Checks if a "X-Server-Timestamp" header is set or not.
* If no valid value is found, the actual timestamp is set.
*
* @param headers headers
*/
public static void updateServerTimestampHeader(MultiMap headers) {
String serverTimestamp = headers.get(SERVER_TIMESTAMP_HEADER);
if (serverTimestamp == null) {
String nowAsISO = dfISO8601.print(Instant.now());
log.debug("Setting " + SERVER_TIMESTAMP_HEADER + " value to " + nowAsISO + " since header " + EXPIRE_AFTER_HEADER + " is not defined");
headers.set(SERVER_TIMESTAMP_HEADER, nowAsISO);
} else {
String updatedTimestamp = localizeTimestamp(serverTimestamp);
if (!updatedTimestamp.equals(serverTimestamp)) {
log.debug("Updating" + SERVER_TIMESTAMP_HEADER + " value from " + serverTimestamp + " to " + updatedTimestamp);
headers.remove(SERVER_TIMESTAMP_HEADER);
headers.set(SERVER_TIMESTAMP_HEADER, updatedTimestamp);
}
}
}
/**
* Extracts the value of the "X-Expire-After" header.
* If the value can't be extracted (not found, invalid, and so on),
* null is returned.
*
* @param headers headers
* @return expire-after time in seconds or null if nothing is found
*/
public static Integer getExpireAfter(MultiMap headers) {
String expireAfterHeaderValue = headers.get(EXPIRE_AFTER_HEADER);
Integer value;
// no header set for X-Expire-After
if (expireAfterHeaderValue == null) {
log.debug(EXPIRE_AFTER_HEADER + " not defined");
value = null;
} else {
try {
value = Integer.parseInt(expireAfterHeaderValue);
// redis returns an error if setex is called with negativ values
if (value < 0) {
log.debug(EXPIRE_AFTER_HEADER + " is a negative number: " + expireAfterHeaderValue);
value = null;
} else {
log.debug("Setting " + EXPIRE_AFTER_HEADER + " value to " + value + " seconds as defined in header " + EXPIRE_AFTER_HEADER);
}
} catch (Exception e) {
log.warn(EXPIRE_AFTER_HEADER + " is not a number: " + expireAfterHeaderValue);
value = null;
}
}
return value;
}
/**
* Checks if the given request has expired or not.
* If no "X-Expire-After" or "X-Server-Timestamp" is found false is returned.
*
* @param request request
* @return true if the request has expired, false otherwise
*/
public static boolean isExpired(HttpRequest request) {
return isExpired(request.getHeaders());
}
/**
* Checks if the given request has expired or not.
* If no "X-Expire-After" or "X-Server-Timestamp" is found false is returned.
*
* @param request request
* @return true if the request has expired, false otherwise
*/
public static boolean isExpired(HttpServerRequest request) {
return isExpired(request.headers());
}
/**
* Checks the expiration based on the given headers.
* If no "X-Expire-After" or "X-Server-Timestamp" is found false is returned.
*
* @param headers headers
* @return true if the request has expired, false otherwise
*/
public static boolean isExpired(MultiMap headers) {
if (headers != null) {
Integer expireAfter = getExpireAfter(headers);
String serverTimestamp = headers.get(SERVER_TIMESTAMP_HEADER);
if (serverTimestamp != null && expireAfter != null) {
LocalDateTime timestamp = parseDateTime(serverTimestamp);
LocalDateTime expirationTime = getExpirationTime(timestamp, expireAfter);
LocalDateTime now = getActualTime();
log.debug(" > isExpired - timestamp " + timestamp + " | expirationTime " + expirationTime + " | now " + now);
// request expired?
return expirationTime.isBefore(now);
}
}
return false;
}
/**
* Returns the actual datetime.
*
* @return LocalDateTime
*/
public static LocalDateTime getActualTime() {
return dfISO8601Parser.parseLocalDateTime(dfISO8601.print(Instant.now()));
}
/**
* Returns the expiration time, based on the actual time
* in addition with the expireAfter value.
*
* @param expireAfter - in seconds
* @return expiration time
*/
public static LocalDateTime getExpirationTime(int expireAfter) {
return getExpirationTime(getActualTime(), expireAfter);
}
/**
* Returns the expiration time based on the given timestamp
* in addition with the expireAfter value.
*
* @param serverTimestamp serverTimestamp
* @param expireAfter - in seconds
* @return expiration time.
*/
public static LocalDateTime getExpirationTime(String serverTimestamp, int expireAfter) {
return getExpirationTime(parseDateTime(serverTimestamp), expireAfter);
}
/**
* Parses the given string to a LocalDateTime object.
*
* @param datetime datetime
* @return LocalDateTime
*/
public static LocalDateTime parseDateTime(String datetime) {
return dfISO8601Parser.parseLocalDateTime(localizeTimestamp(datetime));
}
/**
* Prints the given datetime as a string.
*
* @param datetime datetime
* @return String
*/
public static String printDateTime(LocalDateTime datetime) {
return dfISO8601.print(datetime);
}
/**
* Returns the expiration time.
*
* @param timestamp timestamp
* @param expireAfter expireAfter
* @return expiration time.
*/
private static LocalDateTime getExpirationTime(LocalDateTime timestamp, int expireAfter) {
LocalDateTime expirationTime = timestamp.plusSeconds(expireAfter);
log.debug("getExpirationTime: " + expirationTime);
return expirationTime;
}
/**
* Sets an "X-Expire-After" header.
* If such a header already exist, it's overridden by the new value.
*
* @param request request
* @param expireAfter expireAfter
*/
public static void setExpireAfter(HttpRequest request, int expireAfter) {
if (request.getHeaders() == null) {
request.setHeaders(new CaseInsensitiveHeaders());
}
setExpireAfter(request.getHeaders(), expireAfter);
}
/**
* Sets an "X-Expire-After" header.
* If such a header already exist, it's overridden by the new value.
*
* @param request request
* @param expireAfter expireAfter
*/
public static void setExpireAfter(HttpServerRequest request, int expireAfter) {
setExpireAfter(request.headers(), expireAfter);
}
/**
* Sets an "X-Expire-After" header.
* If such a header already exist, it's overridden by the new value.
*
* @param headers headers
* @param expireAfter expireAfter
*/
public static void setExpireAfter(MultiMap headers, int expireAfter) {
if (headers.get(EXPIRE_AFTER_HEADER) != null) {
headers.remove(EXPIRE_AFTER_HEADER);
}
headers.set(EXPIRE_AFTER_HEADER, String.valueOf(expireAfter));
}
/**
* Transform a timestamp to local time timestamp it is UTC.
* If the timestamp is not parsable, do nothing.
*
* @param timestamp - the timestamp
* @return String
*/
private static String localizeTimestamp(String timestamp) {
String localizedTimestamp = timestamp;
if (localizedTimestamp != null && localizedTimestamp.toUpperCase().endsWith("Z")) {
try {
DateTime dt = isoDateTimeParser.parseDateTime(localizedTimestamp);
localizedTimestamp = dfISO8601.print(dt);
} catch (IllegalArgumentException e) {
log.warn("Could not parse: " + localizedTimestamp);
}
}
return localizedTimestamp;
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy