com.hp.device

Class DefaultDeviceIdentityHandler

java.lang.Object

com.hp.device.AbstractFacet

com.hp.device.AbstractDefaultFacet

com.hp.device.DefaultDeviceIdentity

com.hp.device.DefaultDeviceIdentityHandler

All Implemented Interfaces:

DeviceIdentity, DeviceIdentityHandler, Facet, HandlerFacet

Direct Known Subclasses:

ManualDeviceIdentityHandler

public class DefaultDeviceIdentityHandler
extends DefaultDeviceIdentity
implements DeviceIdentityHandler

A default implementation of the device identity handler facet. This implementation makes the assumption that the context is a DefaultDeviceInfo implementation.

Author:

Simon Hunt

Constructor Summary

Constructors

Constructor and Description
DefaultDeviceIdentityHandler(DeviceInfo context) Constructs a device identity configure facet that is projected onto the specified device info context.

Method Summary

Methods

Modifier and Type	Method and Description
void	apply() Apply any pending configuration changes to the device.
void	digest(Object memento) Accepts an opaque memento containing device identity information, presumably obtained from a prior communication with the device.
DeviceInfo	evolve() Return an evolved device info context.
void	fetch() Fetch information pertaining to this facet from the device.
void	generateUniqueId() Generates a globally unique device ID using device specific information and a type-specific algorithm and stamps it into the associated device info entity.
void	setContact(String contact) Set the device contact.
void	setIpAddress(IpAddress ip) Set the IP address associated with this facet, if needed.
void	setLocation(String location) Set the device location.
void	setName(String name) Set the device name.

Methods inherited from class com.hp.device.DefaultDeviceIdentity

getContact, getDescription, getDriverFirmwareVersion, getFamily, getFirmwareVersion, getIpAddress, getLocation, getModelNumber, getName, getProductNumber, getSerialNumber, getUniqueId, getVendor, toDebugString, toString

Methods inherited from class com.hp.device.AbstractDefaultFacet

getContext

Methods inherited from class com.hp.device.AbstractFacet

getTypeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hp.device.DeviceIdentity

getContact, getDescription, getDriverFirmwareVersion, getFamily, getFirmwareVersion, getIpAddress, getLocation, getModelNumber, getName, getProductNumber, getSerialNumber, getUniqueId, getVendor

Methods inherited from interface com.hp.device.HandlerFacet

getIpAddress

Methods inherited from interface com.hp.device.Facet

getContext, getTypeName

Constructor Detail

DefaultDeviceIdentityHandler

public DefaultDeviceIdentityHandler(DeviceInfo context)

Constructs a device identity configure facet that is projected onto the specified device info context.

Parameters:

context - the device info of which this is a facet

Method Detail

setIpAddress

public void setIpAddress(IpAddress ip)

Set the IP address associated with this facet, if needed.

This implementation injects the IP address into the backing device info context, in addition to setting the field via super.

Specified by:

setIpAddress in interface HandlerFacet

Overrides:

setIpAddress in class AbstractFacet

Parameters:

ip - the IP address

fetch

public void fetch()

Fetch information pertaining to this facet from the device.

This implementation does nothing.

Specified by:

fetch in interface HandlerFacet

apply

public void apply()

Apply any pending configuration changes to the device.

This implementation does nothing.

Specified by:

apply in interface HandlerFacet

digest

public void digest(Object memento)

Accepts an opaque memento containing device identity information, presumably obtained from a prior communication with the device. This allows information learned about the device in some protocol-specific manner to be used to avoid a repeated trip (via HandlerFacet.fetch() method) to the device in order to obtain the same information.

Implementations are to interpret and digest the information in this memento into the associated device info instance.

This implementation does nothing.

Specified by:

digest in interface DeviceIdentityHandler

Parameters:

memento - opaque container of device identity information

generateUniqueId

public void generateUniqueId()

Description copied from interface: DeviceIdentityHandler

Generates a globally unique device ID using device specific information and a type-specific algorithm and stamps it into the associated device info entity.

Specified by:

generateUniqueId in interface DeviceIdentityHandler

setName

public void setName(String name)

Description copied from interface: DeviceIdentityHandler

Set the device name.

Specified by:

setName in interface DeviceIdentityHandler

Parameters:

name - the device name

setLocation

public void setLocation(String location)

Description copied from interface: DeviceIdentityHandler

Set the device location.

Specified by:

setLocation in interface DeviceIdentityHandler

Parameters:

location - the device location

setContact

public void setContact(String contact)

Description copied from interface: DeviceIdentityHandler

Set the device contact.

Specified by:

setContact in interface DeviceIdentityHandler

Parameters:

contact - the device contact

evolve

public DeviceInfo evolve()

Description copied from interface: DeviceIdentityHandler

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.

Specified by:

evolve in interface DeviceIdentityHandler

Returns:

the evolved info potentially backed by a different device type