info.pppc.base.system.plugin

Interface IDiscoveryManager

All Superinterfaces:

IOperator, IPluginManager

All Known Subinterfaces:

IRoutingManager

All Known Implementing Classes:

PluginManager

public interface IDiscoveryManager
extends IPluginManager

The discovery manager is the interface of the plug-in manager exposed to discovery plug-ins. This interface enables discovery plug-ins to listen for changes to plug-ins and it enables them to register plug-in and device descriptions at the local device registry.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_PLUGIN_ADDED The event constant that is used to propagate the addition of a plug-in.
static int	EVENT_PLUGIN_REMOVED The event constant that is used to propagate the removal of a plug-in.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPluginListener(int type, IListener listener) Adds a listener to the discovery manager.
IPacketConnector	openGroup(short group) Opens a group connector using all transceivers that sends and receives data using the specified group.
IPacketConnector	openGroup(short group, short ability) Opens a group connector using the specified transceiver.
void	registerDevice(DeviceDescription device, long ttl) Registers a device description that has been discovered from a remote device.
void	registerPlugin(SystemID id, PluginDescription plugin, long ttl) Registers the specified plug-in description of the specified device.
boolean	removePluginListener(int type, IListener listener) Removes the specified listener for the specified set of event types.

Methods inherited from interface info.pppc.base.system.plugin.IPluginManager

getDeviceDescription, getDevices, getPluginDescriptions

Methods inherited from interface info.pppc.base.system.operation.IOperator

performOperation, performOperation

Field Detail

EVENT_PLUGIN_ADDED

static final int EVENT_PLUGIN_ADDED

The event constant that is used to propagate the addition of a plug-in. The data object of this event will contain the plug-in description of the plug-in that has been added.

See Also:

Constant Field Values

EVENT_PLUGIN_REMOVED

static final int EVENT_PLUGIN_REMOVED

The event constant that is used to propagate the removal of a plug-in. The data object of this event will contain the plug-in description of the plug-in that has been removed.

See Also:

Constant Field Values

Method Detail

addPluginListener

void addPluginListener(int type,
                     IListener listener)

Adds a listener to the discovery manager. The listener keeps track of changes to plug-ins. At the present time a discovery manager issues EVENT_PLUGIN_ADDED and EVENT_PLUGIN_REMOVED events to signal the addition and the removal of a plug-in. A discovery plug-in that caches the plug-in descriptions should add a listen to keep track of changes and to modify its cache. The data object of the two events will contain the plug-in description of the plug-in that has been removed or added respectively. The add event will be fired shortly after a plug-in has been installed. The remove event will be fired shortly before a plug-in is removed.

Parameters:

type - The type of event to register for. At the present time the discovery manager supports EVENT_PLUGIN_ADDED and EVENT_PLUGIN_REMOVED events.

listener - The listener to register for the specified events.

removePluginListener

boolean removePluginListener(int type,
                           IListener listener)

Removes the specified listener for the specified set of event types.

Parameters:

type - The types of events to unregister.

listener - The listener to unregister for the specified types of events.

Returns:

True if the listener is no longer registered for any event, false if the listener is still registered or if it has not been registered.

openGroup

IPacketConnector openGroup(short group)

Opens a group connector using all transceivers that sends and receives data using the specified group.

Parameters:

group - The group to use.

Returns:

The packet connector that is connected to all transceivers.

openGroup

IPacketConnector openGroup(short group,
                         short ability)

Opens a group connector using the specified transceiver.

Parameters:

group - The group to use.

ability - The ability of the transceiver to use.

Returns:

The packet connector that is connected to the specified transceiver.

registerDevice

void registerDevice(DeviceDescription device,
                  long ttl)

Registers a device description that has been discovered from a remote device. A call to this method will replace a potentially previously registered description with the new one provided by the call.

Parameters:

device - The device description of the device that announced the descriptions.

ttl - The time to live.

Throws:

java.lang.NullPointerException - Thrown if one of the parameters is null.

registerPlugin

void registerPlugin(SystemID id,
                  PluginDescription plugin,
                  long ttl)

Registers the specified plug-in description of the specified device. If the plug-in description has been registered before, it will be overwritten.

Parameters:

id - The id of the device.

plugin - The plug-in description to register.

ttl - The time to live.

Throws:

java.lang.NullPointerException - Thrown if one of the parameters is null.