returns the userinfo ui
as user, password if properly formatted as ‘user:password’
escapes ‘user:password’ v
based on RFC 1738 section 3.1
private method to cleanup attributes
, scope
, filter
and extensions
, from using the query
component attribute
private setter for filter val
private setter for headers v
returns Regexp
that is default self.regexp, unless schemes
is provided. Then it is a Regexp.union
with self.pattern
Constructs the default Hash
of patterns
Constructs the default Hash
of Regexp’s
returns Regexp
that is default self.regexp, unless schemes
is provided. Then it is a Regexp.union
with self.pattern
Constructs the default Hash
of patterns
Constructs the default Hash
of Regexp’s
Creates an error page for exception ex
with an optional backtrace
Finds a servlet for path
Returns [ methodname, params ]
Returns paramOrFault
Adds aBlock
to the list of handlers, with name
as the name of the method.
Parameters signature
and help
are used by the Introspection method if specified, where signature
is either an Array containing strings each representing a type of it’s signature (the first is the return value) or an Array of Arrays if the method has multiple signatures.
Value type-names are “int, boolean, double, string, dateTime.iso8601
, base64, array, struct”.
Parameter help
is a String with information about how to call this method etc.
When a method fails, it can tell the client by throwing an XMLRPC::FaultException
like in this example:
s.add_handler("michael.div") do |a,b| if b == 0 raise XMLRPC::FaultException.new(1, "division by zero") else a / b end end
In the case of b==0
the client gets an object back of type XMLRPC::FaultException
that has a faultCode
and faultString
field.
This is the second form of ((<add_handler|XMLRPC::BasicServer#add_handler>)). To add an object write:
server.add_handler("michael", MyHandlerClass.new)
All public methods of MyHandlerClass are accessible to the XML-RPC clients by michael."name of method"
. This is where the class_delim
in XMLRPC::BasicServer.new
plays it’s role, a XML-RPC method-name is defined by prefix
+ class_delim
+ "name of method"
.
The third form of +add_handler is to use XMLRPC::Service::Interface
to generate an object, which represents an interface (with signature and help text) for a handler class.
The interface
parameter must be an instance of XMLRPC::Service::Interface
. Adds all methods of obj
which are defined in the interface
to the server.
This is the recommended way of adding services to a server!
Attempts to obtain the lock and returns immediately. Returns true
if the lock was granted.