OSGi 8.1.0 · org.osgi.service.wireadmin.WireAdmin · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Wire	Returns: The `Wire` object for this connection. createWire(String The `service.pid` of the Producer service to be connected to the `Wire` object. producerPID, String The `service.pid` of the Consumer service to be connected to the `Wire` object. consumerPID, Dictionary<String, ?> The `Wire` object's properties. This argument may be `null` if the caller does not wish to define any `Wire` object's properties. properties) Create a new `Wire` object that connects a Producer service to a Consumer service.
public void	deleteWire(Wire The `Wire` object which is to be deleted. wire) Delete a `Wire` object.
public Wire[]	Returns: An array of `Wire` objects which match the `filter` or `null` if no `Wire` objects match the `filter`. getWires(String Filter string to select `Wire` objects or `null` to select all `Wire` objects. filter) Return the `Wire` objects that match the given `filter`.
public void	updateWire(Wire The `Wire` object which is to be updated. wire, Dictionary<String, ?> The new `Wire` object's properties or `null` if no properties are required. properties) Update the properties of a `Wire` object.

Method Detail

createWire back to summary

createWire	back to summary
public Wire createWire(String producerPID, String consumerPID, Dictionary<String, ?> properties) Create a new `Wire` object that connects a Producer service to a Consumer service. The Producer service and Consumer service do not have to be registered when the `Wire` object is created. The `Wire` configuration data must be persistently stored. All `Wire` connections are reestablished when the `WireAdmin` service is registered. A `Wire` can be permanently removed by using the `deleteWire(Wire)` method. The `Wire` object's properties must have case insensitive `String` objects as keys (like the Framework). However, the case of the key must be preserved. The `WireAdmin` service must automatically add the following `Wire` properties: `WireConstants#WIREADMIN_PID` set to the value of the `Wire` object's persistent identity (PID). This value is generated by the Wire Admin service when a `Wire` object is created. `WireConstants#WIREADMIN_PRODUCER_PID` set to the value of Producer service's PID. `WireConstants#WIREADMIN_CONSUMER_PID` set to the value of Consumer service's PID. If the `properties` argument already contains any of these keys, then the supplied values are replaced with the values assigned by the Wire Admin service. The Wire Admin service must broadcast a `WireAdminEvent` of type `WireAdminEvent#WIRE_CREATED` after the new `Wire` object becomes available from `getWires(String)`. Parameters producerPID:String The `service.pid` of the Producer service to be connected to the `Wire` object. consumerPID:String The `service.pid` of the Consumer service to be connected to the `Wire` object. properties:Dictionary<String, ?> The `Wire` object's properties. This argument may be `null` if the caller does not wish to define any `Wire` object's properties. Returns:Wire The `Wire` object for this connection. Exceptions IllegalArgumentException: If `properties` contains invalid wire types or case variants of the same key name.

public Wire createWire(String producerPID, String consumerPID, Dictionary<String, ?> properties)

Create a new Wire object that connects a Producer service to a Consumer service. The Producer service and Consumer service do not have to be registered when the Wire object is created.

The Wire configuration data must be persistently stored. All Wire connections are reestablished when the WireAdmin service is registered. A Wire can be permanently removed by using the deleteWire(Wire) method.

The Wire object's properties must have case insensitive String objects as keys (like the Framework). However, the case of the key must be preserved.

The WireAdmin service must automatically add the following Wire properties:

WireConstants#WIREADMIN_PID set to the value of the Wire object's persistent identity (PID). This value is generated by the Wire Admin service when a Wire object is created.
WireConstants#WIREADMIN_PRODUCER_PID set to the value of Producer service's PID.
WireConstants#WIREADMIN_CONSUMER_PID set to the value of Consumer service's PID.

If the properties argument already contains any of these keys, then the supplied values are replaced with the values assigned by the Wire Admin service.

The Wire Admin service must broadcast a WireAdminEvent of type WireAdminEvent#WIRE_CREATED after the new Wire object becomes available from getWires(String).

Parameters

producerPID:String: The service.pid of the Producer service to be connected to the Wire object.
consumerPID:String: The service.pid of the Consumer service to be connected to the Wire object.
properties:Dictionary<String, ?>: The Wire object's properties. This argument may be null if the caller does not wish to define any Wire object's properties.

Returns:Wire

The Wire object for this connection.

Exceptions

IllegalArgumentException:: If properties contains invalid wire types or case variants of the same key name.

deleteWire back to summary

deleteWire	back to summary
public void deleteWire(Wire wire) Delete a `Wire` object. The `Wire` object representing a connection between a Producer service and a Consumer service must be removed. The persistently stored configuration data for the `Wire` object must destroyed. The `Wire` object's method `Wire#isValid()` will return `false` after it is deleted. The Wire Admin service must broadcast a `WireAdminEvent` of type `WireAdminEvent#WIRE_DELETED` after the `Wire` object becomes invalid. Parameters wire:Wire The `Wire` object which is to be deleted.

public void deleteWire(Wire wire)

Delete a Wire object.

The Wire object representing a connection between a Producer service and a Consumer service must be removed. The persistently stored configuration data for the Wire object must destroyed. The Wire object's method Wire#isValid() will return false after it is deleted.

The Wire Admin service must broadcast a WireAdminEvent of type WireAdminEvent#WIRE_DELETED after the Wire object becomes invalid.

Parameters

wire:Wire: The Wire object which is to be deleted.

getWires back to summary

getWires	back to summary
public Wire[] getWires(String filter) throws InvalidSyntaxException Return the `Wire` objects that match the given `filter`. The list of available `Wire` objects is matched against the specified `filter`.`Wire` objects which match the `filter` must be returned. These `Wire` objects are not necessarily connected. The Wire Admin service should not return invalid `Wire` objects, but it is possible that a `Wire` object is deleted after it was placed in the list. The filter matches against the `Wire` object's properties including `WireConstants#WIREADMIN_PRODUCER_PID`, `WireConstants#WIREADMIN_CONSUMER_PID` and `WireConstants#WIREADMIN_PID`. Parameters filter:String Filter string to select `Wire` objects or `null` to select all `Wire` objects. Returns:Wire[] An array of `Wire` objects which match the `filter` or `null` if no `Wire` objects match the `filter`. Exceptions InvalidSyntaxException: If the specified `filter` has an invalid syntax. See Also `org.osgi.framework.Filter`

public Wire[] getWires(String filter) throws InvalidSyntaxException

Return the Wire objects that match the given filter.

The list of available Wire objects is matched against the specified filter.Wire objects which match the filter must be returned. These Wire objects are not necessarily connected. The Wire Admin service should not return invalid Wire objects, but it is possible that a Wire object is deleted after it was placed in the list.

The filter matches against the Wire object's properties including WireConstants#WIREADMIN_PRODUCER_PID, WireConstants#WIREADMIN_CONSUMER_PID and WireConstants#WIREADMIN_PID.

Parameters

filter:String: Filter string to select Wire objects or null to select all Wire objects.

Returns:Wire[]

An array of Wire objects which match the filter or null if no Wire objects match the filter.

Exceptions

InvalidSyntaxException:: If the specified filter has an invalid syntax.

See Also

org.osgi.framework.Filter

updateWire back to summary

updateWire	back to summary
public void updateWire(Wire wire, Dictionary<String, ?> properties) Update the properties of a `Wire` object. The persistently stored configuration data for the `Wire` object is updated with the new properties and then the Consumer and Producer services will be called at the respective `Consumer#producersConnected(Wire[])` and `Producer#consumersConnected(Wire[])` methods. The Wire Admin service must broadcast a `WireAdminEvent` of type `WireAdminEvent#WIRE_UPDATED` after the updated properties are available from the `Wire` object. Parameters wire:Wire The `Wire` object which is to be updated. properties:Dictionary<String, ?> The new `Wire` object's properties or `null` if no properties are required. Exceptions IllegalArgumentException: If `properties` contains invalid wire types or case variants of the same key name.

public void updateWire(Wire wire, Dictionary<String, ?> properties)

Update the properties of a Wire object. The persistently stored configuration data for the Wire object is updated with the new properties and then the Consumer and Producer services will be called at the respective Consumer#producersConnected(Wire[]) and Producer#consumersConnected(Wire[]) methods.

The Wire Admin service must broadcast a WireAdminEvent of type WireAdminEvent#WIRE_UPDATED after the updated properties are available from the Wire object.

Parameters

wire:Wire: The Wire object which is to be updated.
properties:Dictionary<String, ?>: The new Wire object's properties or null if no properties are required.

Exceptions

IllegalArgumentException:: If properties contains invalid wire types or case variants of the same key name.

public Interface WireAdmin

Method Summary

Method Detail