elisa.plugins.hal.hal_resource.HALResource

HAL resource provider. Provides volumes:// URI and sends messages on the bus when devices are plugged or unplugged (devices include CDs and DVDs).

Class Variables
	log_category = `"hal_resource"`
	volumes_uri = `'^volumes://'`
	volumes_re = `re.compile(volumes_uri)`
	device_uri = `'^device://'`
	device_re = `re.compile(device_uri)`
str	supported_uri = `volumes_uri+ '\|'+ device_uri` regular expression defining what URIs a ResourceProvider can handle
	default_filter = `'removable', 'dvd', 'cdda'`
Inherited from `extern.log.log.Loggable`: `logCategory`
Inherited from core.component.Component
	config_doc = `{}`
	default_config = `{}`
	name = `property(fget= name__get, fset= name__set)`
	path = `PathDescriptor()`

initialize(self)

source code

Initialize the component.

This method is called by Component.create to finish the initialization of a component.

Returns: twisted.internet.defer.Deferred: a deferred called when a component is fully initialized
Overrides: core.component.Component.initialize: (inherited documentation)

get(self, uri, context_model=None)

source code

Simple method to retrieve volumes or other devices.

Access to volumes is done using the volumes:// uri and an optional filter parameter. If you specify it only these kind of volumes show up. Example:

  volumes://localhost/?filter=dvd,cdda

would only give you dvds and cddas. The three knows filters are: dvd, removable and cdda.

The default is that all filters are applied (like filter=dvd,cdda,removable).

In return you get a elisa.plugins.base.models.device.DevicesModel

Access to any kind of device is done using the device://localhost/path/to/udi. Example:

 device://localhost/org/freedesktop/Hal/devices/computer

would return a elisa.plugins.hal.hal.HALDeviceModel containing all the informations about the computer device. Please note though, that get() will return a None model at first and that the correct model will be returned by the callback of the deferred.

Parameters:

uri - URI pointing to the resource
context_model - the URI often comes from a certain context. For example a URI pointing to a MusicAlbum can come from a Model that could contain the album cover or the album name. If the context_model is provided the resource_provider should try to reuse its data if possible.

Returns: tuple of elisa.core.components.model.Model elisa.core.utils.defer.Deferred

a new model and a deferred fired when the model is fully loaded

Overrides: core.components.resource_provider.ResourceProvider.get

Class HALResource

initialize(self)

clean(self)

get(self, uri, context_model=None)

Properties
Inherited from `object`: `__class__`