org.somda.sdc.glue.consumer.SdcRemoteDevice 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;

import com.google.common.util.concurrent.Service;
import org.somda.sdc.biceps.common.access.MdibAccess;
import org.somda.sdc.biceps.common.access.MdibAccessObservable;
import org.somda.sdc.biceps.model.message.AbstractSet;
import org.somda.sdc.biceps.model.message.GetLocalizedText;
import org.somda.sdc.biceps.model.message.GetSupportedLanguages;
import org.somda.sdc.dpws.service.HostingServiceProxy;
import org.somda.sdc.glue.consumer.localization.LocalizationServiceAccess;

import java.math.BigInteger;
import java.util.List;
import java.util.function.Consumer;

/**
 * SDC consumer device interface.
 * 
 * The purpose of {@linkplain SdcRemoteDevice} is to receive SDC data from the network.
 */
public interface SdcRemoteDevice extends Service {
    /**
     * Gets the hosting service proxy.
     * 

     * The hosting service proxy can be used to access the device including metadata and services.
     *
     * @return the hosting service proxy bundled with the SDC remote device instance.
     */
    HostingServiceProxy getHostingServiceProxy();

    /**
     * Read access to the remote MDIB.
     * 

     * The remote MDIB is updated by a background process that processes incoming reports.
     * In order to manually access Web Services, one can use {@link #getHostingServiceProxy()}.
     *
     * @return MDIB access to read the remote MDIB.
     */
    MdibAccess getMdibAccess();

    /**
     * Gets an interface to subscribe for MDIB updates.
     *
     * @return the MDIB observable interface.
     */
    MdibAccessObservable getMdibAccessObservable();

    /**
     * Gets a set service invoker access.
     * 

     * Please note that the set service access only works if the context and/or set service are available from
     * the remote device.
     * If not set service exists, any call to the {@link SetServiceAccess} interface results in an immediately cancelled
     * future.
     *
     * @return a set service invoker access interface.
     * @see SetServiceAccess#invoke(AbstractSet, Class)
     * @see SetServiceAccess#invoke(AbstractSet, Consumer, Class)
     */
    SetServiceAccess getSetServiceAccess();

    /**
     * In order to get notified on disconnect events, this function attaches a watchdog observer.
     *
     * @param watchdogObserver the watchdog callback interface.
     */
    void registerWatchdogObserver(WatchdogObserver watchdogObserver);

    /**
     * Removes a watchdog observer.
     *
     * @param watchdogObserver the watchdog observer to remove.
     */
    void unregisterWatchdogObserver(WatchdogObserver watchdogObserver);

    /**
     * Gets a localization service invoker access.
     * 
     * Please note that the localization service access only works if the service is available from the remote device.
     * If no localization service exists, any call to the {@link LocalizationServiceAccess} interface
     * results in an immediately cancelled future.
     *
     * @return a localization service invoker access interface.
     * @see LocalizationServiceAccess#getLocalizedText(GetLocalizedText)
     * @see LocalizationServiceAccess#getSupportedLanguages(GetSupportedLanguages)
     * @see LocalizationServiceAccess#cachePrefetch(BigInteger)
     * @see LocalizationServiceAccess#cachePrefetch(BigInteger, List)
     */
    LocalizationServiceAccess getLocalizationServiceAccess();
}