org.openbase.bco.dal.remote.unit

Class ObjectRemote

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<D,rst.domotic.unit.UnitConfigType.UnitConfig>

org.openbase.bco.dal.remote.unit.AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

org.openbase.bco.dal.remote.unit.ObjectRemote

All Implemented Interfaces:

Service, ServiceProvider, Unit<rst.domotic.unit.dal.ObjectDataType.ObjectData>, UnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>, org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>, 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.provider.PingProvider, org.openbase.jul.iface.Shutdownable, org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>, org.openbase.jul.pattern.ConfigurableRemote<String,rst.domotic.unit.dal.ObjectDataType.ObjectData,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.pattern.IdentifiableRemote<String,rst.domotic.unit.dal.ObjectDataType.ObjectData>, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.dal.ObjectDataType.ObjectData>, org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

public class ObjectRemote
extends AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

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_TEST_TIMEOUT, PING_TIMEOUT, REQUEST_TIMEOUT, scope

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

TYPE_FIELD_LABEL

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

RESPONSIBLE_ACTION_FIELD_NAME, SERVICE_LABEL, SERVICE_MODE_PACKAGE, SERVICE_STATE_PACKAGE

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

TYPE_FIELD_ID

Constructor Summary

Constructors

Constructor and Description
ObjectRemote()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addHandler(rsb.Handler handler, boolean wait)
void	addServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType, org.openbase.jul.pattern.Observer observer)
Future<rst.domotic.action.ActionFutureType.ActionFuture>	applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription)
<R> R	callMethod(String methodName)
<R> R	callMethod(String methodName, long timeout)
<R,T> R	callMethod(String methodName, T argument)
<R,T> R	callMethod(String methodName, T argument, long timeout)
<R> Future<R>	callMethodAsync(String methodName)
<R,T> Future<R>	callMethodAsync(String methodName, T argument)
void	deactivate()
org.openbase.jul.pattern.Remote.ConnectionState	getConnectionState()
rst.domotic.unit.dal.ObjectDataType.ObjectData	getData()
CompletableFuture<rst.domotic.unit.dal.ObjectDataType.ObjectData>	getDataFuture()
Long	getPing()
boolean	isActive()
boolean	isConnected()
boolean	isDataAvailable()
Future<Long>	ping()
Future<rst.domotic.action.SnapshotType.Snapshot>	recordSnapshot()
void	removeServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType, org.openbase.jul.pattern.Observer observer)
CompletableFuture<rst.domotic.unit.dal.ObjectDataType.ObjectData>	requestData()
Future<Void>	restoreSnapshot(rst.domotic.action.SnapshotType.Snapshot snapshot)
void	validateData()
void	validateMiddleware()
void	waitForData()
void	waitForData(long timeout, TimeUnit timeUnit)
void	waitForMiddleware()

Methods inherited from class org.openbase.bco.dal.remote.unit.AbstractUnitRemote

addDataObserver, addDataObserver, addServiceStateObserver, applyConfigUpdate, getLabel, getLocationConfig, getParentLocationConfig, getParentLocationRemote, getScope, getSessionManager, getTransformation, getUnitRegistry, getUnitTemplate, getUnitType, init, init, init, init, initById, initByLabel, isEnabled, postInit, removeDataObserver, removeDataObserver, removeServiceStateObserver, setSessionManager, shutdown, toString

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

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

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

activate, activate, addConnectionStateObserver, addObserver, applyEventUpdate, applyExternalDataUpdate, deactivate, generateHandler, getDataClass, getDataField, getIntenalPriorizedDataObservable, getRemoteServer, hasDataField, init, init, internalRequestStatus, isLocked, lock, notifyDataUpdate, reinit, reinit, reinit, reinit, removeConnectionStateObserver, removeObserver, reset, setMessageProcessor, unlock, validateActivation, 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.UnitRemote

updateActionDescription

Methods inherited from interface org.openbase.bco.dal.lib.layer.unit.Unit

generateVariablePool, generateVariablePool, generateVariablePool, getGlobalBoundingBoxCenterPoint3d, getGlobalPosition, getGlobalPositionPoint3d, getGlobalRotation, getGlobalRotationQuat4d, getHostUnitConfig, getLatestTransactionId, getLocalBoundingBoxCenterPoint3d, getLocalPosition, getLocalRotation, getLocationRegistry, getRootToUnitTransform3D, getRootToUnitTransformation, getRootToUnitTransformationFuture, getTemplate, getTransactionIdByServiceType, getTransform3D, getTransform3DInverse, getType, getUnitBoundingBoxCenterGlobalPoint3d, getUnitBoundingBoxCenterPoint3d, getUnitPosition, getUnitPositionGlobal, getUnitPositionGlobalPoint3d, getUnitRotation, getUnitRotationGlobal, getUnitRotationGlobalQuat4d, getUnitShape, getUnitToRootTransform3D, getUnitToRootTransformation, getUnitToRootTransformationFuture, isBaseUnit, isDalUnit, verifyOperationServiceState, verifyOperationServiceStateValue

Methods inherited from interface org.openbase.jul.iface.provider.ConfigProvider

getConfig

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

buildServiceState, detectServiceDataClass, detectServiceMethod, detectServiceMethod, getArgumentClasses, getServiceBaseName, getServicePrefix, getServiceStateClass, getServiceStateName, getServiceStateName, getServiceStateValues, getServiceType, invokeOperationServiceMethod, invokeProviderServiceMethod, invokeServiceMethod, invokeServiceMethod, upateActionDescription, upateActionDescription

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, activate, addConnectionStateObserver, removeConnectionStateObserver

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

registerShutdownHook, registerShutdownHook

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

isLocked, lock, unlock, verifyMaintainability

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

init

Constructor Detail

ObjectRemote

public ObjectRemote()

Method Detail

waitForData

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

Description copied from class: AbstractUnitRemote

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Specified by:

waitForData in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

waitForData in class AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

waitForData

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

Description copied from class: AbstractUnitRemote

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Specified by:

waitForData in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

waitForData in class AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Parameters:

timeout -

timeUnit -

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

applyAction

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

Description copied from class: AbstractUnitRemote

Specified by:

applyAction in interface ServiceProvider

Overrides:

applyAction in class AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Parameters:

actionDescription -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

org.openbase.jul.exception.RejectedException

recordSnapshot

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

Description copied from class: AbstractUnitRemote

Specified by:

recordSnapshot in interface Unit<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Specified by:

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

Overrides:

recordSnapshot in class AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Returns:

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

addServiceStateObserver

public void addServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
                                    org.openbase.jul.pattern.Observer observer)

removeServiceStateObserver

public void removeServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
                                       org.openbase.jul.pattern.Observer observer)

addHandler

public void addHandler(rsb.Handler handler,
                       boolean wait)
                throws InterruptedException,
                       org.openbase.jul.exception.CouldNotPerformException

Overrides:

addHandler in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

activate

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

Description copied from class: AbstractUnitRemote

Specified by:

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

Overrides:

activate in class AbstractUnitRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

deactivate

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

Specified by:

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

Overrides:

deactivate in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

isConnected

public boolean isConnected()

Specified by:

isConnected in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

isConnected in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

getConnectionState

public org.openbase.jul.pattern.Remote.ConnectionState getConnectionState()

Specified by:

getConnectionState in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

getConnectionState in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

isActive

public boolean isActive()

Specified by:

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

Overrides:

isActive in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

callMethodAsync

public <R> Future<R> callMethodAsync(String methodName)
                              throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

callMethodAsync in interface org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

callMethodAsync in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

callMethod

public <R> R callMethod(String methodName)
                 throws org.openbase.jul.exception.CouldNotPerformException,
                        InterruptedException

Specified by:

callMethod in interface org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

callMethod in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

callMethod

public <R,T> R callMethod(String methodName,
                          T argument)
                   throws org.openbase.jul.exception.CouldNotPerformException,
                          InterruptedException

Specified by:

callMethod in interface org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

callMethod in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

callMethod

public <R> R callMethod(String methodName,
                        long timeout)
                 throws org.openbase.jul.exception.CouldNotPerformException,
                        org.openbase.jul.exception.TimeoutException,
                        InterruptedException

Specified by:

callMethod in interface org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

callMethod in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

org.openbase.jul.exception.TimeoutException

InterruptedException

callMethod

public <R,T> R callMethod(String methodName,
                          T argument,
                          long timeout)
                   throws org.openbase.jul.exception.CouldNotPerformException,
                          org.openbase.jul.exception.TimeoutException,
                          InterruptedException

Specified by:

callMethod in interface org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

callMethod in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

org.openbase.jul.exception.TimeoutException

InterruptedException

callMethodAsync

public <R,T> Future<R> callMethodAsync(String methodName,
                                       T argument)
                                throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

callMethodAsync in interface org.openbase.jul.extension.rsb.com.RSBRemote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

callMethodAsync in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

requestData

public CompletableFuture<rst.domotic.unit.dal.ObjectDataType.ObjectData> requestData()
                                                                              throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

requestData in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

requestData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

getData

public rst.domotic.unit.dal.ObjectDataType.ObjectData getData()
                                                       throws org.openbase.jul.exception.NotAvailableException

Specified by:

getData in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Specified by:

getData in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

getData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.NotAvailableException

isDataAvailable

public boolean isDataAvailable()

Specified by:

isDataAvailable in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

isDataAvailable in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

validateMiddleware

public void validateMiddleware()
                        throws org.openbase.jul.exception.InvalidStateException

Overrides:

validateMiddleware in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.InvalidStateException

validateData

public void validateData()
                  throws org.openbase.jul.exception.InvalidStateException

Overrides:

validateData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.InvalidStateException

waitForMiddleware

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

Overrides:

waitForMiddleware in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

ping

public Future<Long> ping()

Specified by:

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

Specified by:

ping in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

ping in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

getPing

public Long getPing()

Specified by:

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

Specified by:

getPing in interface org.openbase.jul.pattern.Remote<rst.domotic.unit.dal.ObjectDataType.ObjectData>

Overrides:

getPing in class org.openbase.jul.extension.rsb.com.RSBRemoteService<rst.domotic.unit.dal.ObjectDataType.ObjectData>

getDataFuture

public CompletableFuture<rst.domotic.unit.dal.ObjectDataType.ObjectData> getDataFuture()