git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2022 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.netatmo.internal;
  14
  15 import java.time.ZoneId;
  16 import java.time.ZonedDateTime;
  17 import java.time.temporal.ChronoUnit;
  18 import java.util.Calendar;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 /**
  26  * {@link RefreshStrategy} is the class used to embed the refreshing
  27  * needs calculation for devices
  28  *
  29  * @author Gaël L'hopital - Initial contribution
  30  *
  31  */
  32 @NonNullByDefault
  33 public class RefreshStrategy {
  34
  35     private Logger logger = LoggerFactory.getLogger(RefreshStrategy.class);
  36
  37     private static final int DEFAULT_DELAY = 30; // in seconds
  38     private static final int SEARCH_REFRESH_INTERVAL = 120; // in seconds
  39     private int dataValidityPeriod;
  40     private long dataTimeStamp;
  41     private boolean searchRefreshInterval;
  42     @Nullable
  43     private Integer dataTimestamp0;
  44
  45     // By default we create dataTimeStamp to be outdated
  46     // A null or negative value for dataValidityPeriod will trigger an automatic search of the validity period
  47     public RefreshStrategy(int dataValidityPeriod) {
  48         if (dataValidityPeriod <= 0) {
  49             this.dataValidityPeriod = 0;
  50             this.searchRefreshInterval = true;
  51             logger.debug("Data validity period search...");
  52         } else {
  53             this.dataValidityPeriod = dataValidityPeriod;
  54             this.searchRefreshInterval = false;
  55             logger.debug("Data validity period set to {} ms", this.dataValidityPeriod);
  56         }
  57         expireData();
  58     }
  59
  60     @SuppressWarnings("null")
  61     public void setDataTimeStamp(Integer dataTimestamp, ZoneId zoneId) {
  62         if (searchRefreshInterval) {
  63             if (dataTimestamp0 == null) {
  64                 dataTimestamp0 = dataTimestamp;
  65                 logger.debug("First data timestamp is {}", dataTimestamp0);
  66             } else if (dataTimestamp.intValue() > dataTimestamp0.intValue()) {
  67                 dataValidityPeriod = (dataTimestamp.intValue() - dataTimestamp0.intValue()) * 1000;
  68                 searchRefreshInterval = false;
  69                 logger.debug("Data validity period found : {} ms", this.dataValidityPeriod);
  70             } else {
  71                 logger.debug("Data validity period not yet found - data timestamp unchanged");
  72             }
  73         }
  74         this.dataTimeStamp = ChannelTypeUtils.toZonedDateTime(dataTimestamp, zoneId).toInstant().toEpochMilli();
  75     }
  76
  77     public long dataAge() {
  78         long now = Calendar.getInstance().getTimeInMillis();
  79         return now - dataTimeStamp;
  80     }
  81
  82     public boolean isDataOutdated() {
  83         return dataAge() >= dataValidityPeriod;
  84     }
  85
  86     public long nextRunDelayInS() {
  87         return searchRefreshInterval ? SEARCH_REFRESH_INTERVAL
  88                 : Math.max(0, (dataValidityPeriod - dataAge())) / 1000 + DEFAULT_DELAY;
  89     }
  90
  91     public void expireData() {
  92         ZonedDateTime now = ZonedDateTime.now().minus(this.dataValidityPeriod, ChronoUnit.MILLIS);
  93         dataTimeStamp = now.toInstant().toEpochMilli();
  94     }
  95
  96     public boolean isSearchingRefreshInterval() {
  97         return searchRefreshInterval && dataTimestamp0 != null;
  98     }
  99 }