Package org.somda.sdc.glue.provider

Class SdcDevice

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.somda.sdc.glue.provider.SdcDevice

All Implemented Interfaces:

com.google.common.util.concurrent.Service, Device, EventSourceAccess, SdcDeviceContext

public class SdcDevice
extends com.google.common.util.concurrent.AbstractIdleService
implements Device, EventSourceAccess, SdcDeviceContext

Adds SDC services to a DPWS device and manages incoming set service requests.

The purpose of the SdcDevice class is to provide SDC data on the network.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method	Description
Map<String,SubscriptionManager>	getActiveSubscriptions()
Device	getDevice()	Gets the encapsulated device of an SdcDevice.
DiscoveryAccess	getDiscoveryAccess()	Gets the discovery access.
String	getEprAddress()
HostingServiceAccess	getHostingServiceAccess()	Gets the hosting service access.
LocalMdibAccess	getLocalMdibAccess()	Gets the LocalMdibAccess passed to the SdcDevice constructor.
LocalMdibAccess	getMdibAccess()
Collection<OperationInvocationReceiver>	getOperationInvocationReceivers()	Gets a collection of OperationInvocationReceiver instances passed to the SdcDevice constructor.
com.google.common.util.concurrent.Service.State	getServiceState()	Gets the enclosing SdcDevice service state.
void	sendNotification(String action, Object payload)
<T extends AbstractState> void	sendPeriodicStateReport(List<T> states, MdibVersion mdibVersion)	Sends a periodic state report.
protected void	shutDown()
protected void	startUp()
void	subscriptionEndToAll(WsEventingStatus status)

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Method Details

getMdibAccess

public LocalMdibAccess getMdibAccess()

getEprAddress

public String getEprAddress()

Specified by:

getEprAddress in interface Device

getActiveSubscriptions

public Map<String,SubscriptionManager> getActiveSubscriptions()

Specified by:

getActiveSubscriptions in interface Device

getDevice

public Device getDevice()

Description copied from interface: SdcDeviceContext

Gets the encapsulated device of an SdcDevice.

Do not call any startup or shutdown functions from that device reference as it is still managed by the enclosing SdcDevice instance that provides this context.

Specified by:

getDevice in interface SdcDeviceContext

Returns:

the DPWS device.

getLocalMdibAccess

public LocalMdibAccess getLocalMdibAccess()

Description copied from interface: SdcDeviceContext

Gets the LocalMdibAccess passed to the SdcDevice constructor.

Specified by:

getLocalMdibAccess in interface SdcDeviceContext

Returns:

the local MDIB access.

getOperationInvocationReceivers

public Collection<OperationInvocationReceiver> getOperationInvocationReceivers()

Description copied from interface: SdcDeviceContext

Gets a collection of OperationInvocationReceiver instances passed to the SdcDevice constructor.

Specified by:

getOperationInvocationReceivers in interface SdcDeviceContext

Returns:

an unmodifiable OperationInvocationReceiver collection.

getServiceState

public com.google.common.util.concurrent.Service.State getServiceState()

Description copied from interface: SdcDeviceContext

Gets the enclosing SdcDevice service state.

Specified by:

getServiceState in interface SdcDeviceContext

Returns:

AbstractIdleService.state() of the enclosing SDC device.

sendPeriodicStateReport

public <T extends AbstractState> void sendPeriodicStateReport(List<T> states,
 MdibVersion mdibVersion)

Description copied from interface: SdcDeviceContext

Sends a periodic state report.

This function does not control periodicity. Periodicity has to be controlled by the calling function.

Note that only one report type is supported per call, e.g. it is not possible to mix metric and context states. In accordance with the SDC, the following state types have to be sent in separate reports:

• Metric states (every subclass of AbstractMetricState)
• Alert states (every subclass of AbstractAlertState)
• Context states (every subclass of AbstractContextState)
• Operational states (every subclass of AbstractOperationState)
• Component states (every subclass of AbstractDeviceComponentState)

Specified by:

sendPeriodicStateReport in interface SdcDeviceContext

Type Parameters:

T - the state type that.

Parameters:

states - the states that are supposed to be notified.

mdibVersion - the MDIB version the report belongs to.

getDiscoveryAccess

public DiscoveryAccess getDiscoveryAccess()

Gets the discovery access. Please note that the discovery access is managed by this class. Overwriting types and/or scopes can cause negative side-effects. Prefer using the SdcRequiredTypesAndScopes plugin to manage discovery.

Specified by:

getDiscoveryAccess in interface Device

Returns:

the discovery access.

getHostingServiceAccess

public HostingServiceAccess getHostingServiceAccess()

Gets the hosting service access.

As the BICEPS services are managed by this class, there should not be any need to access the hosting services. In case access is required though, consider creating a plugin that accesses the hosting services. Prefer implementing a plugin and use Device.getHostingServiceAccess() from SdcDeviceContext.getDevice().

Specified by:

getHostingServiceAccess in interface Device

Returns:

the hosting service access.

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

shutDown

protected void shutDown()

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

sendNotification

public void sendNotification(String action,
 Object payload)
                      throws MarshallingException,
TransportException

Specified by:

sendNotification in interface EventSourceAccess

Throws:

MarshallingException

TransportException

subscriptionEndToAll

public void subscriptionEndToAll(WsEventingStatus status)
                          throws TransportException

Specified by:

subscriptionEndToAll in interface EventSourceAccess

Throws:

TransportException