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 java.lang.String

ROLE

Method Summary

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

Field Detail

ROLE

public static final java.lang.String ROLE

Method Detail

executeRpc

public java.lang.Object executeRpc(java.net.URL url,
                                   java.lang.String methodName,
                                   java.util.Vector params)
                            throws java.lang.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

java.io.IOException

java.lang.Exception

registerHandler

public void registerHandler(java.lang.String handlerName,
                            java.lang.Object handler)
                     throws org.apache.xmlrpc.XmlRpcException,
                            java.io.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

java.io.IOException

registerHandler

public void registerHandler(java.lang.Object handler)
                     throws org.apache.xmlrpc.XmlRpcException,
                            java.io.IOException

Register an object as a the default handler for the XmlRpc Server part.

Parameters:

handler - The handler object

Throws:

org.apache.xmlrpc.XmlRpcException

java.io.IOException

unregisterHandler

public void unregisterHandler(java.lang.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

public void setParanoid(boolean state)

Switch client filtering on/off.

See Also:

acceptClient( java.lang.String ), denyClient( java.lang.String )

acceptClient

public void acceptClient(java.lang.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

public void denyClient(java.lang.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

public void addMessageListener(XmlRpcMessageListener listener)

Message Listener.

messageReceived

public void messageReceived(java.lang.String fileContents)

Message Received.