com.hp.device

Class DefaultDeviceDriverProvider

java.lang.Object

com.hp.device.AbstractDeviceDriverProvider

com.hp.device.DefaultDeviceDriverProvider

All Implemented Interfaces:

DeviceDriverProvider

public class DefaultDeviceDriverProvider
extends AbstractDeviceDriverProvider

Default device driver provider implementation, which allows assembly of device driver using off-the-shelf implementations via XML-encoded resources and/or files.

The XML configuration is expected to resemble the following format:

<deviceDriver description="..." [origin="..."]>

     <{type|abstractType} name="..." [alias="..."] [extends="..."]
                          description="...">
         [
          <oid>...</oid>
          <oid>...</oid>
          ...
         ]
         [<fw>...</fw>]

         [<vendor>...</vendor>]
         [<family>...</family>]
         [<product>...</product>]
         [<model>...</model>]

         [<handler class="..." />]
         [<loader class="..." [platform="..."] />]
 
         <facet name="..." class="..." />
         [<facet drop="..." />]

         <flag name="..." />
         [<flag drop="..." />]

         [
          <typeInfo>
             ...
          </typeInfo>

          <instanceInfo>
             ...
          </instanceInfo>
         ]

         [
          <images path=".../someResourcePath">
             <propertyPageImage>file.jpg</propertyPageImage>
             <topologyMapImage>file.gif</topologyMapImage>
          </path>
         ]

         [
          <trafficCapabilities>
             ...
          </trafficCapabilities>
         ]
     </type>
 
     ...
 </deviceDriver>
 

Author:

Thomas Vachuska, Simon Hunt

Constructor Summary

Constructors

Constructor and Description
DefaultDeviceDriverProvider(String platform) Create a driver provider with the specified platform context.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDriver(File file) Parses the XML-encoded device driver definition from the specified file.
void	addDriver(org.apache.commons.configuration.HierarchicalConfiguration driverDefinition) Parses the device driver definition from the specified hierarchical configuration.
void	addDriver(InputStream in) Parses the XML-encoded data off the specified input stream into a device type instance.
void	addType(boolean isAbstract, org.apache.commons.configuration.HierarchicalConfiguration typeDefinition, String description, String origin) Processes the supplied hierarchical configuration, that contains device type definition.
String	getPlatform() Get the platform context name.
protected void	processFacets(org.apache.commons.configuration.HierarchicalConfiguration typeDefinition, Map<Class<? extends Facet>,Class<? extends AbstractFacet>> facetBindings) Processes the facet bindings and overrides specified in given type definition to augment the provided facet bindings map.
protected void	processFlags(org.apache.commons.configuration.HierarchicalConfiguration typeDefinition, Set<String> flagSet) Processes the flags and augments the provided set.
void	removeType(String typeReference) Removes support for the specified device type.
void	setClassLoader(ClassLoader classLoader) Override the default class loader
String	toString()

Methods inherited from class com.hp.device.AbstractDeviceDriverProvider

addType, addType, create, create, create, create, create, getBindingsCount, getDeviceType, getDeviceTypeNames, getTypesCount, removeType, switchType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultDeviceDriverProvider

public DefaultDeviceDriverProvider(String platform)

Create a driver provider with the specified platform context.

Parameters:

platform - platform context name

Method Detail

getPlatform

public String getPlatform()

Get the platform context name.

Returns:

platform context name

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Override the default class loader

Parameters:

classLoader - preferred class loader

addDriver

public void addDriver(File file)
               throws DeviceException

Parses the XML-encoded device driver definition from the specified file.

Parameters:

file - device driver definition file

Throws:

DeviceException - if problems reading or parsing the file

addDriver

public void addDriver(InputStream in)
               throws DeviceException

Parses the XML-encoded data off the specified input stream into a device type instance.

Parameters:

in - input stream with XML-encoding of device type definition

Throws:

DeviceException - if problems parsing the input stream

addDriver

public void addDriver(org.apache.commons.configuration.HierarchicalConfiguration driverDefinition)
               throws DeviceException

Parses the device driver definition from the specified hierarchical configuration.

Parameters:

driverDefinition - device driver definition

Throws:

DeviceException - if problems parsing the definition

removeType

public void removeType(String typeReference)

Removes support for the specified device type.

Parameters:

typeReference - type name or type alias of the device type to be removed

addType

public void addType(boolean isAbstract,
           org.apache.commons.configuration.HierarchicalConfiguration typeDefinition,
           String description,
           String origin)
             throws DeviceException

Processes the supplied hierarchical configuration, that contains device type definition.

Parameters:

isAbstract - true if the type is an abstract base type

typeDefinition - hierarchical configuration of a type definition

description - a description for the type

origin - an origin of the type (who wrote the device driver) @throws DeviceException if problems

Throws:

DeviceException - if issues processing the type definition

processFacets

protected void processFacets(org.apache.commons.configuration.HierarchicalConfiguration typeDefinition,
                 Map<Class<? extends Facet>,Class<? extends AbstractFacet>> facetBindings)

Processes the facet bindings and overrides specified in given type definition to augment the provided facet bindings map.

Parameters:

typeDefinition - device type configuration

facetBindings - facet binding map to be augmented

processFlags

protected void processFlags(org.apache.commons.configuration.HierarchicalConfiguration typeDefinition,
                Set<String> flagSet)

Processes the flags and augments the provided set.

Parameters:

typeDefinition - device type configuration

flagSet - flag set to be augmented

toString

public String toString()

Overrides:

toString in class AbstractDeviceDriverProvider