org.somda.sdc.glue.consumer.ConsumerConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of glue Show documentation

SDCri is a set of Java libraries that implements a network communication framework conforming with the IEEE 11073 SDC specifications. This project implements the 11073-20702 SDC glue binding.

There is a newer version: 5.1.1

Show newest version

package org.somda.sdc.glue.consumer;

/**
 * Configuration for the SDC consumer side.
 *
 * @see org.somda.sdc.glue.guice.DefaultGlueConfigModule
 */
public class ConsumerConfig {
    /**
     * Configures the period for {@linkplain SdcRemoteDevice} watchdog jobs.
     *
     * 
     * Data type: {@linkplain java.time.Duration}
     * 
Use: optional
     * 
     */
    public static final String WATCHDOG_PERIOD = "SdcGlue.Consumer.WatchdogPeriod";

    /**
     * Configures the default expiration time requested for subscribe requests.
     *
     * 
     * Data type: {@linkplain java.time.Duration}
     * 
Use: optional
     * 
     */
    public static final String REQUESTED_EXPIRES = "SdcGlue.Consumer.RequestedExpires";

    /**
     * Default timeout for awaiting of transaction objects.
     * 
     * This duration is used to sort out stale reports.
     * Its value defines the threshold from which on a report counts as stale.
     *
     * 

     * Data type: {@linkplain java.time.Duration}
     * 
Use: optional
     * 
     */
    public static final String AWAITING_TRANSACTION_TIMEOUT = "SdcGlue.Consumer.AwaitingTransactionTimeout";


    /**
     * Enable applying reports which have the same MDIB version as the current
     * {@linkplain org.somda.sdc.biceps.common.storage.MdibStorage}.
     * 
     * This useful for testing purposes, as there are requirements where this behavior is of interest.
     *
     * 

     * Data type: {@linkplain Boolean}
     * 
Use: optional
     * 
     */
    public static final String APPLY_REPORTS_SAME_MDIB_VERSION = "SdcGlue.Consumer.ApplyReportsWithSameMdibVersion";
}