Package com.societegenerale.failover.core.expiry

Class DefaultExpiryPolicy<T>

java.lang.Object
com.societegenerale.failover.core.expiry.DefaultExpiryPolicy<T>
Type Parameters:
T - the payload type whose expiry this policy governs
All Implemented Interfaces:
ExpiryPolicy<T>
public class DefaultExpiryPolicy<T> extends Object implements ExpiryPolicy<T>
Default ExpiryPolicy that computes expiry by adding the annotation-configured duration to the current clock time, and checks expiry against the current clock.
Author:
Anand Manissery

  • Constructor Details

    • DefaultExpiryPolicy

      public DefaultExpiryPolicy()

  • Method Details

    • computeExpiry

      public Instant computeExpiry(Failover failover)
      Description copied from interface: ExpiryPolicy
      Computes the expiry instant for a payload stored under the given failover.

      Implementation contract: Must return a non-null instant in the future relative to "now" — a freshly stored payload must not already be expired. The result is stored as the payload's expireOn. Verify your implementation with ExpiryPolicyContractVerifier.

      Specified by:
      computeExpiry in interface ExpiryPolicy<T>
      Parameters:
      failover - annotation metadata containing the configured expiry duration and unit
      Returns:
      the absolute instant after which the stored payload should be considered expired

    • isExpired

      public boolean isExpired(Failover failover, ReferentialPayload<T> referentialPayload)
      Description copied from interface: ExpiryPolicy
      Returns true if the stored payload has expired.

      Implementation contract: Must decide expiry from the payload's expireOn relative to the current time (consistent with ExpiryPolicy.computeExpiry(com.societegenerale.failover.annotations.Failover)): an entry stored a moment ago is not expired; an entry whose expireOn is in the past is. Must be side-effect-free.

      Specified by:
      isExpired in interface ExpiryPolicy<T>
      Parameters:
      failover - annotation metadata for the failover point
      referentialPayload - the stored payload to check
      Returns:
      true if the payload's expiry time is in the past