org.openbase.bco.dal.remote.service

Class ServiceRemoteManager<D>

java.lang.Object

org.openbase.bco.dal.remote.service.ServiceRemoteManager<D>

All Implemented Interfaces:

org.openbase.jul.iface.Activatable, org.openbase.jul.iface.provider.PingProvider, org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>, org.openbase.jul.pattern.provider.DataProvider<D>

public abstract class ServiceRemoteManager<D>
extends Object
implements org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>, org.openbase.jul.iface.provider.PingProvider, org.openbase.jul.pattern.provider.DataProvider<D>

Author:

Divine Threepwood

Constructor Summary

Constructors

Constructor and Description
ServiceRemoteManager(org.openbase.jul.pattern.provider.DataProvider<D> responsibleInstance)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addDataObserver(org.openbase.jul.pattern.Observer<D> observer)
Future<rst.domotic.action.ActionFutureType.ActionFuture>	applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription)
void	applyConfigUpdate(List<String> unitIDList)
void	deactivate()
D	getData()
Class<D>	getDataClass()
CompletableFuture<D>	getDataFuture()
protected abstract Set<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType>	getManagedServiceTypes()
Long	getPing()
AbstractServiceRemote	getServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
List<AbstractServiceRemote>	getServiceRemoteList()
boolean	isActive()
boolean	isDataAvailable()
boolean	isServiceAvailable(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType) Method checks if the given ServiceType is currently available by this ServiceRemoteManager
protected abstract void	notifyServiceUpdate(org.openbase.jul.pattern.Observable source, Object data)
Future<Long>	ping()
Future<rst.domotic.action.SnapshotType.Snapshot>	recordSnapshot()
Future<rst.domotic.action.SnapshotType.Snapshot>	recordSnapshot(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
void	removeDataObserver(org.openbase.jul.pattern.Observer<D> observer)
<B> Future<B>	requestData(B builder)
Future<Void>	restoreSnapshot(rst.domotic.action.SnapshotType.Snapshot snapshot)
<B> B	updateBuilderWithAvailableServiceStates(B builder)
<B> B	updateBuilderWithAvailableServiceStates(B builder, Class dataClass, Set<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> supportedServiceTypeSet)
void	waitForData()
void	waitForData(long timeout, TimeUnit timeUnit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceRemoteManager

public ServiceRemoteManager(org.openbase.jul.pattern.provider.DataProvider<D> responsibleInstance)

Method Detail

applyConfigUpdate

public void applyConfigUpdate(List<String> unitIDList)
                       throws org.openbase.jul.exception.CouldNotPerformException,
                              InterruptedException

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

activate

public void activate()
              throws org.openbase.jul.exception.CouldNotPerformException,
                     InterruptedException

Specified by:

activate in interface org.openbase.jul.iface.Activatable

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

deactivate

public void deactivate()
                throws InterruptedException,
                       org.openbase.jul.exception.CouldNotPerformException

Specified by:

deactivate in interface org.openbase.jul.iface.Activatable

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

isActive

public boolean isActive()

Specified by:

isActive in interface org.openbase.jul.iface.Activatable

getServiceRemoteList

public List<AbstractServiceRemote> getServiceRemoteList()

isServiceAvailable

public boolean isServiceAvailable(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)

Method checks if the given ServiceType is currently available by this ServiceRemoteManager

Parameters:

serviceType - the ServiceType to check.

Returns:

returns true if the ServiceType is available, otherwise false.

getServiceRemote

public AbstractServiceRemote getServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
                                       throws org.openbase.jul.exception.NotAvailableException

Throws:

org.openbase.jul.exception.NotAvailableException

updateBuilderWithAvailableServiceStates

public <B> B updateBuilderWithAvailableServiceStates(B builder)
                                              throws InterruptedException,
                                                     org.openbase.jul.exception.CouldNotPerformException

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

updateBuilderWithAvailableServiceStates

public <B> B updateBuilderWithAvailableServiceStates(B builder,
                                                     Class dataClass,
                                                     Set<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> supportedServiceTypeSet)
                                              throws InterruptedException

Throws:

InterruptedException

recordSnapshot

public Future<rst.domotic.action.SnapshotType.Snapshot> recordSnapshot()
                                                                throws org.openbase.jul.exception.CouldNotPerformException,
                                                                       InterruptedException

Specified by:

recordSnapshot in interface org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

recordSnapshot

public Future<rst.domotic.action.SnapshotType.Snapshot> recordSnapshot(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                                throws org.openbase.jul.exception.CouldNotPerformException,
                                                                       InterruptedException

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

restoreSnapshot

public Future<Void> restoreSnapshot(rst.domotic.action.SnapshotType.Snapshot snapshot)
                             throws org.openbase.jul.exception.CouldNotPerformException,
                                    InterruptedException

Specified by:

restoreSnapshot in interface org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

ping

public Future<Long> ping()

Specified by:

ping in interface org.openbase.jul.iface.provider.PingProvider

Returns:

getPing

public Long getPing()

Specified by:

getPing in interface org.openbase.jul.iface.provider.PingProvider

Returns:

applyAction

public Future<rst.domotic.action.ActionFutureType.ActionFuture> applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription)
                                                                     throws org.openbase.jul.exception.CouldNotPerformException,
                                                                            InterruptedException

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

getManagedServiceTypes

protected abstract Set<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> getManagedServiceTypes()
                                                                                                            throws org.openbase.jul.exception.NotAvailableException,
                                                                                                                   InterruptedException

Throws:

org.openbase.jul.exception.NotAvailableException

InterruptedException

notifyServiceUpdate

protected abstract void notifyServiceUpdate(org.openbase.jul.pattern.Observable source,
                                            Object data)
                                     throws org.openbase.jul.exception.NotAvailableException,
                                            InterruptedException

Throws:

org.openbase.jul.exception.NotAvailableException

InterruptedException

isDataAvailable

public boolean isDataAvailable()

Specified by:

isDataAvailable in interface org.openbase.jul.pattern.provider.DataProvider<D>

getDataClass

public Class<D> getDataClass()

Specified by:

getDataClass in interface org.openbase.jul.pattern.provider.DataProvider<D>

getData

public D getData()
          throws org.openbase.jul.exception.NotAvailableException

Specified by:

getData in interface org.openbase.jul.pattern.provider.DataProvider<D>

Throws:

org.openbase.jul.exception.NotAvailableException

getDataFuture

public CompletableFuture<D> getDataFuture()

Specified by:

getDataFuture in interface org.openbase.jul.pattern.provider.DataProvider<D>

addDataObserver

public void addDataObserver(org.openbase.jul.pattern.Observer<D> observer)

Specified by:

addDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<D>

removeDataObserver

public void removeDataObserver(org.openbase.jul.pattern.Observer<D> observer)

Specified by:

removeDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<D>

waitForData

public void waitForData()
                 throws org.openbase.jul.exception.CouldNotPerformException,
                        InterruptedException

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<D>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

waitForData

public void waitForData(long timeout,
                        TimeUnit timeUnit)
                 throws org.openbase.jul.exception.CouldNotPerformException,
                        InterruptedException

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<D>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

requestData

public <B> Future<B> requestData(B builder)
                          throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException