exiddis::master::AdminHandler::AdminHandler Class Reference

List of all members.

Public Member Functions
def	__init__
def	setLinks
def	xmlrpc_consoleIntroduce
def	xmlrpc_createUser
def	xmlrpc_grantRight
def	xmlrpc_newIterSeq
def	xmlrpc_newRandSeq
def	xmlrpc_listSequences
def	xmlrpc_listWorkers
def	xmlrpc_listUsers
Public Attributes
	parent
	logger
	sequences
	workers
	administration

---

Detailed Description

Implement XML-RPC functions for handling requests from administrative console.

---

Member Function Documentation

def exiddis::master::AdminHandler::AdminHandler::__init__	(		self,
			parent
	)

Create new instance of AdminHandler class.

Keyword parameters:
parent - reference to parent object (e.g. MasterServer class instance)

def exiddis::master::AdminHandler::AdminHandler::setLinks

(

self

)

Set useful reference links (shortcuts) to other parts of Master server application.

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_consoleIntroduce	(		self,
			request = None
	)

Inform that the administrative console is now connected to the server and return 'OK' code.

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_createUser	(		self,
			role,
			request = None
	)

Handle the request for creating new user.

Keyword parameters:
role - the role assigned to the user

Return hex code for the user.

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_grantRight	(		self,
			user,
			seq,
			right,
			request = None
	)

Handle the requset for granting given user some rights.

Keyword parameters:
user  - user id
seq   - name of the sequence to which the rights should be granted
right - type of rights to be granted

Return 'OK' code.

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_listSequences	(		self,
			request
	)

Return (as a string) the list of all sequences in the system in format "<name> (id: <id>)".

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_listUsers	(		self,
			request
	)

Return (as a string) the list of all users in the system in format "<id> : <role>".

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_listWorkers	(		self,
			request
	)

Return (as a string) the list of all workers in the system in format "<id> - <host>:<port>".

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_newIterSeq	(		self,
			seqName,
			rangeBegin,
			rangeEnd,
			step = 1,
			request = None
	)

Handle the request for creating new iterative sequence (e.g. arithmetic progression).

Keyword parameters:
seqName    - the name that will be given to the sequence
rangeBegin - the begining of the interval (the interval is open so the first value of the sequence will be the next value e.g. rangeBegin + step)
rangeEnd   - the end of the interval (the interval is open so this value is NOT in range)
step       - the difference of any two succesive members of the sequence (default is 1)

Return:
* map with 'code' value set to 'ERROR' code - if error occured,
* map with 'code' value set to 'OK' code and 'id' value set to sequence's id string - otherwise.

def exiddis::master::AdminHandler::AdminHandler::xmlrpc_newRandSeq	(		self,
			seqName,
			bits,
			request = None
	)

Handle the request for creating new random sequence.

Keyword parameters:
seqName - the name that will be given to the sequence
bits    - the number of bits that indicates the interval of the sequence (e.g. 0 to 2^bits-1); see lib/Sequences.py documentation for more details

Return:
* map with 'code' value set to 'ERROR' code - if error occured,
* map with 'code' value set to 'OK' code and 'id' value set to sequence's id string - otherwise.

---

The documentation for this class was generated from the following file:

• exiddis/master/AdminHandler.py