org.eclipse.kura.wire

Interface WireService

Deprecated.

Use WireGraphService instead.

@ProviderType
 @Deprecated
public interface WireService

This WireService interface provides all necessary service API methods to manipulate wire mechanisms in Kura Wires topology.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
WireConfiguration	createWireConfiguration(java.lang.String emitterPid, java.lang.String receiverPid) Deprecated. Creates the wire configuration for the provided wire emitter and the wire receiver.
void	deleteWireConfiguration(WireConfiguration wireConfiguration) Deprecated. Removes the provided wire configuration for the provided wire emitter and the wire receiver.
java.util.Set<WireConfiguration>	getWireConfigurations() Deprecated. Retrieves the set of already created Wire Configurations.

Method Detail

createWireConfiguration

WireConfiguration createWireConfiguration(java.lang.String emitterPid,
                                          java.lang.String receiverPid)
                                   throws KuraException

Deprecated.

Creates the wire configuration for the provided wire emitter and the wire receiver.

Parameters:

emitterPid - the PID of the wire emitter (this PID will internally be used to retrieve kura.service.pid property of any matching DS component).

receiverPid - the PID of the wire receiver (this PID will internally be used to retrieve kura.service.pid property of any matching DS component).

Returns:

the recently created wire instance.

Throws:

KuraException - if there are no services associated to the provided emitterPid or receiverPid.

KuraException - if the provided emitterPid does not belong to a Wire Emitter or if the receiverPid does not belong to a Wire Receiver.

java.lang.NullPointerException - if any of the arguments is null.

deleteWireConfiguration

void deleteWireConfiguration(WireConfiguration wireConfiguration)

Deprecated.

Removes the provided wire configuration for the provided wire emitter and the wire receiver.

Parameters:

wireConfiguration - the wire configuration to be deleted.

Throws:

java.lang.NullPointerException - if the argument is null.

java.lang.IllegalArgumentException - if the provided argument is illegal or inappropriate.

getWireConfigurations

java.util.Set<WireConfiguration> getWireConfigurations()

Deprecated.

Retrieves the set of already created Wire Configurations.

Returns:

the set of wire configurations.