jreceiver.common.rpc
Interface Drivers

All Superinterfaces:
RpcBase, ServerTable

public interface Drivers
extends ServerTable

Driver-related queries and updates for a (possibly-remote) JRec server.

Version:
$Revision: 1.5 $ $Date: 2002/07/31 11:29:41 $
Author:
Reed Esau

Field Summary
static java.lang.String EXECUTE_COMMAND
           
static java.lang.String GET_RECS_FOR_SETTINGS
           
static java.lang.String GET_SERVER_VERSION
           
static java.lang.String HANDLER_NAME
           
static java.lang.String REGISTER
           
static java.lang.String REGISTER_COMMAND_SET
           
 
Fields inherited from interface jreceiver.common.rpc.ServerTable
DELETE_RECS, GET_KEY_COUNT, GET_KEYS, GET_REC, GET_RECS, STORE_REC, STORE_RECS
 
Fields inherited from interface jreceiver.common.rpc.RpcBase
DETECT
 
Method Summary
 void executeCommand(Device device, Command cmd)
          asynchronously send a command to the driver for a device
 java.util.Vector getRecsForSettings(java.lang.String order_by, java.util.Hashtable args, int rec_offset, int rec_count)
          Obtain a list of drivers that for which the user is authorized to modify settings.
 java.lang.String getServerVersion()
          returns the version string of the RPC server
 Driver register(java.net.URL callback_url, java.lang.String callback_user_id, java.lang.String callback_password, java.util.Vector supported_content_types, java.util.Vector master_medium_types, java.util.Vector slave_medium_types, boolean per_user_settings)
          register a driver with the server
 void registerCommandSet(int driver_id, java.util.Vector supported_commands)
          register a driver version with the server
 
Methods inherited from interface jreceiver.common.rpc.ServerTable
deleteRecs, getKeyCount, getKeys, getRec, getRec, getRecs, getRecs, storeRec, storeRecs
 
Methods inherited from interface jreceiver.common.rpc.RpcBase
detect
 

Field Detail

HANDLER_NAME

public static final java.lang.String HANDLER_NAME

REGISTER

public static final java.lang.String REGISTER

REGISTER_COMMAND_SET

public static final java.lang.String REGISTER_COMMAND_SET

EXECUTE_COMMAND

public static final java.lang.String EXECUTE_COMMAND

GET_RECS_FOR_SETTINGS

public static final java.lang.String GET_RECS_FOR_SETTINGS

GET_SERVER_VERSION

public static final java.lang.String GET_SERVER_VERSION
Method Detail

getServerVersion

public java.lang.String getServerVersion()
                                  throws RpcException
returns the version string of the RPC server
Returns:
 

register

public Driver register(java.net.URL callback_url,
                       java.lang.String callback_user_id,
                       java.lang.String callback_password,
                       java.util.Vector supported_content_types,
                       java.util.Vector master_medium_types,
                       java.util.Vector slave_medium_types,
                       boolean per_user_settings)
                throws RpcException
register a driver with the server

registerCommandSet

public void registerCommandSet(int driver_id,
                               java.util.Vector supported_commands)
                        throws RpcException
register a driver version with the server

executeCommand

public void executeCommand(Device device,
                           Command cmd)
                    throws RpcException
asynchronously send a command to the driver for a device

getRecsForSettings

public java.util.Vector getRecsForSettings(java.lang.String order_by,
                                           java.util.Hashtable args,
                                           int rec_offset,
                                           int rec_count)
                                    throws RpcException
Obtain a list of drivers that for which the user is authorized to modify settings.

Unlike the normal Driver.getRecs(), this method does not restrict the list of Drivers returned to those 'owned' by the user making the request -- i.e., where the credentials are the same.

Instead, it returns a list of drivers which will respond to user requests to change settings. For example, even though the mgr app is registered with minimal credentals, it nevertheless allows any logged in user to assigned their own 'theme'.



Copyright © 2001-2002 Reed Esau, All Rights Reserved.