com.hp.device

Class DefaultDeviceType

java.lang.Object

com.hp.device.DefaultDeviceType

All Implemented Interfaces:

DeviceType

public class DefaultDeviceType
extends Object
implements DeviceType

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

Author:

Thomas Vachuska, Simon Hunt

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultDeviceType(DefaultDeviceType type) Copy constructor
	DefaultDeviceType(DeviceDriverProvider provider, DefaultDeviceType parentType, String typeName, String vendor, String family, String product, String model, Set<String> oids, String fw, String typeData, String instanceData, com.hp.device.PresentationResources presRes, Map<Class<? extends Facet>,Class<? extends AbstractFacet>> facetBindings, Set<String> flags, Class<? extends DeviceHandler> handlerClass, Class<? extends DeviceLoader> loaderClass, String description, String origin) Creates a base device type associated with the given originating provider.
protected	DefaultDeviceType(DeviceDriverProvider provider, String typeName) Convenience constructor for unit tests that produces a device type that has a name and nothing else.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBinding(Class<? extends Facet> facetClass, Class<? extends AbstractFacet> facetImplementationClass) Allows subclasses to register a facet implementation binding.
boolean	addChild(DeviceType child) Adds a device type as a direct child of this device type.
DeviceHandler	createHandler(DeviceInfo info, IpAddress ip) Return a device handler appropriate for this device type.
DeviceLoader	createLoader(DeviceInfo info, String uid) Return a device handler appropriate for this device type.
DeviceInfo	evolve(DeviceInfo deviceInfo) Return an evolved device info context.
Set<? extends DeviceType>	getChildTypes() Returns the device types that extend this device type directly.
String	getDescription() Returns the description of this device type.
protected Map<Class<? extends Facet>,Class<? extends AbstractFacet>>	getFacetBindings(boolean isHandler) Gets a read-only map of the facet bindings.
String	getFamily() Returns the product family to which this device type belongs.
Set<String>	getFlags() Returns a view of our set of flags.
String	getFw() Returns the firmware version qualifier.
String	getInstanceData() Returns the instance data to be stamped onto newly created DeviceInfo instances.
String	getModel() Gets the model number associated with this type belongs.
Set<String>	getOids() Returns a view of our set of OIDs.
String	getOrigin() Returns the origin of this device type (i.e.
DeviceType	getParentType() Returns the device type that this type extends (or null if no parent).
com.hp.device.PresentationResources	getPresentationResources() Returns the presentation resources associated with this type.
String	getProduct() Returns the product number associated with this device type.
DeviceDriverProvider	getProvider() Returns the provider instance that created this device type.
String	getTypeData() Returns the meta data associated with the type.
String	getTypeName() Returns the name of this device type.
String	getVendor() Returns the vendor of the device represented by this type.
protected void	removeBinding(Class<? extends Facet> facetClass) Allows subclasses to unregister a facet implementation binding.
boolean	removeChild(DeviceType child) Removes a device type from the list of direct children for this type.
String	toDebugString() Produce multi-line debug output for this type instance.
String	toDebugString(int indent) Produce multi-line debug output for this type instance.
String	toShortDebugString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDeviceType

public DefaultDeviceType(DeviceDriverProvider provider,
                 DefaultDeviceType parentType,
                 String typeName,
                 String vendor,
                 String family,
                 String product,
                 String model,
                 Set<String> oids,
                 String fw,
                 String typeData,
                 String instanceData,
                 com.hp.device.PresentationResources presRes,
                 Map<Class<? extends Facet>,Class<? extends AbstractFacet>> facetBindings,
                 Set<String> flags,
                 Class<? extends DeviceHandler> handlerClass,
                 Class<? extends DeviceLoader> loaderClass,
                 String description,
                 String origin)

Creates a base device type associated with the given originating provider.

Parameters:

provider - device info provider from whence we come

parentType - parent type that we extend

typeName - device type name

vendor - the vendor

family - the product family

product - product number string

model - model number string

oids - the set of OIDs

fw - firmware version

typeData - optional device type meta data

instanceData - optional device info initialization (via importData())

presRes - presentation resources (images)

facetBindings - map of facet bindings supported by the device type

flags - a set of flags for this device type

handlerClass - class of the device handler

loaderClass - class of the device loader

description - a description for this device type

origin - the origin of this device type

DefaultDeviceType

protected DefaultDeviceType(DefaultDeviceType type)

Copy constructor

Parameters:

type - device type to copy

DefaultDeviceType

protected DefaultDeviceType(DeviceDriverProvider provider,
                 String typeName)

Convenience constructor for unit tests that produces a device type that has a name and nothing else.

Parameters:

provider - the provider of this type

typeName - the type name

Method Detail

getTypeName

public String getTypeName()

Description copied from interface: DeviceType

Returns the name of this device type.

Specified by:

getTypeName in interface DeviceType

Returns:

the type name

getDescription

public String getDescription()

Description copied from interface: DeviceType

Returns the description of this device type.

Specified by:

getDescription in interface DeviceType

Returns:

the description

getOrigin

public String getOrigin()

Description copied from interface: DeviceType

Returns the origin of this device type (i.e. the organization that created the device driver)

Specified by:

getOrigin in interface DeviceType

Returns:

the origin

getProduct

public String getProduct()

Description copied from interface: DeviceType

Returns the product number associated with this device type.

Specified by:

getProduct in interface DeviceType

Returns:

the product number

getModel

public String getModel()

Description copied from interface: DeviceType

Gets the model number associated with this type belongs.

Specified by:

getModel in interface DeviceType

Returns:

the model number

getParentType

public DeviceType getParentType()

Description copied from interface: DeviceType

Returns the device type that this type extends (or null if no parent).

Specified by:

getParentType in interface DeviceType

Returns:

the parent type

getChildTypes

public Set<? extends DeviceType> getChildTypes()

Description copied from interface: DeviceType

Returns the device types that extend this device type directly.

Specified by:

getChildTypes in interface DeviceType

Returns:

the child types

getVendor

public String getVendor()

Returns the vendor of the device represented by this type.

Returns:

the vendor

getFamily

public String getFamily()

Returns the product family to which this device type belongs.

Returns:

the product family

getOids

public Set<String> getOids()

Returns a view of our set of OIDs.

Returns:

the oids associated with this device type

getFw

public String getFw()

Returns the firmware version qualifier.

Returns:

the firmware version

getTypeData

public String getTypeData()

Returns the meta data associated with the type.

Returns:

the type data

getInstanceData

public String getInstanceData()

Returns the instance data to be stamped onto newly created DeviceInfo instances.

Returns:

the instance data

getPresentationResources

public com.hp.device.PresentationResources getPresentationResources()

Returns the presentation resources associated with this type.

Returns:

the presentation resources

getFlags

public Set<String> getFlags()

Returns a view of our set of flags.

Returns:

the set of flags

addChild

public boolean addChild(DeviceType child)

Adds a device type as a direct child of this device type. This method should only be used by the device driver provider to maintain lineage.

Parameters:

child - the child type to add

Returns:

true if the type was not already a child

removeChild

public boolean removeChild(DeviceType child)

Removes a device type from the list of direct children for this type. This method should only be used by the device driver provider to maintain lineage.

Parameters:

child - the child type to remove

Returns:

true if the type was a child

getProvider

public DeviceDriverProvider getProvider()

Description copied from interface: DeviceType

Returns the provider instance that created this device type.

Specified by:

getProvider in interface DeviceType

Returns:

the provider

getFacetBindings

protected Map<Class<? extends Facet>,Class<? extends AbstractFacet>> getFacetBindings(boolean isHandler)

Gets a read-only map of the facet bindings.

Parameters:

isHandler - true for handler bindings; false for info bindings

Returns:

map of facet bindings currently registered

addBinding

protected void addBinding(Class<? extends Facet> facetClass,
              Class<? extends AbstractFacet> facetImplementationClass)

Allows subclasses to register a facet implementation binding.

Parameters:

facetClass - supported facet interface class

facetImplementationClass - corresponding facet interface implementation class

removeBinding

protected void removeBinding(Class<? extends Facet> facetClass)

Allows subclasses to unregister a facet implementation binding.

Parameters:

facetClass - unsupported facet interface class

evolve

public DeviceInfo evolve(DeviceInfo deviceInfo)

Return an evolved device info context.

Note: implementations should use DeviceDriverProvider.switchType(com.hp.device.MutableDeviceInfo, java.lang.String) if it is determined that the device type needs to change.

This implementation does not perform any evolution and simply returns back the original device info instance.

Specified by:

evolve in interface DeviceType

Parameters:

deviceInfo - the info to evolve

Returns:

the evolved info potentially backed by a different device type

createHandler

public DeviceHandler createHandler(DeviceInfo info,
                          IpAddress ip)

Return a device handler appropriate for this device type.

This implementation uses reflection to instantiate a new handler for the specified arguments.

Specified by:

createHandler in interface DeviceType

Parameters:

info - the device info context

ip - the IP address to bind to

Returns:

a device handler

createLoader

public DeviceLoader createLoader(DeviceInfo info,
                        String uid)

Return a device handler appropriate for this device type.

This implementation uses reflection to instantiate a new handler for the specified arguments.

Specified by:

createLoader in interface DeviceType

Parameters:

info - the device info context

uid - the unique identifier to bind to

Returns:

a device loader

toString

public String toString()

Overrides:

toString in class Object

toShortDebugString

public String toShortDebugString()

toDebugString

public String toDebugString()

Produce multi-line debug output for this type instance.

Returns:

debug output

toDebugString

public String toDebugString(int indent)

Produce multi-line debug output for this type instance.

Parameters:

indent - number of spaces to indent

Returns:

debug output