Package buildbot :: Package status :: Package web :: Module xmlrpc :: Class XMLRPCServer
[frames] | no frames]

Class XMLRPCServer

source code

twisted.web.resource.Resource --+    
                                |    
        twisted.web.xmlrpc.XMLRPC --+
                                    |
                                   XMLRPCServer

Nested Classes

Inherited from twisted.web.resource.Resource: entityType

Instance Methods
 
__init__(self)
Initialize.
source code
 
render(self, req)
Render a given resource.
source code
 
xmlrpc_getAllBuilders(self)
Return a list of all builder names
source code
 
xmlrpc_getLastBuildResults(self, builder_name)
Return the result of the last build for the given builder
source code
 
xmlrpc_getLastBuildsAllBuilders(self, num_builds)
Return the last N completed builds for all builders.
source code
 
xmlrpc_getLastBuilds(self, builder_name, num_builds)
Return the last N completed builds for the given builder.
source code
 
xmlrpc_getAllBuildsInInterval(self, start, stop)
Return a list of builds that have completed after the 'start' timestamp and before the 'stop' timestamp.
source code
 
xmlrpc_getBuild(self, builder_name, build_number)
Return information about a specific build.
source code

Inherited from twisted.web.xmlrpc.XMLRPC: getSubHandler, getSubHandlerPrefixes, putSubHandler, render_POST

Inherited from twisted.web.resource.Resource: __providedBy__, delEntity, getChild, getChildForRequest, getChildWithDefault, getDynamicEntity, getStaticEntity, listDynamicEntities, listDynamicNames, listEntities, listNames, listStaticEntities, listStaticNames, putChild, reallyPutEntity, render_HEAD

Class Variables

Inherited from twisted.web.xmlrpc.XMLRPC: FAILURE, NOT_FOUND, allowedMethods, isLeaf, separator

Inherited from twisted.web.resource.Resource: __implemented__, __provides__, server

Method Details

__init__(self)
(Constructor)

source code 

Initialize.

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

render(self, req)

source code 

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)

xmlrpc_getLastBuildsAllBuilders(self, num_builds)

source code 
Return the last N completed builds for all builders.

'num_builds' is the number of builds for each builder to
    return

xmlrpc_getLastBuilds(self, builder_name, num_builds)

source code 

Return the last N completed builds for the given builder. 'builder_name' is the name of the builder to query 'num_builds' is the number of builds to return

Each build is returned in the same form as xmlrpc_getAllBuildsInInterval

xmlrpc_getAllBuildsInInterval(self, start, stop)

source code 

Return a list of builds that have completed after the 'start' timestamp and before the 'stop' timestamp. This looks at all Builders.

The timestamps are integers, interpreted as standard unix timestamps (seconds since epoch).

Each Build is returned as a tuple in the form:

(buildername, buildnumber, build_end, branchname, revision,
 results, text)

The buildnumber is an integer. 'build_end' is an integer (seconds since epoch) specifying when the build finished.

The branchname is a string, which may be an empty string to indicate None (i.e. the default branch). The revision is a string whose meaning is specific to the VC system in use, and comes from the 'got_revision' build property. The results are expressed as a string, one of ('success', 'warnings', 'failure', 'exception'). The text is a list of short strings that ought to be joined by spaces and include slightly more data about the results of the build.