org.swisspush.gateleen.queue.expiry

Class ExpiryCheckHandler

java.lang.Object

org.swisspush.gateleen.queue.expiry.ExpiryCheckHandler

public final class ExpiryCheckHandler
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXPIRE_AFTER_HEADER
static java.lang.String	QUEUE_EXPIRE_AFTER_HEADER
static java.lang.String	SERVER_TIMESTAMP_HEADER

Method Summary

Modifier and Type	Method and Description
static org.joda.time.LocalDateTime	getActualTime() Returns the actual datetime.
static org.joda.time.LocalDateTime	getExpirationTime(int expireAfter) Returns the expiration time, based on the actual time in addition with the expireAfter value.
static org.joda.time.LocalDateTime	getExpirationTime(java.lang.String serverTimestamp, int expireAfter) Returns the expiration time based on the given timestamp in addition with the expireAfter value.
static java.lang.Integer	getExpireAfter(io.vertx.core.MultiMap headers) Extracts the value of the "X-Expire-After" header.
static java.lang.Integer	getQueueExpireAfter(io.vertx.core.MultiMap headers) Extracts the value of the "x-queue-expire-after" header.
static boolean	isExpired(org.swisspush.gateleen.core.http.HttpRequest request) Checks if the given request has expired or not.
static boolean	isExpired(io.vertx.core.http.HttpServerRequest request) Checks if the given request has expired or not.
static boolean	isExpired(io.vertx.core.MultiMap headers) Checks the expiration based on the given headers.
static boolean	isExpired(io.vertx.core.MultiMap headers, java.lang.Long timestamp) Checks the expiration based on the given headers and a timstamp in milliseconds.
static org.joda.time.LocalDateTime	parseDateTime(java.lang.String datetime) Parses the given string to a LocalDateTime object.
static java.lang.String	printDateTime(org.joda.time.LocalDateTime datetime) Prints the given datetime as a string.
static void	setExpireAfter(org.swisspush.gateleen.core.http.HttpRequest request, int expireAfter) Sets an "X-Expire-After" header.
static void	setExpireAfter(io.vertx.core.http.HttpServerRequest request, int expireAfter) Sets an "X-Expire-After" header.
static void	setExpireAfter(io.vertx.core.MultiMap headers, int expireAfter) Sets an "X-Expire-After" header.
static void	setQueueExpireAfter(org.swisspush.gateleen.core.http.HttpRequest request, int queueExpireAfter) Sets an "x-queue-expire-after" header.
static void	setQueueExpireAfter(io.vertx.core.http.HttpServerRequest request, int queueExpireAfter) Sets an "x-queue-expire-after" header.
static void	setQueueExpireAfter(io.vertx.core.MultiMap headers, int queueExpireAfter) Sets an "x-queue-expire-after" header.
static void	updateServerTimestampHeader(org.swisspush.gateleen.core.http.HttpRequest request) Checks if a "X-Server-Timestamp" header is set or not.
static void	updateServerTimestampHeader(io.vertx.core.http.HttpServerRequest request) Checks if a "X-Server-Timestamp" header is set or not.
static void	updateServerTimestampHeader(io.vertx.core.MultiMap headers) Checks if a "X-Server-Timestamp" header is set or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVER_TIMESTAMP_HEADER

public static final java.lang.String SERVER_TIMESTAMP_HEADER

See Also:

Constant Field Values

EXPIRE_AFTER_HEADER

public static final java.lang.String EXPIRE_AFTER_HEADER

See Also:

Constant Field Values

QUEUE_EXPIRE_AFTER_HEADER

public static final java.lang.String QUEUE_EXPIRE_AFTER_HEADER

See Also:

Constant Field Values

Method Detail

updateServerTimestampHeader

public static void updateServerTimestampHeader(org.swisspush.gateleen.core.http.HttpRequest request)

Checks if a "X-Server-Timestamp" header is set or not. If no valid value is found, the actual timestamp is set.

Parameters:

request - request

updateServerTimestampHeader

public static void updateServerTimestampHeader(io.vertx.core.http.HttpServerRequest request)

Checks if a "X-Server-Timestamp" header is set or not. If no valid value is found, the actual timestamp is set.

Parameters:

request - request

updateServerTimestampHeader

public static void updateServerTimestampHeader(io.vertx.core.MultiMap headers)

Checks if a "X-Server-Timestamp" header is set or not. If no valid value is found, the actual timestamp is set.

Parameters:

headers - headers

getExpireAfter

public static java.lang.Integer getExpireAfter(io.vertx.core.MultiMap headers)

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.

Parameters:

headers - headers

Returns:

expire-after time in seconds or null if nothing is found

getQueueExpireAfter

public static java.lang.Integer getQueueExpireAfter(io.vertx.core.MultiMap headers)

Extracts the value of the "x-queue-expire-after" header. If the value can't be extracted (not found, invalid, and so on), null is returned.

Parameters:

headers - headers

Returns:

queue-expire-after time in seconds or null if nothing is found

isExpired

public static boolean isExpired(org.swisspush.gateleen.core.http.HttpRequest request)

Checks if the given request has expired or not. If no "X-Expire-After" or "X-Server-Timestamp" is found false is returned.

Parameters:

request - request

Returns:

true if the request has expired, false otherwise

isExpired

public static boolean isExpired(io.vertx.core.http.HttpServerRequest request)

Checks if the given request has expired or not. If no "X-Expire-After" or "X-Server-Timestamp" is found false is returned.

Parameters:

request - request

Returns:

true if the request has expired, false otherwise

isExpired

public static boolean isExpired(io.vertx.core.MultiMap headers)

Checks the expiration based on the given headers. If "X-Expire-After" or "x-queue-expire-after" and no "X-Server-Timestamp" is found false is returned.

Parameters:

headers - headers

Returns:

true if the request has expired, false otherwise

isExpired

public static boolean isExpired(io.vertx.core.MultiMap headers,
                                java.lang.Long timestamp)

Checks the expiration based on the given headers and a timstamp in milliseconds.

Parameters:

headers - headers

Returns:

true if the request has expired, false otherwise

getActualTime

public static org.joda.time.LocalDateTime getActualTime()

Returns the actual datetime.

Returns:

LocalDateTime

getExpirationTime

public static org.joda.time.LocalDateTime getExpirationTime(int expireAfter)

Returns the expiration time, based on the actual time in addition with the expireAfter value.

Parameters:

expireAfter - - in seconds

Returns:

expiration time

getExpirationTime

public static org.joda.time.LocalDateTime getExpirationTime(java.lang.String serverTimestamp,
                                                            int expireAfter)

Returns the expiration time based on the given timestamp in addition with the expireAfter value.

Parameters:

serverTimestamp - serverTimestamp

expireAfter - - in seconds

Returns:

expiration time.

parseDateTime

public static org.joda.time.LocalDateTime parseDateTime(java.lang.String datetime)

Parses the given string to a LocalDateTime object.

Parameters:

datetime - datetime

Returns:

LocalDateTime

printDateTime

public static java.lang.String printDateTime(org.joda.time.LocalDateTime datetime)

Prints the given datetime as a string.

Parameters:

datetime - datetime

Returns:

String

setQueueExpireAfter

public static void setQueueExpireAfter(org.swisspush.gateleen.core.http.HttpRequest request,
                                       int queueExpireAfter)

Sets an "x-queue-expire-after" header. If such a header already exist, it's overridden by the new value.

Parameters:

request - request

queueExpireAfter - expireAfter

setExpireAfter

public static void setExpireAfter(org.swisspush.gateleen.core.http.HttpRequest request,
                                  int expireAfter)

Sets an "X-Expire-After" header. If such a header already exist, it's overridden by the new value.

Parameters:

request - request

expireAfter - expireAfter

setQueueExpireAfter

public static void setQueueExpireAfter(io.vertx.core.http.HttpServerRequest request,
                                       int queueExpireAfter)

Sets an "x-queue-expire-after" header. If such a header already exist, it's overridden by the new value.

Parameters:

request - request

queueExpireAfter - expireAfter

setExpireAfter

public static void setExpireAfter(io.vertx.core.http.HttpServerRequest request,
                                  int expireAfter)

Sets an "X-Expire-After" header. If such a header already exist, it's overridden by the new value.

Parameters:

request - request

expireAfter - expireAfter

setQueueExpireAfter

public static void setQueueExpireAfter(io.vertx.core.MultiMap headers,
                                       int queueExpireAfter)

Sets an "x-queue-expire-after" header. If such a header already exist, it's overridden by the new value.

Parameters:

headers - headers

queueExpireAfter - queueExpireAfter

setExpireAfter

public static void setExpireAfter(io.vertx.core.MultiMap headers,
                                  int expireAfter)

Sets an "X-Expire-After" header. If such a header already exist, it's overridden by the new value.

Parameters:

headers - headers

expireAfter - expireAfter