Package org.ocap.hn.upnp.client

Provides UPnP client functionality, permitting access to devices and services on a home network.

See: Description

Interface Summary

Interface	Description
UPnPActionResponseHandler	This interface represents a listener for an asynchronous UPnP action response.
UPnPClientDevice	This interface provides the client representation of a UPnP device, associated with a single IP address.
UPnPClientDeviceIcon	This interface is the client representation of a UPnP Device Icon.
UPnPClientDeviceListener	This interface represents a listener to UPnP device availability on a home network.
UPnPClientService	This interface is the client representation of a UPnP service.
UPnPClientStateVariable	This interface is the client representation of a UPnP state variable.
UPnPStateVariableListener	This interface represents a client variable change listener for a UPnPClientService object.

Class Summary

Class	Description
UPnPControlPoint	This class represents a device control point that can discover devices and services.

Package org.ocap.hn.upnp.client Description

Provides UPnP client functionality, permitting access to devices and services on a home network.

The UPnP Control Point class (UPnPControlPoint) provides access to devices discovered by the Host device during a UPnP discovery process as defined by the UPnP Device Architecture specification. As defined by UPnP, a device consists of a root device and 0 or more sub-devices. Each device can contain services such as the Content Directory Service (CDS). Each service can contain actions, e.g. CDS:Search, and state variables, e.g. CDS:SystemUpdateID. The UPnPControlPoint.getDevices() method returns a data structure that represents the UPnP devices, services, etc., discovered in a home network. The data structure returned matches the hierarchy of the discovered UPnP device documents.

In the org.ocap.hn.upnp.client package UPnP entities are represented as follows:

• UPnP Device - UPnPClientDevice
• UPnP Device Icon - UPnPClientDeviceIcon
• UPnP Service - UPnPClientService
• UPnP State Variable - UPnPClientStateVariable

Objects of these types are immutable in order to represent entities that actually reside in remote Host devices.

Once an application calls the UPnPControlPoint.getDevices() method it can peruse the data structure returned, access the root device for a specific home network server and exhibit typical UPnP behaviors such as the following:

• Evaluate device properties, services, and sub-devices.
• Evaluate service properties, actions, and state variables.
• Send an action and get a response.
• Subscribe to state variable events.

In addition to typical UPnP behaviors an application can set itself using as the incoming and/or outgoing message handler using the UPnPControlPoint. An incoming message handler can modify incoming messages before Host device evaluation. An outgoing message handler can modify outgoing messages before transmission. This is useful when, for instance, a server device sends non-standard properties in a verbose manner and an application needs to prune for various reasons.