Configuration Properties

This chapter describes the configuration properties that you can use to configure the operation parameters of the OSGi UPnP Driver Bundle. It registers three ManagedSevices:

UPnP Driver Configuration with mbs.upnp.pid PID – Contains some general configuration properties for the UPnP network.
UPnP Driver Import Device Filters with mbs.upnp.filter.pid PID – Allows you to configure the Device Filter so as to have only needed devices registered by the driver. Through the Device Filter you can create accept and reject filters which use the syntax of the LDAP search filter specification (refer to RFC 1960, "A String Representation of LDAP Search Filters").
UPnP Driver Managed Log Configuration with mbs.upnp.managed.log PID – Enables the generation of debug information about the runtime behavior of the UPnP Driver bundle. The properties provided with this configuration can differ for the different versions of the UPnP Driver bundle. By default this configuration is disabled.

They can be configured via console commands, or you can use the Web Admin Console. The following table lists the properties and the values with which they should be populated.

Configuration Property	Name	PID	Type	Default Value	Description
m-search.mx	Search timeout	mbs.upnp.pid	int	30	Required. The maximum time in seconds to wait for a control point to receive response to its search request (see the "UPnP Device Architecture 1.1" specification).
subscribe.time.out	Subscription timeout	mbs.upnp.pid	int	1800	Required. Timeout in seconds to re-subscribe to events from a device exported to the UPnP network through the UPnP Driver Bundle. This timeout is specified by the exported device.
subscribe.time.out.cp	Subscription timeout for control point	mbs.upnp.pid	int	1800	Required. Timeout in seconds to re-subscribe to events from a device imported from the UPnP network through the UPnP Driver Bundle. This configures the HTTP headers used.
mbs.upnp.em.max_age	Device time to live	mbs.upnp.pid	int	1800	Required. The time in seconds for which all devices will be advertised to be available on the network.
upnp.http.minport	Http server minimum port	mbs.upnp.pid	int	40044	Required. The minimum port number for the HTTP server, integrated in the UPnP Driver Bundle, to open a socket.
upnp.http.maxport	Http server maximum port	mbs.upnp.pid	int	40144	Required. The maximum port number for the HTTP server to open a socket.
upnp.multicast.port	UPnP Multicast Port	mbs.upnp.pid	int	1900	Required. The port to listen for multicast discovery and search messages.
mbs.upnp.em.readvertise_timeout	Device time to live	mbs.upnp.pid	int	90	Required. The time, as a percent of the mbs.upnp.em.max_age (90% of 1800 seconds), that needs to pass in order for a device to be re-advertised for its existence in the network.
mbs.upnp.multicast.serverless.operation	No multicast socket	mbs.upnp.pid	boolean	false	Required. Even when no multicast socket can be created, it is still possible for the UPnP driver to operate.
mbs.upnp.watchdog	Start UPnP Watchdog service	mbs.upnp.pid	boolean	false	Optional. A flag to turn on or off the watchdog.
mbs.upnp.server.socket.timeout	Specifies the timeout of the servers' blocking operations	mbs.upnp.pid	int	0	Optional. Specifies UPnP servers' socket timeout on the blocking operations.
mbs.upnp.watchdog.timeout	Specify the monitoring time period of the Watchdog service	mbs.upnp.pid	long	30000	Optional. The time period in milliseconds over which the watchdog will check the network properties of the OSGi device.
mbs.upnp.subscription.maxRetries	Specifies the number of the maximum subscription retries in case of fail	mbs.upnp.pid	int	0	Optional. UPnP Driver will retry the subscription until a success or maximum subscription attempts are reached.
upnp.bind.address	Specifies the UPnP bind addresses	mbs.upnp.pid	String	-	Optional. The IP addresses of the UPnP devices to which the UPnP driver will bind to execute network operations.
mbs.upnp.bind.interfaces	Specifies the UPnP bind interfaces	mbs.upnp.pid	String	-	Optional. The network interfaces that will be used by the UPnP driver to execute network operations.
mbs.upnp.multicast.serverless.operation	Specifies the multicast server requirements.	mbs.upnp.pid	boolean	false	Optional. If set to "true", the UPnP driver can operate even when no multicast socket can be created.
upnp.accept.filter	Accept filter	mbs.upnp.filter.pid	String	-	Optional. LDAP filter which describes accepted devices. For example, if the accept filter is set to "(UPnP.device.friendlyName=accepteddevice)", the UPnP module will import only devices which are named accepteddevice. All devices are accepted if the filter is empty. The reject filter is with higher priority than the accept filter. By default, the accept filter is empty.
upnp.reject.filter	Reject filter	mbs.upnp.filter.pid	String	-	Optional. LDAP filter which describes rejected devices. For example, the filter" (UPnP.device.friendlyName=rejecteddevice)" excludes all devices with friendlyName equal to rejecteddevice. No devices are rejected if the filter is empty. The reject filter takes precedence over the accept filter. By default, the reject filter is empty.
mbs.upnp.debug.enable	Enable UPnP driver debug	mbs.upnp.managed.log	boolean	false	Turns on/off the generation of debug information about the runtime behavior of the UPnP Driver bundle. If you want to use it set this property to "true" and one or more of the other configuration properties to "true".
mbs.upnp.debug.console	Enable UPnP driver debug to be printed in the console	mbs.upnp.managed.log	boolean	false	Print the logged debug entries to the framework runtime console if set to "true".