org.openbase.bco.dal.remote.unit

Class AbstractUnitRemote<M extends com.google.protobuf.GeneratedMessage>

java.lang.Object

org.openbase.jul.extension.rsb.com.RSBRemoteService<M>

org.openbase.jul.extension.rsb.com.AbstractIdentifiableRemote<M>

org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<M,rst.domotic.unit.UnitConfigType.UnitConfig>

org.openbase.bco.dal.remote.unit.AbstractUnitRemote<M>

Type Parameters:

M -

All Implemented Interfaces:

Service, Unit<M>, UnitRemote<M>, org.openbase.jul.extension.rsb.com.RSBRemote<M>, org.openbase.jul.extension.rst.iface.ScopeProvider, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Configurable<String,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Identifiable<String>, 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.provider.ConfigProvider<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.provider.LabelProvider, org.openbase.jul.iface.Shutdownable, org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>, org.openbase.jul.pattern.ConfigurableRemote<String,M,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.pattern.IdentifiableRemote<String,M>, org.openbase.jul.pattern.provider.DataProvider<M>, org.openbase.jul.pattern.Remote<M>

Direct Known Subclasses:

AgentRemote, AppRemote, AuthorizationGroupRemote, BatteryRemote, BrightnessSensorRemote, ButtonRemote, ColorableLightRemote, ConnectionRemote, DeviceRemote, DimmableLightRemote, DimmerRemote, HandleRemote, LightRemote, LightSensorRemote, LocationRemote, MonitorRemote, MotionDetectorRemote, PowerConsumptionSensorRemote, PowerSwitchRemote, ReedContactRemote, RollerShutterRemote, SceneRemote, SmokeDetectorRemote, TamperDetectorRemote, TemperatureControllerRemote, TemperatureSensorRemote, UnitGroupRemote, UserRemote

public abstract class AbstractUnitRemote<M extends com.google.protobuf.GeneratedMessage>
extends org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<M,rst.domotic.unit.UnitConfigType.UnitConfig>
implements UnitRemote<M>

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 inherited from class org.openbase.jul.extension.rsb.com.RSBRemoteService

CONNECTION_TIMEOUT, DATA_WAIT_TIMEOUT, logger, LOGGING_TIMEOUT, maintainer, METHOD_CALL_MAX_TIMEOUT, METHOD_CALL_START_TIMEOUT, METHOD_CALL_TIMEOUT_MULTIPLIER, PING_TIMEOUT, REQUEST_TIMEOUT, scope

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

SERVICE_LABEL, SERVICE_STATE_PACKAGE

Fields inherited from interface org.openbase.jul.iface.provider.LabelProvider

TYPE_FIELD_LABEL

Fields inherited from interface org.openbase.jul.iface.Identifiable

TYPE_FIELD_ID

Constructor Summary

Constructors

Constructor and Description
AbstractUnitRemote(Class<M> dataClass)

Method Summary

Modifier and Type	Method and Description
void	activate()
Future<Void>	applyAction(rst.domotic.action.ActionConfigType.ActionConfig actionConfig)
rst.domotic.unit.UnitConfigType.UnitConfig	applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config)
String	getLabel()
rst.domotic.unit.UnitConfigType.UnitConfig	getLocationConfig()
rst.rsb.ScopeType.Scope	getScope()
rst.domotic.unit.UnitTemplateType.UnitTemplate	getTemplate()
rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType	getType()
protected org.openbase.bco.registry.unit.lib.UnitRegistry	getUnitRegistry()
void	init(rsb.Scope scope)
void	init(rst.rsb.ScopeType.Scope scope)
void	init(String scope)
void	init(String label, org.openbase.jul.extension.rst.iface.ScopeProvider location)
void	initById(String id)
void	initByLabel(String label)
boolean	isEnabled()
protected void	postInit()
Future<rst.domotic.action.SnapshotType.Snapshot>	recordSnapshot()
void	waitForData()
void	waitForData(long timeout, TimeUnit timeUnit)

Methods inherited from class org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote

addConfigObserver, getConfig, getConfigClass, getConfigField, getConfigField, getId, hasConfigField, init, notifyConfigUpdate, removeConfigObserver, shutdown, supportsConfigField

Methods inherited from class org.openbase.jul.extension.rsb.com.RSBRemoteService

activate, addConnectionStateObserver, addDataObserver, addHandler, addObserver, callMethod, callMethod, callMethod, callMethod, callMethodAsync, callMethodAsync, deactivate, getConnectionState, getData, getDataClass, getDataField, getPing, hasDataField, init, init, isActive, isConnected, isDataAvailable, isLocked, lock, notifyDataUpdate, ping, removeConnectionStateObserver, removeDataObserver, removeObserver, requestData, reset, setMessageProcessor, toString, unlock, validateActivation, validateData, validateInitialization, verifyMaintainability, waitForConnectionState, waitForConnectionState

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.unit.Unit

restoreSnapshot, verifyOperationServiceState, verifyOperationServiceStateValue

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.iface.provider.ConfigProvider

getConfig

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

addConfigObserver, getConfig, getConfigClass, removeConfigObserver

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

getId

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

activate, addConnectionStateObserver, getConnectionState, getDataFuture, isConnected, removeConnectionStateObserver, requestData

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

registerShutdownHook, registerShutdownHook, shutdown

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

deactivate, isActive

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

isLocked, lock, unlock, verifyMaintainability

Methods inherited from interface org.openbase.jul.pattern.provider.DataProvider

addDataObserver, isDataAvailable, removeDataObserver

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

shutdown

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

init

Constructor Detail

AbstractUnitRemote

public AbstractUnitRemote(Class<M> dataClass)

Method Detail

getUnitRegistry

protected org.openbase.bco.registry.unit.lib.UnitRegistry getUnitRegistry()
                                                                   throws InterruptedException,
                                                                          org.openbase.jul.exception.CouldNotPerformException

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

initById

public void initById(String id)
              throws org.openbase.jul.exception.InitializationException,
                     InterruptedException

Specified by:

initById in interface UnitRemote<M extends com.google.protobuf.GeneratedMessage>

Parameters:

id -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

initByLabel

public void initByLabel(String label)
                 throws org.openbase.jul.exception.InitializationException,
                        InterruptedException

Specified by:

initByLabel in interface UnitRemote<M extends com.google.protobuf.GeneratedMessage>

Parameters:

label -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

init

public void init(rst.rsb.ScopeType.Scope scope)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Specified by:

init in interface UnitRemote<M extends com.google.protobuf.GeneratedMessage>

Specified by:

init in interface org.openbase.jul.extension.rsb.com.RSBRemote<M extends com.google.protobuf.GeneratedMessage>

Overrides:

init in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Parameters:

scope -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

init

public void init(rsb.Scope scope)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Specified by:

init in interface UnitRemote<M extends com.google.protobuf.GeneratedMessage>

Specified by:

init in interface org.openbase.jul.extension.rsb.com.RSBRemote<M extends com.google.protobuf.GeneratedMessage>

Overrides:

init in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Parameters:

scope -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

init

public void init(String scope)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Specified by:

init in interface org.openbase.jul.extension.rsb.com.RSBRemote<M extends com.google.protobuf.GeneratedMessage>

Overrides:

init in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Parameters:

scope -

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

init

public void init(String label,
                 org.openbase.jul.extension.rst.iface.ScopeProvider location)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

postInit

protected void postInit()
                 throws org.openbase.jul.exception.InitializationException,
                        InterruptedException

Overrides:

postInit in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

applyConfigUpdate

public rst.domotic.unit.UnitConfigType.UnitConfig applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config)
                                                             throws org.openbase.jul.exception.CouldNotPerformException,
                                                                    InterruptedException

Specified by:

applyConfigUpdate in interface org.openbase.jul.iface.Configurable<String,rst.domotic.unit.UnitConfigType.UnitConfig>

Overrides:

applyConfigUpdate in class org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<M extends com.google.protobuf.GeneratedMessage,rst.domotic.unit.UnitConfigType.UnitConfig>

Parameters:

config -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

activate

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

Specified by:

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

Overrides:

activate in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

waitForData

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

Specified by:

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

Specified by:

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

Overrides:

waitForData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

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<M extends com.google.protobuf.GeneratedMessage>

Specified by:

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

Overrides:

waitForData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Parameters:

timeout -

timeUnit -

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface UnitRemote<M extends com.google.protobuf.GeneratedMessage>

Returns:

getType

public rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType getType()
                                                                throws org.openbase.jul.exception.NotAvailableException

Specified by:

getType in interface Unit<M extends com.google.protobuf.GeneratedMessage>

Throws:

org.openbase.jul.exception.NotAvailableException

getTemplate

public rst.domotic.unit.UnitTemplateType.UnitTemplate getTemplate()
                                                           throws org.openbase.jul.exception.NotAvailableException

Specified by:

getTemplate in interface Unit<M extends com.google.protobuf.GeneratedMessage>

Throws:

org.openbase.jul.exception.NotAvailableException

getLabel

public String getLabel()
                throws org.openbase.jul.exception.NotAvailableException

Specified by:

getLabel in interface org.openbase.jul.iface.provider.LabelProvider

Returns:

Throws:

org.openbase.jul.exception.NotAvailableException

getScope

public rst.rsb.ScopeType.Scope getScope()
                                 throws org.openbase.jul.exception.NotAvailableException

Specified by:

getScope in interface org.openbase.jul.extension.rsb.com.RSBRemote<M extends com.google.protobuf.GeneratedMessage>

Specified by:

getScope in interface org.openbase.jul.extension.rst.iface.ScopeProvider

Overrides:

getScope in class org.openbase.jul.extension.rsb.com.RSBRemoteService<M extends com.google.protobuf.GeneratedMessage>

Returns:

Throws:

org.openbase.jul.exception.NotAvailableException

getLocationConfig

public rst.domotic.unit.UnitConfigType.UnitConfig getLocationConfig()
                                                             throws org.openbase.jul.exception.NotAvailableException

Throws:

org.openbase.jul.exception.NotAvailableException

applyAction

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

Specified by:

applyAction in interface Service

Parameters:

actionConfig -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

recordSnapshot

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

Specified by:

recordSnapshot in interface Unit<M extends com.google.protobuf.GeneratedMessage>

Specified by:

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

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException