org.opengroupware.jogi.connect.xmlrpc
Interface XmlRpcCaller

All Known Implementing Classes:

ApacheXmlRpcCaller, XmlRpcConnection

public interface XmlRpcCaller

This class defines an interface for an XmlRpc backend implementation. The interface is used for making remote calls to an OpenGroupWare server.

Author:

Werner Schuster (murphee), Andreas Rath (teddius)

Method Summary

java.lang.String	getUsername() Returns the current username used for authentificating against the OpenGroupware server.
java.lang.Object	invoke(java.lang.String method_name, int integer)
java.lang.Object	invoke(java.lang.String method_name, java.util.List param_list) This invokes a XML-RPC call.
java.lang.Object	invoke(java.lang.String method_name, java.lang.String string)
void	setPassword(java.lang.String passwd) Sets the new password used for authentification against the remote OpenGroupware server.
void	setUser(java.lang.String user) Sets the user name used for remote authentification.

Method Detail

invoke

public java.lang.Object invoke(java.lang.String method_name,
                               java.util.List param_list)
                        throws ConnectionException,
                               OgoException

This invokes a XML-RPC call. Use this to provide an adapter to an own XML-RPC library or to customize the way these calls are handled (eg. use SSL transport,...). The returned values must be consitant with the Apache XML-RPC librarys mapping of XML-RPC types to Java types. For collection classes, JOGI currently expects return values to be java.util.Vector for XML-RPC "array" and java.util.Hashtable for XML-RPC "struct". This is mostly due to the fact that the Apache XML-RPC library uses those. CAUTION: future versions of JOGI will require these mappings to be java.util.List (for "array") and java.util.Map (for "struct"), especially to make sure future streaming versions work too.

Parameters:

method_name - the name of the XmlRpc method to call.

param_list - the arguments for the remote method.

Returns:

whatever the XmlRpc library returns (see text above for details).

Throws:

ConnectionException

OgoException

invoke

public java.lang.Object invoke(java.lang.String method_name,
                               java.lang.String string)
                        throws ConnectionException,
                               OgoException

Throws:

ConnectionException

OgoException

invoke

public java.lang.Object invoke(java.lang.String method_name,
                               int integer)
                        throws ConnectionException,
                               OgoException

Throws:

ConnectionException

OgoException

setUser

public void setUser(java.lang.String user)

Sets the user name used for remote authentification.

Parameters:

user - The new username to use for authentificating against the remote OpenGroupware server.

getUsername

public java.lang.String getUsername()

Returns the current username used for authentificating against the OpenGroupware server.

Returns:

The username used for authentification.

setPassword

public void setPassword(java.lang.String passwd)

Sets the new password used for authentification against the remote OpenGroupware server.

Parameters:

passwd - The password used for authentification.