jreceiver.common.rec.driver
Interface Driver

All Superinterfaces:

Hashable, Rec

All Known Implementing Classes:

DriverRec

public interface Driver

extends Rec

An interface describing a JRec driver, which can serve one or more Players.

Version:

$Revision: 1.3 $ $Date: 2002/09/30 08:55:37 $

Author:

Reed Esau

Field Summary

static java.lang.String	HKEY_CALLBACK_PASSWORD
static java.lang.String	HKEY_CALLBACK_URL
static java.lang.String	HKEY_CALLBACK_USER_ID
static java.lang.String	HKEY_COMMANDS
static java.lang.String	HKEY_DEVICES
static java.lang.String	HKEY_DRIVER_ID
static java.lang.String	HKEY_IS_ACTIVE
static java.lang.String	HKEY_MASTER_MASK
static java.lang.String	HKEY_MIME_MASK
static java.lang.String	HKEY_PER_USER_SETTINGS
static java.lang.String	HKEY_SLAVE_MASK
static java.lang.String	HKEY_SUPPORTS_DEVICE_STATUS
static java.lang.String	HKEY_USER_ID
static java.lang.String	POPULATE_COMMANDLIST provide a list of commands bound to the driver
static java.lang.String	POPULATE_DEVICELIST provide a list of devices serviced by the driver (without status)
static java.lang.String	POPULATE_DEVICESTATUSLIST provide a list of devices serviced by the driver (with status)

Fields inherited from interface jreceiver.common.rec.Rec

HKEY_KEY, NO_LIMIT

Method Summary

java.lang.String	getCallbackPassword() obtain the driver-supplied password for the driver's callback interface
java.net.URL	getCallbackUrl() obtain the url for the driver's callback interface
java.lang.String	getCallbackUserId() obtain the driver-supplied user_id for the driver's callback interface
java.util.Vector	getCommands() obtain a list of all commands the driver supports (TODO: use version: RIO1, RIO2, etc.)
java.lang.String	getDescription() obtain a derived description of a driver
java.util.Vector	getDevices() obtain a list of all Devices the driver is presently serving
int	getId() obtain the unique id of the driver
boolean	getIsActive() has the driver been freshly registered since server start?
int	getMasterMask() obtain the list of supported command medium types in which the devices for this driver are capable are controlling other devices.
int	getMimeMask() obtain a mask describing all the support mime types
boolean	getPerUserSettings() If true, the driver settings are not tied to the user credentials with which it was registered.
int	getSlaveMask() obtain the list of supported command medium types in which the devices for this driver are capable of being controlled by other devices.
boolean	getSupportsDeviceStatus()
java.lang.String	getUserId() obtain the description of the driver
void	setCallbackPassword(java.lang.String password) assign the driver-supplied user_id for the driver's callback interface
void	setCallbackUserId(java.lang.String user_id) assign the driver-supplied user_id for the driver's callback interface
void	setCommands(java.util.Vector commands) assign a list of all Commands the driver supports for its devices
void	setDevices(java.util.Vector devices) assign a list of all Devices the driver is presently serving
void	setIsActive(boolean flag) set whether the driver has been freshly registered since server start
void	setMasterMask(int master_mask)
void	setMimeMask(int mime_mask) assign a mask describing all the support mime types
void	setPerUserSettings(boolean per_user_settings) If true, the driver settings are not tied to the user credentials with which it was registered.
void	setSlaveMask(int slave_mask)
void	setSupportsDeviceStatus(boolean flag)
void	setUserId(java.lang.String user_id) assign the description of the driver

Methods inherited from interface jreceiver.common.rec.Rec

getKey, setKey

Methods inherited from interface jreceiver.common.rec.Hashable

toHash, toString

Field Detail

HKEY_DRIVER_ID

public static final java.lang.String HKEY_DRIVER_ID

HKEY_USER_ID

public static final java.lang.String HKEY_USER_ID

HKEY_DEVICES

public static final java.lang.String HKEY_DEVICES

HKEY_CALLBACK_URL

public static final java.lang.String HKEY_CALLBACK_URL

HKEY_CALLBACK_USER_ID

public static final java.lang.String HKEY_CALLBACK_USER_ID

HKEY_CALLBACK_PASSWORD

public static final java.lang.String HKEY_CALLBACK_PASSWORD

HKEY_MIME_MASK

public static final java.lang.String HKEY_MIME_MASK

HKEY_MASTER_MASK

public static final java.lang.String HKEY_MASTER_MASK

HKEY_SLAVE_MASK

public static final java.lang.String HKEY_SLAVE_MASK

HKEY_PER_USER_SETTINGS

public static final java.lang.String HKEY_PER_USER_SETTINGS

HKEY_SUPPORTS_DEVICE_STATUS

public static final java.lang.String HKEY_SUPPORTS_DEVICE_STATUS

HKEY_IS_ACTIVE

public static final java.lang.String HKEY_IS_ACTIVE

HKEY_COMMANDS

public static final java.lang.String HKEY_COMMANDS

POPULATE_COMMANDLIST

public static final java.lang.String POPULATE_COMMANDLIST

provide a list of commands bound to the driver

POPULATE_DEVICELIST

public static final java.lang.String POPULATE_DEVICELIST

provide a list of devices serviced by the driver (without status)

POPULATE_DEVICESTATUSLIST

public static final java.lang.String POPULATE_DEVICESTATUSLIST

provide a list of devices serviced by the driver (with status)

Method Detail

getId

public int getId()

obtain the unique id of the driver

getUserId

public java.lang.String getUserId()

obtain the description of the driver

setUserId

public void setUserId(java.lang.String user_id)

assign the description of the driver

getDevices

public java.util.Vector getDevices()

obtain a list of all Devices the driver is presently serving

setDevices

public void setDevices(java.util.Vector devices)

assign a list of all Devices the driver is presently serving

getCommands

public java.util.Vector getCommands()

obtain a list of all commands the driver supports (TODO: use version: RIO1, RIO2, etc.)

setCommands

public void setCommands(java.util.Vector commands)

assign a list of all Commands the driver supports for its devices

getCallbackUrl

public java.net.URL getCallbackUrl()

obtain the url for the driver's callback interface

getCallbackUserId

public java.lang.String getCallbackUserId()

obtain the driver-supplied user_id for the driver's callback interface

setCallbackUserId

public void setCallbackUserId(java.lang.String user_id)

assign the driver-supplied user_id for the driver's callback interface

getCallbackPassword

public java.lang.String getCallbackPassword()

obtain the driver-supplied password for the driver's callback interface

setCallbackPassword

public void setCallbackPassword(java.lang.String password)

assign the driver-supplied user_id for the driver's callback interface

getDescription

public java.lang.String getDescription()

obtain a derived description of a driver

getMimeMask

public int getMimeMask()

obtain a mask describing all the support mime types

See Mime for a list of the constants.

setMimeMask

public void setMimeMask(int mime_mask)

assign a mask describing all the support mime types

See Mime for a list of the constants.

getMasterMask

public int getMasterMask()

obtain the list of supported command medium types in which the devices for this driver are capable are controlling other devices.

setMasterMask

public void setMasterMask(int master_mask)

getSlaveMask

public int getSlaveMask()

obtain the list of supported command medium types in which the devices for this driver are capable of being controlled by other devices.

setSlaveMask

public void setSlaveMask(int slave_mask)

getPerUserSettings

public boolean getPerUserSettings()

If true, the driver settings are not tied to the user credentials with which it was registered.

setPerUserSettings

public void setPerUserSettings(boolean per_user_settings)

If true, the driver settings are not tied to the user credentials with which it was registered.

getSupportsDeviceStatus

public boolean getSupportsDeviceStatus()

setSupportsDeviceStatus

public void setSupportsDeviceStatus(boolean flag)

getIsActive

public boolean getIsActive()

has the driver been freshly registered since server start?

setIsActive

public void setIsActive(boolean flag)

set whether the driver has been freshly registered since server start