com.draeger.medical.biceps.client

Interface IBICEPSClient

All Known Implementing Classes:

DefaultBicepsClientImpl

public interface IBICEPSClient

An entrance point for an application that acts as a service consumer in a BICEPS ecosystem.

Method Summary

Modifier and Type	Method and Description
void	connectDevice(org.ws4d.java.service.reference.DeviceReference devRef) Triggers a connect to the specified device.
void	disconnectDevice(org.ws4d.java.service.reference.DeviceReference devRef) Disconnect from the remote device and remove all cached data of the device.
<T extends BICEPSAlertCondition> T	getAlertCondition(ProxyUniqueID proxyUniqueID) Gets the alert condition.
<T extends BICEPSAlertCondition> java.util.List<T>	getAlertConditions() Gets the alert conditions.
<T extends BICEPSAlertCondition> java.util.List<T>	getAlertConditions(BICEPSMedicalDeviceSystem mds) Gets the alert conditions.
<T extends BICEPSAlertCondition> java.util.List<T>	getAlertConditions(CodedValue typeCode) Gets the alert conditions.
<T extends BICEPSAlertSignal> T	getAlertSignal(ProxyUniqueID proxyUniqueID) Gets the alert signal.
<T extends BICEPSAlertSignal> java.util.List<T>	getAlertSignals() Gets the alert signals.
<T extends BICEPSAlertSignal> java.util.List<T>	getAlertSignals(BICEPSMedicalDeviceSystem mds) Gets the alert signals.
<T extends BICEPSAlertSignal> java.util.List<T>	getAlertSignals(CodedValue typeCode) Gets the alert signals.
<T extends BICEPSAlertSystem> T	getAlertSystem(ProxyUniqueID proxyUniqueID) Gets the alert system.
<T extends BICEPSAlertSystem> java.util.List<T>	getAlertSystems() Gets the alert systems.
<T extends BICEPSAlertSystem> java.util.List<T>	getAlertSystems(BICEPSMedicalDeviceSystem mds) Gets the alert systems.
CommunicationAdapter	getCommunicationAdapter() Gets the communication adapter.
ContextDiscovery	getContextDiscovery() Gets the context discovery.
java.util.List<java.lang.String>	getDeviceBlacklist() Thread-safe list of UUID strings that represents a black list of devices with which communication is not desired.
<T extends MdsDescriptor> java.util.List<T>	getDevices() Gets the devices.
java.util.List<java.lang.String>	getDeviceWhitelist() Thread-safe list of UUID strings that represents a white list of devices with which communication is desired.
<T extends BICEPSManeuver> T	getManeuver(ProxyUniqueID proxyUniqueID) Gets the maneuver.
<T extends BICEPSManeuver> java.util.List<T>	getManeuvers() Gets the maneuvers.
<T extends BICEPSManeuver> java.util.List<T>	getManeuvers(BICEPSMedicalDeviceSystem mds) Gets the maneuvers.
<T extends BICEPSManeuver> java.util.List<T>	getManeuvers(CodedValue typeCode) Gets the maneuvers.
java.util.Set<MDIBStructure>	getMDIBSearchStructure() Gets the MDIB search structure.
MDIBStructure	getMDIBSearchStructure(org.ws4d.java.types.EndpointReference epr) Gets the MDIB search structure.
<T extends BICEPSMDSContext> java.util.List<T>	getMDSContexts() Gets the MDS contexts.
<T extends BICEPSMDSContext> java.util.List<T>	getMDSContexts(BICEPSMedicalDeviceSystem mds) Gets the MDS contexts.
java.util.Set<BICEPSMedicalDeviceSystem>	getMedicalDeviceSystems() Gets the medical device systems.
java.util.Set<BICEPSMedicalDeviceSystem>	getMedicalDeviceSystems(org.ws4d.java.types.EndpointReference epr) Gets the medical device systems.
<T extends BICEPSMetric> T	getMetric(ProxyUniqueID proxyUniqueID) Gets the metric.
<T extends BICEPSMetric> java.util.List<T>	getMetrics(BICEPSMedicalDeviceSystem clientMedicalDeviceSystem) Gets the metrics.
<T extends BICEPSMetric> java.util.List<T>	getMetrics(BICEPSMedicalDeviceSystem clientMedicalDeviceSystem, CodedValue codeFilter) Gets the metrics.
<T extends BICEPSMetric> java.util.List<T>	getMetrics(CodedValue typeCode) Gets the metrics.
java.util.HashMap<org.ws4d.java.types.EndpointReference,java.util.HashMap<java.lang.String,BICEPSSafetyInformationPolicyElement>>	getSafetyInformationMap() Gets the safety information for an EndpointReferences.
org.ws4d.java.security.SecurityKey	getSecurityKey()
BICEPSStream	getStream(ProxyUniqueID proxyUniqueID) Gets the stream.
<T extends BICEPSStream> java.util.List<T>	getStreams(BICEPSMedicalDeviceSystem medicalDeviceSystem) Gets the streams.
boolean	isPnpEnabled() Checks if plug and play is enabled.
boolean	isVMLocalDeviceDetectionEnabled() Checks if is VM local device detection enabled.
void	releaseAllProxiesForMedicalDeviceSystemProxy(BICEPSMedicalDeviceSystem mdsProxy) Release all proxies for a medical device system proxy.
void	releaseDedicatedProxy(BICEPSProxy proxy) Releases a proxy.
java.util.List<BICEPSMedicalDeviceSystem>	retrieveMedicalDeviceSystemForDeviceReference(org.ws4d.java.service.reference.DeviceReference devRef) Retrieve medical device system for device reference.
void	searchDevices(NetworkSearchQuery search) Search devices in the network.
void	searchDevices(NetworkSearchQuery search, java.util.List<org.ws4d.java.types.QName> types) Search devices in the network.
void	setPnpEnabled(boolean pnpEnabled) Configures the plug and play capabilities (implicit discovery) of this IBICEPSClient instance.
void	setVMLocalDeviceDetectionEnabled(boolean vmLocalDetectionEnabled) Sets the VM local device detection enabled.
void	stop() Stops this IBICEPSClient instance.
void	subscribe(MdibListener listener) Adds a subscription for a MdibListener.
void	unsubscribe(MdibListener listener) Removes a subscription for a MdibListener.

Method Detail

stop

void stop()

Stops this IBICEPSClient instance.

isPnpEnabled

boolean isPnpEnabled()

Checks if plug and play is enabled.

Returns:

true, if is plug and play is enabled

setPnpEnabled

void setPnpEnabled(boolean pnpEnabled)

Configures the plug and play capabilities (implicit discovery) of this IBICEPSClient instance.

Parameters:

pnpEnabled - if true, this IBICEPSClient instance will react on implicit discovery messages

connectDevice

void connectDevice(org.ws4d.java.service.reference.DeviceReference devRef)

Triggers a connect to the specified device.

Parameters:

devRef - the device reference

disconnectDevice

void disconnectDevice(org.ws4d.java.service.reference.DeviceReference devRef)

Disconnect from the remote device and remove all cached data of the device.

Parameters:

devRef - the device reference

getDeviceBlacklist

java.util.List<java.lang.String> getDeviceBlacklist()

Thread-safe list of UUID strings that represents a black list of devices with which communication is not desired. Devices with a UUID that are on the list will not be forwarded to listeners.

Returns:

Thread-safe list of blacklisted device uuids.

getDeviceWhitelist

java.util.List<java.lang.String> getDeviceWhitelist()

Thread-safe list of UUID strings that represents a white list of devices with which communication is desired. Devices with a UUID that is not on the list will not be forwarded to listeners.

Returns:

Thread-safe list of whitelisted device uuids.

isVMLocalDeviceDetectionEnabled

boolean isVMLocalDeviceDetectionEnabled()

Checks if is VM local device detection enabled.

Returns:

true, if is VM local device detection is enabled

setVMLocalDeviceDetectionEnabled

void setVMLocalDeviceDetectionEnabled(boolean vmLocalDetectionEnabled)

Sets the VM local device detection enabled.

Parameters:

vmLocalDetectionEnabled - if true, local device detection is enabled

subscribe

void subscribe(MdibListener listener)

Adds a subscription for a MdibListener.

Parameters:

listener - the listener

unsubscribe

void unsubscribe(MdibListener listener)

Removes a subscription for a MdibListener.

Parameters:

listener - the listener

searchDevices

void searchDevices(NetworkSearchQuery search)

Search devices in the network.

Parameters:

search - the search

searchDevices

void searchDevices(NetworkSearchQuery search,
                   java.util.List<org.ws4d.java.types.QName> types)

Search devices in the network.

Parameters:

search - the search

types - Device type to search for

getContextDiscovery

ContextDiscovery getContextDiscovery()

Gets the context discovery.

Returns:

the context discovery

getCommunicationAdapter

CommunicationAdapter getCommunicationAdapter()

Gets the communication adapter.

Returns:

the communication adapter

releaseDedicatedProxy

void releaseDedicatedProxy(BICEPSProxy proxy)

Releases a proxy.

Parameters:

proxy - the proxy

releaseAllProxiesForMedicalDeviceSystemProxy

void releaseAllProxiesForMedicalDeviceSystemProxy(BICEPSMedicalDeviceSystem mdsProxy)

Release all proxies for a medical device system proxy.

Parameters:

mdsProxy - the mds proxy

retrieveMedicalDeviceSystemForDeviceReference

java.util.List<BICEPSMedicalDeviceSystem> retrieveMedicalDeviceSystemForDeviceReference(org.ws4d.java.service.reference.DeviceReference devRef)

Retrieve medical device system for device reference.

Parameters:

devRef - the dev ref

Returns:

the list

getMedicalDeviceSystems

java.util.Set<BICEPSMedicalDeviceSystem> getMedicalDeviceSystems(org.ws4d.java.types.EndpointReference epr)

Gets the medical device systems.

Parameters:

epr - the epr

Returns:

the medical device systems

getMedicalDeviceSystems

java.util.Set<BICEPSMedicalDeviceSystem> getMedicalDeviceSystems()

Gets the medical device systems.

Returns:

the medical device systems

getMDIBSearchStructure

MDIBStructure getMDIBSearchStructure(org.ws4d.java.types.EndpointReference epr)

Gets the MDIB search structure.

Parameters:

epr - the epr

Returns:

the MDIB search structure

getMDIBSearchStructure

java.util.Set<MDIBStructure> getMDIBSearchStructure()

Gets the MDIB search structure.

Returns:

the MDIB search structure

getMetric

<T extends BICEPSMetric> T getMetric(ProxyUniqueID proxyUniqueID)

Gets the metric.

Type Parameters:

T - the generic type

Parameters:

proxyUniqueID - the proxy unique id

Returns:

the metric

getMetrics

<T extends BICEPSMetric> java.util.List<T> getMetrics(BICEPSMedicalDeviceSystem clientMedicalDeviceSystem)

Gets the metrics.

Type Parameters:

T - the generic type

Parameters:

clientMedicalDeviceSystem - the client medical device system

Returns:

the metrics

getMetrics

<T extends BICEPSMetric> java.util.List<T> getMetrics(CodedValue typeCode)

Gets the metrics.

Type Parameters:

T - the generic type

Parameters:

typeCode - the type code

Returns:

the metrics

getMetrics

<T extends BICEPSMetric> java.util.List<T> getMetrics(BICEPSMedicalDeviceSystem clientMedicalDeviceSystem,
                                                      CodedValue codeFilter)

Gets the metrics.

Type Parameters:

T - the generic type

Parameters:

clientMedicalDeviceSystem - the client medical device system

codeFilter - the code filter

Returns:

the metrics

getAlertCondition

<T extends BICEPSAlertCondition> T getAlertCondition(ProxyUniqueID proxyUniqueID)

Gets the alert condition.

Type Parameters:

T - the generic type

Parameters:

proxyUniqueID - the proxy unique id

Returns:

the alert condition

getAlertConditions

<T extends BICEPSAlertCondition> java.util.List<T> getAlertConditions()

Gets the alert conditions.

Type Parameters:

T - the generic type

Returns:

the alert conditions

getAlertConditions

<T extends BICEPSAlertCondition> java.util.List<T> getAlertConditions(BICEPSMedicalDeviceSystem mds)

Gets the alert conditions.

Type Parameters:

T - the generic type

Parameters:

mds - the mds

Returns:

the alert conditions

getAlertConditions

<T extends BICEPSAlertCondition> java.util.List<T> getAlertConditions(CodedValue typeCode)

Gets the alert conditions.

Type Parameters:

T - the generic type

Parameters:

typeCode - the type code

Returns:

the alert conditions

getAlertSystem

<T extends BICEPSAlertSystem> T getAlertSystem(ProxyUniqueID proxyUniqueID)

Gets the alert system.

Type Parameters:

T - the generic type

Parameters:

proxyUniqueID - the proxy unique id

Returns:

the alert system

getAlertSystems

<T extends BICEPSAlertSystem> java.util.List<T> getAlertSystems()

Gets the alert systems.

Type Parameters:

T - the generic type

Returns:

the alert systems

getAlertSystems

<T extends BICEPSAlertSystem> java.util.List<T> getAlertSystems(BICEPSMedicalDeviceSystem mds)

Gets the alert systems.

Type Parameters:

T - the generic type

Parameters:

mds - the mds

Returns:

the alert systems

getAlertSignal

<T extends BICEPSAlertSignal> T getAlertSignal(ProxyUniqueID proxyUniqueID)

Gets the alert signal.

Type Parameters:

T - the generic type

Parameters:

proxyUniqueID - the proxy unique id

Returns:

the alert signal

getAlertSignals

<T extends BICEPSAlertSignal> java.util.List<T> getAlertSignals()

Gets the alert signals.

Type Parameters:

T - the generic type

Returns:

the alert signals

getAlertSignals

<T extends BICEPSAlertSignal> java.util.List<T> getAlertSignals(BICEPSMedicalDeviceSystem mds)

Gets the alert signals.

Type Parameters:

T - the generic type

Parameters:

mds - the mds

Returns:

the alert signals

getAlertSignals

<T extends BICEPSAlertSignal> java.util.List<T> getAlertSignals(CodedValue typeCode)

Gets the alert signals.

Type Parameters:

T - the generic type

Parameters:

typeCode - the type code

Returns:

the alert signals

getMDSContexts

<T extends BICEPSMDSContext> java.util.List<T> getMDSContexts()

Gets the MDS contexts.

Type Parameters:

T - the generic type

Returns:

the MDS contexts

getMDSContexts

<T extends BICEPSMDSContext> java.util.List<T> getMDSContexts(BICEPSMedicalDeviceSystem mds)

Gets the MDS contexts.

Type Parameters:

T - the generic type

Parameters:

mds - the mds

Returns:

the MDS contexts

getManeuver

<T extends BICEPSManeuver> T getManeuver(ProxyUniqueID proxyUniqueID)

Gets the maneuver.

Type Parameters:

T - the generic type

Parameters:

proxyUniqueID - the proxy unique id

Returns:

the maneuver

getManeuvers

<T extends BICEPSManeuver> java.util.List<T> getManeuvers()

Gets the maneuvers.

Type Parameters:

T - the generic type

Returns:

the maneuvers

getManeuvers

<T extends BICEPSManeuver> java.util.List<T> getManeuvers(BICEPSMedicalDeviceSystem mds)

Gets the maneuvers.

Type Parameters:

T - the generic type

Parameters:

mds - the mds

Returns:

the maneuvers

getManeuvers

<T extends BICEPSManeuver> java.util.List<T> getManeuvers(CodedValue typeCode)

Gets the maneuvers.

Type Parameters:

T - the generic type

Parameters:

typeCode - the type code

Returns:

the maneuvers

getStream

BICEPSStream getStream(ProxyUniqueID proxyUniqueID)

Gets the stream.

Parameters:

proxyUniqueID - the proxy unique id

Returns:

the stream

getStreams

<T extends BICEPSStream> java.util.List<T> getStreams(BICEPSMedicalDeviceSystem medicalDeviceSystem)

Gets the streams.

Type Parameters:

T - the generic type

Parameters:

medicalDeviceSystem - the medical device system

Returns:

the streams

getDevices

<T extends MdsDescriptor> java.util.List<T> getDevices()

Gets the devices.

Type Parameters:

T - the generic type

Returns:

the devices

getSecurityKey

org.ws4d.java.security.SecurityKey getSecurityKey()

getSafetyInformationMap

java.util.HashMap<org.ws4d.java.types.EndpointReference,java.util.HashMap<java.lang.String,BICEPSSafetyInformationPolicyElement>> getSafetyInformationMap()

Gets the safety information for an EndpointReferences.

Returns:

the safety information for EndpointReferences.