org.codehaus.plexus.xmlrpc

Interface XmlRpcComponent

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
StringROLE
Method Summary
voidacceptClient(String address)
Add an IP address to the list of accepted clients.
voidaddMessageListener(XmlRpcMessageListener listener)
Message Listener.
voiddenyClient(String address)
Add an IP address to the list of denied clients.
ObjectexecuteRpc(URL url, String methodName, Vector params)
Execute a remote procedure call.
voidmessageReceived(String fileContents)
Message Received.
voidregisterHandler(String handlerName, Object handler)
Register an object as a handler for the XmlRpc Server part.
voidregisterHandler(Object handler)
Register an object as a the default handler for the XmlRpc Server part.
voidsetParanoid(boolean state)
Switch client filtering on/off.
voidunregisterHandler(String handlerName)
Unregister a handler.

Field Detail

ROLE

public String ROLE

Method Detail

acceptClient

public 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: XmlRpcComponent XmlRpcComponent

addMessageListener

public void addMessageListener(XmlRpcMessageListener listener)
Message Listener.

denyClient

public 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: XmlRpcComponent XmlRpcComponent

executeRpc

public Object executeRpc(URL url, String methodName, Vector params)
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: XmlRpcException IOException

messageReceived

public void messageReceived(String fileContents)
Message Received.

registerHandler

public void registerHandler(String handlerName, Object handler)
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: XmlRpcException IOException

registerHandler

public void registerHandler(Object handler)
Register an object as a the default handler for the XmlRpc Server part.

Parameters: handler The handler object

Throws: XmlRpcException IOException

setParanoid

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

See Also: XmlRpcComponent XmlRpcComponent

unregisterHandler

public void unregisterHandler(String handlerName)
Unregister a handler.

Parameters: handlerName The name of the handler to unregister.

Copyright © 2001-2007 Codehaus. All Rights Reserved.