123456789_123456789_123456789_123456789_123456789_

Class: XMLRPC::ModRubyServer

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, BasicServer
Instance Chain:
self, BasicServer, ParseContentType, ParserWriterChooseMixin
Inherits: XMLRPC::BasicServer
Defined in: lib/xmlrpc/server.rb

Overview

Implements a XML-RPC server, which works with Apache mod_ruby.

Use it in the same way as XMLRPC::CGIServer!

Constant Summary

BasicServer - Inherited

ERR_MC_EXPECTED_STRUCT, ERR_MC_MISSING_METHNAME, ERR_MC_MISSING_PARAMS, ERR_MC_RECURSIVE_CALL, ERR_MC_WRONG_PARAM, ERR_MC_WRONG_PARAM_PARAMS, ERR_METHOD_MISSING, ERR_UNCAUGHT_EXCEPTION

Class Method Summary

BasicServer - Inherited

.new

Creates a new BasicServer instance, which should not be done, because BasicServer is an abstract class.

Instance Method Summary

BasicServer - Inherited

#add_handler

Adds aBlock to the list of handlers, with name as the name of the method.
#add_introspection

Adds the introspection handlers "system.listMethods", "system.methodSignature" and "system.methodHelp", where only the first one works.
#add_multicall

Adds the multi-call handler "system.multicall".
#get_default_handler

Returns the default-handler, which is called when no handler for a method-name is found.
#get_service_hook

Returns the service-hook, which is called on each service request (RPC) unless it's nil.
#process,
#set_default_handler

Sets handler as the default-handler, which is called when no handler for a method-name is found.
#set_service_hook

A service-hook is called for each service request (RPC).
#call_method,
#check_arity

Returns true, if the arity of obj matches n_args
#dispatch, #handle, #multicall_fault

ParseContentType - Included

#parse_content_type

ParserWriterChooseMixin - Included

#set_parser

Sets the XMLParser to use for parsing XML documents.
#set_writer

Sets the XMLWriter to use for generating XML output.
#create, #parser

Constructor Details

.new(*a) ⇒ ModRubyServer

Creates a new ModRubyServer instance.

All parameters given are by-passed to BasicServer.new.

[ GitHub ] 

  


# File 'lib/xmlrpc/server.rb', line 467



def initialize(*a)
  @ap = Apache::request
  super(*a)
end


  







Instance Method Details



  

    #http_error(status, message)   (private)
  

  [ GitHub ]


  

  


# File 'lib/xmlrpc/server.rb', line 500



def http_error(status, message)
  err = "#{status} #{message}"
  msg = <<-"MSGEND"
    <html>
      <head>
        <title>#{err}</title>
      </head>
      <body>
        <h1>#{err}</h1>
        <p>Unexpected error occurred while processing XML-RPC request!</p>
      </body>
    </html>
  MSGEND

  http_write(msg, status, "Status" => err, "Content-type" => "text/html")
  throw :exit_serve # exit from the #serve method
end


  








  

    #http_write(body, status, header)   (private)
  

  [ GitHub ]


  

  


# File 'lib/xmlrpc/server.rb', line 518



def http_write(body, status, header)
  h = {}
  header.each {|key, value| h[key.to_s.capitalize] = value}
  h['Status']         ||= "200 OK"
  h['Content-length'] ||= body.bytesize.to_s

  h.each {|key, value| @ap.headers_out[key] = value }
  @ap.content_type = h["Content-type"]
  @ap.status = status.to_i
  @ap.send_http_header

  @ap.print body
end


  








  

    #serve  
  



  

    

Call this after you have added all you handlers to the server.



This method processes a XML-RPC method call and sends the answer back to the client.


  



  [ GitHub ]


  

  


# File 'lib/xmlrpc/server.rb', line 476



def serve
  catch(:exit_serve) {
    header = {}
    @ap.headers_in.each {|key, value| header[key.capitalize] = value}

    length = header['Content-length'].to_i

    http_error(405, "Method Not Allowed") unless @ap.request_method  == "POST"
    http_error(400, "Bad Request")        unless parse_content_type(header['Content-type']).first == "text/xml"
    http_error(411, "Length Required")    unless length > 0

    # TODO: do we need a call to binmode?
    @ap.binmode
    data = @ap.read(length)

    http_error(400, "Bad Request")        if data.nil? or data.bytesize != length

    http_write(process(data), 200, "Content-type" => "text/xml; charset=utf-8")
  }
end