ExpiryCheckHandler (gateleen-queue 1.1.34 API)

java.lang.Object
- org.swisspush.gateleen.queue.expiry.ExpiryCheckHandler

```
public final class ExpiryCheckHandler
extends 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.

Author:

https://github.com/ljucam [Mario Ljuca]

Field Summary

Fields
Modifier and Type Field and Description

static String EXPIRE_AFTER_HEADER

static String QUEUE_EXPIRE_AFTER_HEADER

static String SERVER_TIMESTAMP_HEADER

Fields
Modifier and Type	Field and Description
`static String`	`EXPIRE_AFTER_HEADER`
`static String`	`QUEUE_EXPIRE_AFTER_HEADER`
`static String`	`SERVER_TIMESTAMP_HEADER`

Method Summary

All Methods Static Methods Concrete Methods
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(String serverTimestamp, int expireAfter)` Returns the expiration time based on the given timestamp in addition with the expireAfter value.
`static Optional<String>`	`getExpirationTimeAsString(int expireAfter)`
`static Integer`	`getExpireAfter(io.vertx.core.MultiMap headers)` Extracts the value of the "X-Expire-After" header.
`static Optional<Integer>`	`getExpireAfterConcerningCaseOfCorruptHeaderAndInfinite(io.vertx.core.MultiMap headers)` Delegates to `getExpireValue(String)` This is extended version of `getExpireAfter(MultiMap)` but also returning -1 for infinite.
`static Integer`	`getQueueExpireAfter(io.vertx.core.MultiMap headers)` Extracts the value of the "x-queue-expire-after" header.
`static boolean`	`isExpired(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, Long timestamp)` Checks the expiration based on the given headers and a timstamp in milliseconds.
`static org.joda.time.LocalDateTime`	`parseDateTime(String datetime)` Parses the given string to a LocalDateTime object.
`static String`	`printDateTime(org.joda.time.LocalDateTime datetime)` Prints the given datetime as a string.
`static void`	`setExpireAfter(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(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(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 String SERVER_TIMESTAMP_HEADER
```
    See Also:
    
    Constant Field Values
  - EXPIRE_AFTER_HEADER
```
public static final String EXPIRE_AFTER_HEADER
```
    See Also:
    
    Constant Field Values
  - QUEUE_EXPIRE_AFTER_HEADER
```
public static final String QUEUE_EXPIRE_AFTER_HEADER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - updateServerTimestampHeader
```
public static void updateServerTimestampHeader(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 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
  - getExpireAfterConcerningCaseOfCorruptHeaderAndInfinite
```
public static Optional<Integer> getExpireAfterConcerningCaseOfCorruptHeaderAndInfinite(io.vertx.core.MultiMap headers)
```
    Delegates to getExpireValue(String) This is extended version of getExpireAfter(MultiMap) but also returning -1 for infinite.
    
    Parameters:
    
    headers - Headers to fetch value from.
    
    Returns:
    
    The parsed expire-after value.
    
    Returns empty in case getExpireValue(String) returned null.
  - getQueueExpireAfter
```
public static 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(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,
                                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(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.
  - getExpirationTimeAsString
```
public static Optional<String> getExpirationTimeAsString(int expireAfter)
```
    Returns:
    
    Expiration time based on passed expireAfter or empty in case of an infinite expiration.
  - parseDateTime
```
public static org.joda.time.LocalDateTime parseDateTime(String datetime)
```
    Parses the given string to a LocalDateTime object.
    
    Parameters:
    
    datetime - datetime
    
    Returns:
    
    LocalDateTime
  - printDateTime
```
public static String printDateTime(org.joda.time.LocalDateTime datetime)
```
    Prints the given datetime as a string.
    
    Parameters:
    
    datetime - datetime
    
    Returns:
    
    String
  - setQueueExpireAfter
```
public static void setQueueExpireAfter(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(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

Class ExpiryCheckHandler

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVER_TIMESTAMP_HEADER

EXPIRE_AFTER_HEADER

QUEUE_EXPIRE_AFTER_HEADER

Method Detail

updateServerTimestampHeader

updateServerTimestampHeader

updateServerTimestampHeader

getExpireAfter

getExpireAfterConcerningCaseOfCorruptHeaderAndInfinite

getQueueExpireAfter

isExpired

isExpired

isExpired

isExpired

getActualTime

getExpirationTime

getExpirationTime

getExpirationTimeAsString

parseDateTime

printDateTime

setQueueExpireAfter

setExpireAfter

setQueueExpireAfter

setExpireAfter

setQueueExpireAfter

setExpireAfter