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, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Initializable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Shutdownable

Direct Known Subclasses:

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

public abstract class AbstractServiceRemote<S extends Service,ST extends com.google.protobuf.GeneratedMessage>
extends Object
implements Service, org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>

Author:

Divine Threepwood

Nested Class Summary

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 org.openbase.jul.pattern.ObservableImpl<ST>	serviceStateObservable

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

SERVICE_LABEL

Constructor Summary

Constructors

Constructor and Description
AbstractServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType) 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()
UnitRemoteFactory	getFactory() Returns the internal service factory which is used for the instance creation.
Collection<UnitRemote>	getInternalUnits() Returns a collection of all internally used unit remotes.
Collection<S>	getServices() Returns a collection of all internally used unit remotes.
ST	getServiceState()
rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType	getServiceType() Returns the service type of this remote.
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.
void	removeDataObserver(org.openbase.jul.pattern.Observer<ST> observer) Remove an observer for the service state.
void	setFactory(UnitRemoteFactory factory) Set the internal service factory which will be used for the instance creation.
void	shutdown()
String	toString() Returns a short instance description.
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.Service

detectServiceMethod, getArgumentClasses, getServiceBaseName, getServicePrefix, getServiceStateName, invokeServiceMethod

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

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

Constructor Detail

AbstractServiceRemote

public AbstractServiceRemote(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)

AbstractServiceRemote constructor.

Parameters:

serviceType - The remote service type.

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

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

Returns:

the current service state

Throws:

org.openbase.jul.exception.NotAvailableException - if the service state 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.

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.

Parameters:

observer - the observer which has been registered

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.

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:

getFactory

public UnitRemoteFactory getFactory()

Returns the internal service factory which is used for the instance creation.

Returns:

the internal service factory.

setFactory

public void setFactory(UnitRemoteFactory factory)

Set the internal service factory which will be used for the instance creation.

Parameters:

factory - the service factory.

getInternalUnits

public Collection<UnitRemote> getInternalUnits()

Returns a collection of all internally used unit remotes.

Returns:

a collection of unit remotes limited to the service interface.

getServices

public Collection<S> getServices()

Returns a collection of all internally used unit remotes.

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.

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.

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.

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.

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.

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)

toString

public String toString()

Returns a short instance description.

Overrides:

toString in class Object

Returns:

a description as string.