com.whizzosoftware.hobson.api.disco

Interface DiscoManager

public interface DiscoManager

A manager interface for managing device advertisement listeners. Note that this interface differentiates between "internal" and "external" advertisements. An internal advertisement is one that is published by a plugin and will be used when servicing external search requests -- they make internal Hub services discoverable. An external advertisement is one that was made by an external (to the Hub) entity -- they allow external entities to be discovered by Hub plugins.

Since:

hobson-hub-api 0.1.6

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
java.util.Collection<DeviceAdvertisement>	getExternalDeviceAdvertisements(PluginContext ctx, java.lang.String protocolId) Allows a plugin to request all known external device advertisements.
DeviceAdvertisement	getInternalDeviceAdvertisement(HubContext ctx, java.lang.String protocolId, java.lang.String advId) Returns a specific published internal device advertisement.
java.util.Collection<DeviceAdvertisement>	getInternalDeviceAdvertisements(HubContext ctx, java.lang.String protocolId) Returns all published internal device advertisements.
void	publishDeviceAdvertisement(HubContext ctx, DeviceAdvertisement advertisement, boolean internal) Publishes a device advertisement.

Method Detail

getExternalDeviceAdvertisements

java.util.Collection<DeviceAdvertisement> getExternalDeviceAdvertisements(PluginContext ctx,
                                                                          java.lang.String protocolId)

Allows a plugin to request all known external device advertisements. This is an asynchronous call that will be serviced as multiple DeviceAdvertisementEvent events to the plugin's onHobsonEvent() callback.

Parameters:

ctx - the context of the plugin requesting the snapshot

protocolId - the protocol ID for the advertisements requested

Returns:

a Collection of DeviceAdvertisement instances

getInternalDeviceAdvertisement

DeviceAdvertisement getInternalDeviceAdvertisement(HubContext ctx,
                                                   java.lang.String protocolId,
                                                   java.lang.String advId)

Returns a specific published internal device advertisement.

Parameters:

ctx - the hub context

protocolId - the protocol associated with the advertisement

advId - a advertisement ID

Returns:

a DeviceAdvertisement instance (or null if the protocol/ID combination was not found)

getInternalDeviceAdvertisements

java.util.Collection<DeviceAdvertisement> getInternalDeviceAdvertisements(HubContext ctx,
                                                                          java.lang.String protocolId)

Returns all published internal device advertisements.

Parameters:

ctx - the hub context

protocolId - the protocol associated with the advertisement

Returns:

a Collection of DeviceAdvertisement objects (or null if none are found)

publishDeviceAdvertisement

void publishDeviceAdvertisement(HubContext ctx,
                                DeviceAdvertisement advertisement,
                                boolean internal)

Publishes a device advertisement.

Parameters:

ctx - the context of the hub publishing the advertisement

advertisement - the advertisement to publish

internal - indicates if this is an internal advertisement. A value of true will insure that the advertisement is included in any discovery requests that external clients make for a particular protocol.