org.codehaus.plexus.xmlrpc
Interface XmlRpcComponent

All Known Implementing Classes:
DefaultXmlRpcComponent

public interface XmlRpcComponent

The interface an XmlRpcService implements.

Version:
$Id: XmlRpcComponent.java 1426 2005-01-28 10:05:00Z trygvis $
Author:
Josh Lucas, Magn?s ??r Torfason, Rafal Krzewski, Jason van Zyl, Trygve Laugstøl

Field Summary
static String ROLE
           
 
Method Summary
 void acceptClient(String address)
          Add an IP address to the list of accepted clients.
 void addMessageListener(XmlRpcMessageListener listener)
          Message Listener.
 void denyClient(String address)
          Add an IP address to the list of denied clients.
 Object executeRpc(URL url, String methodName, Vector params)
          Execute a remote procedure call.
 void messageReceived(String fileContents)
          Message Received.
 void registerHandler(Object handler)
          Register an object as a the default handler for the XmlRpc Server part.
 void registerHandler(String handlerName, Object handler)
          Register an object as a handler for the XmlRpc Server part.
 void setParanoid(boolean state)
          Switch client filtering on/off.
 void unregisterHandler(String handlerName)
          Unregister a handler.
 

Field Detail

ROLE

static final String ROLE
Method Detail

executeRpc

Object executeRpc(URL url,
                  String methodName,
                  Vector params)
                  throws Exception
Execute a remote procedure call.

Parameters:
url - A URL.
methodName - A String with the method name.
params - A Vector with the parameters.
Returns:
An Object.
Throws:
org.apache.xmlrpc.XmlRpcException
IOException
Exception

registerHandler

void registerHandler(String handlerName,
                     Object handler)
                     throws org.apache.xmlrpc.XmlRpcException,
                            IOException
Register an object as a handler for the XmlRpc Server part.

Parameters:
handlerName - The name under which we want to register the service
handler - The handler object
Throws:
org.apache.xmlrpc.XmlRpcException
IOException

registerHandler

void registerHandler(Object handler)
                     throws org.apache.xmlrpc.XmlRpcException,
                            IOException
Register an object as a the default handler for the XmlRpc Server part.

Parameters:
handler - The handler object
Throws:
org.apache.xmlrpc.XmlRpcException
IOException

unregisterHandler

void unregisterHandler(String handlerName)
                       throws org.apache.xmlrpc.XmlRpcException
Unregister a handler.

Parameters:
handlerName - The name of the handler to unregister.
Throws:
org.apache.xmlrpc.XmlRpcException

setParanoid

void setParanoid(boolean state)
Switch client filtering on/off.

See Also:
acceptClient( java.lang.String ), denyClient( java.lang.String )

acceptClient

void acceptClient(String address)
Add an IP address to the list of accepted clients. The parameter can contain '*' as wildcard character, e.g. "192.168.*.*". You must call setParanoid(true) in order for this to have any effect.

See Also:
denyClient( java.lang.String ), setParanoid( boolean )

denyClient

void denyClient(String address)
Add an IP address to the list of denied clients. The parameter can contain '*' as wildcard character, e.g. "192.168.*.*". You must call setParanoid(true) in order for this to have any effect.

See Also:
acceptClient( java.lang.String ), setParanoid( boolean )

addMessageListener

void addMessageListener(XmlRpcMessageListener listener)
Message Listener.


messageReceived

void messageReceived(String fileContents)
Message Received.



Copyright © 2001-2011 Codehaus. All Rights Reserved.