org.lsc.connectors.xmlrpc

Class AbstractLscXmlRpcObject

java.lang.Object

org.lsc.connectors.xmlrpc.AbstractLscXmlRpcObject

Direct Known Subclasses:

AbstractLscXmlRpcClient

public abstract class AbstractLscXmlRpcObject
extends Object

This methods contains all the required method to handle encoding and decoding of values inside the XmlRpc protocol

Author:

Sebastien Bahloul <seb@lsc-project.org>

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHENTICATION_ERROR
static int	BAD_PROTOCOL_VERSION
static int	BAD_SERVICE_NAME
static String	LSC_XMLRPC_PROTOCOL_VERSION
static String	LSC_XMLRPC_SERVICE_NAME
static int	RESULT_SUCCESS
static int	UNHANDLED_ERROR

Constructor Summary

Constructors

Constructor and Description
AbstractLscXmlRpcObject()

Method Summary

Modifier and Type	Method and Description
boolean	decodeBooleanResult(Object[] result) Parse the response to get a boolean result
List<Object>	decodeObjectListResult(Object[] result) Parse the response to get the parameters as an objects list
List<String>	decodeStringListResult(Object[] result) Parse the response to get the parameters as a String list
Object	encodeAttributeValue(Attribute attribute)
Object	encodeMap(List<Attribute> attributes)
Object[]	encodeRequest(Object... parameters)
List<Object>	encodeResult(int code, Object... parameters) Encode a list of parameters starting with the result code, followed by the protocol version and ending by the parameters as an embedded array
String	getErrorMessage() Error message accessor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LSC_XMLRPC_PROTOCOL_VERSION

public static final String LSC_XMLRPC_PROTOCOL_VERSION

See Also:

Constant Field Values

LSC_XMLRPC_SERVICE_NAME

public static final String LSC_XMLRPC_SERVICE_NAME

See Also:

Constant Field Values

RESULT_SUCCESS

public static int RESULT_SUCCESS

AUTHENTICATION_ERROR

public static int AUTHENTICATION_ERROR

UNHANDLED_ERROR

public static int UNHANDLED_ERROR

BAD_SERVICE_NAME

public static int BAD_SERVICE_NAME

BAD_PROTOCOL_VERSION

public static int BAD_PROTOCOL_VERSION

Constructor Detail

AbstractLscXmlRpcObject

public AbstractLscXmlRpcObject()

Method Detail

encodeResult

public List<Object> encodeResult(int code,
                                 Object... parameters)

Encode a list of parameters starting with the result code, followed by the protocol version and ending by the parameters as an embedded array

Parameters:

code - the result code

parameters - the parameters to embed

Returns:

the object list to return through XmlRpc

getErrorMessage

public String getErrorMessage()

Error message accessor

Returns:

the error message

decodeStringListResult

public List<String> decodeStringListResult(Object[] result)

Parse the response to get the parameters as a String list

Parameters:

result - the response

Returns:

the string list or null if something goes wrong !

decodeObjectListResult

public List<Object> decodeObjectListResult(Object[] result)

Parse the response to get the parameters as an objects list

Parameters:

result - the response

Returns:

the objects list or null if something goes wrong !

decodeBooleanResult

public boolean decodeBooleanResult(Object[] result)

Parse the response to get a boolean result

Parameters:

result - the request

Returns:

the boolean result

encodeRequest

public Object[] encodeRequest(Object... parameters)

encodeMap

public Object encodeMap(List<Attribute> attributes)

encodeAttributeValue

public Object encodeAttributeValue(Attribute attribute)