org.eclipse.kura.wire

Interface WireHelperService

@ProviderType
public interface WireHelperService

The interface WireHelperService is an service utility API to provide quick and necessary operations for Kura Wires topology.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPid(WireComponent wireComponent) Retrieves the Kura Service PID (kura.service.pid) of the wire component
java.lang.String	getServicePid(java.lang.String wireComponentPid) Retrieves the OSGi Component Service PID (service.pid) of the provided wire component PID
java.lang.String	getServicePid(WireComponent wireComponent) Retrieves the OSGi Component Service PID (service.pid) of the wire component
boolean	isEmitter(java.lang.String wireComponentPid) Checks whether the provided Wire Component PID belongs to a Wire Emitter
boolean	isReceiver(java.lang.String wireComponentPid) Checks whether the provided Wire Component PID belongs to a Wire Receiver
WireSupport	newWireSupport(WireComponent wireComponent, org.osgi.framework.ServiceReference<WireComponent> wireComponentRef) Returns a Wire Support instance of the provided wire component

Method Detail

getPid

java.lang.String getPid(WireComponent wireComponent)

Retrieves the Kura Service PID (kura.service.pid) of the wire component

Parameters:

wireComponent - the wire component

Returns:

the Service PID of the provided wire component or null if the provided Wire Component PID is not associated with any available Wire Component in the OSGi service registry

Throws:

java.lang.NullPointerException - if the argument is null

getServicePid

java.lang.String getServicePid(java.lang.String wireComponentPid)

Retrieves the OSGi Component Service PID (service.pid) of the provided wire component PID

Parameters:

wireComponentPid - the wire component PID (kura.service.pid)

Returns:

the Service PID of the provided wire component or null if the provided Wire Component PID is not associated with any available Wire Component in the OSGi service registry

Throws:

java.lang.NullPointerException - if the argument is null

getServicePid

java.lang.String getServicePid(WireComponent wireComponent)

Retrieves the OSGi Component Service PID (service.pid) of the wire component

Parameters:

wireComponent - the wire component

Returns:

the Service PID of the provided wire component or null if the provided Wire Component PID is not associated with any available Wire Component in the OSGi service registry

Throws:

java.lang.NullPointerException - if the argument is null

isEmitter

boolean isEmitter(java.lang.String wireComponentPid)

Checks whether the provided Wire Component PID belongs to a Wire Emitter

Parameters:

wireComponentPid - the wire component PID (kura.service.pid)

Returns:

true if the provided Wire Component PID belongs to a Wire Emitter

Throws:

java.lang.NullPointerException - if the argument is null

isReceiver

boolean isReceiver(java.lang.String wireComponentPid)

Checks whether the provided Wire Component PID belongs to a Wire Receiver

Parameters:

wireComponentPid - the wire component PID (kura.service.pid)

Returns:

true if the provided Wire Component PID belongs to a Wire Receiver

Throws:

java.lang.NullPointerException - if the argument is null

newWireSupport

WireSupport newWireSupport(WireComponent wireComponent,
                           org.osgi.framework.ServiceReference<WireComponent> wireComponentRef)

Returns a Wire Support instance of the provided wire component

Parameters:

wireComponent - the wire component

wireComponentRef - the ServiceReference that contains the metadata/configuration related to the wireComponent

Returns:

the wire support instance

Throws:

java.lang.NullPointerException - if the argument is null

Since:

2.0