org.openbase.bco.dal.remote.service

Class AbstractServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

java.lang.Object

org.openbase.bco.dal.remote.service.AbstractServiceRemote<S,ST>

Type Parameters:

S - generic definition of the overall service type for this remote.

ST - the corresponding state for the service type of this remote.

All Implemented Interfaces:

Service, ServiceRemote<S,ST>, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Initializable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Lockable, org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Shutdownable, org.openbase.jul.pattern.provider.DataProvider<ST>, org.openbase.jul.pattern.Remote<ST>

Direct Known Subclasses:

ActivationStateServiceRemote, BlindStateServiceRemote, BrightnessStateServiceRemote, ColorStateServiceRemote, ContactStateServiceRemote, HandleStateServiceRemote, IlluminanceStateServiceRemote, MotionStateServiceRemote, PowerConsumptionStateServiceRemote, PowerStateServiceRemote, PresenceStateServiceRemote, SmokeAlarmStateServiceRemote, SmokeStateServiceRemote, StandbyStateServiceRemote, TamperStateServiceRemote, TargetTemperatureStateServiceRemote, TemperatureStateServiceRemote

public abstract class AbstractServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>
extends Object
implements ServiceRemote<S,ST>

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.pattern.Remote

org.openbase.jul.pattern.Remote.ConnectionState

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
protected Object	maintainer
protected org.openbase.jul.pattern.ObservableImpl<ST>	serviceStateObservable

Fields inherited from interface org.openbase.bco.dal.lib.layer.service.Service

SERVICE_LABEL, SERVICE_STATE_PACKAGE

Constructor Summary

Constructors

Constructor and Description
AbstractServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType, Class<ST> serviceDataClass) AbstractServiceRemote constructor.

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addDataObserver(org.openbase.jul.pattern.Observer<ST> observer) Add an observer to get notifications when the service state changes.
Future<Void>	applyAction(rst.domotic.action.ActionConfigType.ActionConfig actionConfig)
protected abstract ST	computeServiceState() Compute the service state of this service collection if an underlying service changes.
void	deactivate()
ST	getData()
Class<ST>	getDataClass()
Collection<UnitRemote>	getInternalUnits() Returns a collection of all internally used unit remotes.
Collection<S>	getServices() Returns a collection of all internally used unit remotes.
Collection<S>	getServices(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType) Returns a collection of all internally used unit remotes filtered by the given unit type.
ST	getServiceState() Deprecated. please use getData instead.
rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType	getServiceType() Returns the service type of this remote.
boolean	hasInternalRemotes()
void	init(Collection<rst.domotic.unit.UnitConfigType.UnitConfig> configs) Initializes this service remote with a set of unit configurations.
void	init(rst.domotic.unit.UnitConfigType.UnitConfig config)
boolean	isActive()
boolean	isConnected() Checks if a server connection is established for every underlying remote.
boolean	isDataAvailable() Check if the data object is already available for every underlying remote.
boolean	isLocked()
void	lock(Object maintainer)
void	removeDataObserver(org.openbase.jul.pattern.Observer<ST> observer) Remove an observer for the service state.
void	removeUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
CompletableFuture<ST>	requestData(boolean failOnError) Method request the data of all internal unit remotes.
void	shutdown()
String	toString() Returns a short instance description.
void	unlock(Object maintainer) Method unlocks this instance.
void	verifyMaintainability()
static boolean	verifyServiceCompatibility(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
void	waitForData() Method blocks until an initial data message was dataObserverreceived from every remote controller.
void	waitForData(long timeout, TimeUnit timeUnit) Method blocks until an initial data message was received from every remote controller or the given timeout is reached.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.ServiceRemote

activate, addConnectionStateObserver, getConnectionState, removeConnectionStateObserver, requestData

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.Service

detectServiceDataClass, detectServiceMethod, detectServiceMethod, getArgumentClasses, getServiceBaseName, getServicePrefix, getServiceStateName, getServiceStateName, invokeOperationServiceMethod, invokeProviderServiceMethod, invokeServiceMethod, invokeServiceMethod

Methods inherited from interface org.openbase.jul.pattern.Remote

getDataFuture

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook

Field Detail

logger

protected final org.slf4j.Logger logger

serviceStateObservable

protected final org.openbase.jul.pattern.ObservableImpl<ST extends com.google.protobuf.GeneratedMessage> serviceStateObservable

maintainer

protected Object maintainer

Constructor Detail

AbstractServiceRemote

public AbstractServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
                             Class<ST> serviceDataClass)

AbstractServiceRemote constructor.

Parameters:

serviceType - The remote service type.

serviceDataClass - The service data class.

Method Detail

computeServiceState

protected abstract ST computeServiceState()
                                   throws org.openbase.jul.exception.CouldNotPerformException

Compute the service state of this service collection if an underlying service changes.

Returns:

the computed server state is returned.

Throws:

org.openbase.jul.exception.CouldNotPerformException - if an underlying service throws an exception

getServiceState

@Deprecated
public ST getServiceState()
                               throws org.openbase.jul.exception.NotAvailableException

Deprecated. please use getData instead.

Specified by:

getServiceState in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Returns:

the current service state

Throws:

org.openbase.jul.exception.NotAvailableException - if the service state has not been set at least once.

getData

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

Specified by:

getData in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Specified by:

getData in interface org.openbase.jul.pattern.Remote<ST extends com.google.protobuf.GeneratedMessage>

Returns:

the current service state

Throws:

org.openbase.jul.exception.NotAvailableException - if the service state data has not been set at least once.

addDataObserver

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

Add an observer to get notifications when the service state changes.

Specified by:

addDataObserver in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Specified by:

addDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Parameters:

observer - the observer which is notified

removeDataObserver

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

Remove an observer for the service state.

Specified by:

removeDataObserver in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Specified by:

removeDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Parameters:

observer - the observer which has been registered

getDataClass

public Class<ST> getDataClass()

Specified by:

getDataClass in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Specified by:

getDataClass in interface org.openbase.jul.pattern.Remote<ST extends com.google.protobuf.GeneratedMessage>

requestData

public CompletableFuture<ST> requestData(boolean failOnError)
                                  throws org.openbase.jul.exception.CouldNotPerformException

Method request the data of all internal unit remotes.

Specified by:

requestData in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Parameters:

failOnError - flag decides if an exception should be thrown in case one data request fails.

Returns:

the recalculated server state data based on the newly requested data.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if non of the request was successful. In case the failOnError is set to true any request error throws an CouldNotPerformException.

init

public void init(rst.domotic.unit.UnitConfigType.UnitConfig config)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Specified by:

init in interface org.openbase.jul.iface.Initializable<rst.domotic.unit.UnitConfigType.UnitConfig>

Parameters:

config -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

init

public void init(Collection<rst.domotic.unit.UnitConfigType.UnitConfig> configs)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Initializes this service remote with a set of unit configurations. Each of the units referred by the given configurations should provide the service type of this service remote.

Specified by:

init in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Parameters:

configs - a set of unit configurations.

Throws:

org.openbase.jul.exception.InitializationException - is thrown if the service remote could not be initialized.

InterruptedException - is thrown if the current thread is externally interrupted.

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 org.openbase.jul.exception.CouldNotPerformException,
                       InterruptedException

Specified by:

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

shutdown

public void shutdown()

Specified by:

shutdown in interface org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>

Specified by:

shutdown in interface org.openbase.jul.iface.Shutdownable

isActive

public boolean isActive()

Specified by:

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

Returns:

removeUnit

public void removeUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
                throws org.openbase.jul.exception.CouldNotPerformException,
                       InterruptedException

Specified by:

removeUnit in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

getInternalUnits

public Collection<UnitRemote> getInternalUnits()

Returns a collection of all internally used unit remotes.

Specified by:

getInternalUnits in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Returns:

a collection of unit remotes limited to the service interface.

hasInternalRemotes

public boolean hasInternalRemotes()

Specified by:

hasInternalRemotes in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

getServices

public Collection<S> getServices()

Returns a collection of all internally used unit remotes.

Specified by:

getServices in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Returns:

a collection of unit remotes limited to the service interface.

getServices

public Collection<S> getServices(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)

Returns a collection of all internally used unit remotes filtered by the given unit type.

Specified by:

getServices in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Returns:

a collection of unit remotes limited to the service interface.

getServiceType

public rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType getServiceType()

Returns the service type of this remote.

Specified by:

getServiceType in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Returns:

the remote service type.

applyAction

public Future<Void> applyAction(rst.domotic.action.ActionConfigType.ActionConfig actionConfig)
                         throws org.openbase.jul.exception.CouldNotPerformException,
                                InterruptedException

Specified by:

applyAction in interface Service

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

waitForData

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

Method blocks until an initial data message was dataObserverreceived from every remote controller.

Specified by:

waitForData in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Specified by:

waitForData in interface org.openbase.jul.pattern.Remote<ST extends com.google.protobuf.GeneratedMessage>

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if any error occurs.

InterruptedException - is thrown in case the thread is externally interrupted.

waitForData

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

Method blocks until an initial data message was received from every remote controller or the given timeout is reached.

Specified by:

waitForData in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Specified by:

waitForData in interface org.openbase.jul.pattern.Remote<ST extends com.google.protobuf.GeneratedMessage>

Parameters:

timeout - maximal time to wait for the main controller data. After the timeout is reached a TimeoutException is thrown.

timeUnit - the time unit of the timeout.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case the any error occurs, or if the given timeout is reached. In this case a TimeoutException is thrown.

InterruptedException - is thrown in case the thread is externally interrupted.

isConnected

public boolean isConnected()

Checks if a server connection is established for every underlying remote.

Specified by:

isConnected in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Specified by:

isConnected in interface org.openbase.jul.pattern.Remote<ST extends com.google.protobuf.GeneratedMessage>

Returns:

is true in case that the connection for every underlying remote it established.

isDataAvailable

public boolean isDataAvailable()

Check if the data object is already available for every underlying remote.

Specified by:

isDataAvailable in interface ServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>

Specified by:

isDataAvailable in interface org.openbase.jul.pattern.provider.DataProvider<ST extends com.google.protobuf.GeneratedMessage>

Returns:

is true in case that for every underlying remote data is available.

verifyServiceCompatibility

public static boolean verifyServiceCompatibility(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                                 rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)

verifyMaintainability

public void verifyMaintainability()
                           throws org.openbase.jul.exception.VerificationFailedException

Specified by:

verifyMaintainability in interface org.openbase.jul.iface.Lockable

Throws:

org.openbase.jul.exception.VerificationFailedException

isLocked

public boolean isLocked()

Specified by:

isLocked in interface org.openbase.jul.iface.Lockable

Returns:

lock

public void lock(Object maintainer)
          throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

lock in interface org.openbase.jul.iface.Lockable

Throws:

org.openbase.jul.exception.CouldNotPerformException

unlock

public void unlock(Object maintainer)
            throws org.openbase.jul.exception.CouldNotPerformException

Method unlocks this instance.

Specified by:

unlock in interface org.openbase.jul.iface.Lockable

Parameters:

maintainer - the instance which currently holds the lock.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown if the instance could not be unlocked.

toString

public String toString()

Returns a short instance description.

Overrides:

toString in class Object

Returns:

a description as string.