Trees       Index       Help   

Zenoss

Package twisted :: Package web :: Module xmlrpc :: Class XMLRPC
[show private | hide private]
[frames | no frames]

Class XMLRPC

Resource --+
           |
          XMLRPC

Known Subclasses:
ZenX

A resource that implements XML-RPC.

You probably want to connect this to '/RPC2'.

Methods published can return XML-RPC serializable results, Faults, Binary, Boolean, DateTime, Deferreds, or Handler instances.

By default methods beginning with 'xmlrpc_' are published.

Sub-handlers for prefixed methods (e.g., system.listMethods) can be added with putSubHandler. By default, prefixes are separated with a '.'. Override self.separator to change this.
Method Summary
  __init__(self)
Initialize.
  getSubHandler(self, prefix)
  getSubHandlerPrefixes(self)
  putSubHandler(self, prefix, handler)
  render(self, request)
Render a given resource.
Inherited from Resource: delEntity, getChild, getChildForRequest, getChildWithDefault, getDynamicEntity, getStaticEntity, listDynamicEntities, listDynamicNames, listEntities, listNames, listStaticEntities, listStaticNames, putChild, reallyPutEntity, render_HEAD

Class Variable Summary
int FAILURE = 8002                                                                  
int isLeaf = 1                                                                     
int NOT_FOUND = 8001                                                                  
str separator = '.'
Inherited from Resource: __implemented__, __providedBy__, __provides__, entityType, server

Method Details

__init__(self, allowNone=False)
(Constructor)

Initialize.
Overrides:
twisted.web.resource.Resource.__init__ (inherited documentation)

render(self, request)

Render a given resource. See IResource's render method.

I delegate to methods of self with the form 'render_METHOD' where METHOD is the HTTP that was used to make the request. Examples: render_GET, render_HEAD, render_POST, and so on. Generally you should implement those methods instead of overriding this one.

render_METHOD methods are expected to return a string which will be the rendered page, unless the return value is twisted.web.server.NOT_DONE_YET, in which case it is this class's responsibility to write the results to request.write(data), then call request.finish().

Old code that overrides render() directly is likewise expected to return a string or NOT_DONE_YET.
Overrides:
twisted.web.resource.Resource.render (inherited documentation)

Class Variable Details

FAILURE

Type:
int
Value:
8002                                                                  

isLeaf

Type:
int
Value:
1                                                                     

NOT_FOUND

Type:
int
Value:
8001                                                                  

separator

Type:
str
Value:
'.'

   Trees       Index       Help   

Zenoss

Generated by Epydoc 2.1 on Thu Aug 16 09:55:08 2007 http://epydoc.sf.net