eu.europeana.uim.sugarcrmclient.internal.helpers

Class ClientUtils

java.lang.Object

eu.europeana.uim.sugarcrmclient.internal.helpers.ClientUtils

public class ClientUtils
extends Object

This Class provides auxiliary methods that can be used for the creation & instantiation of SugarWSClient instances (see provided Junit tests for usage examples).

Author:

Georgios Markakis

Method Summary

Modifier and Type	Method and Description
static Login	createStandardLoginObject(String username, String passwrd) Creates a Login Soap Request given the user credentials.
static String	extractFromElement(String value, Element el) Auxiliary method for extracting information from DOM objects embedded in SOAP responses
static String	extractSimpleResponse(String responseString)
static NameValueList	generatePopulatedNameValueList(List<NameValue> namevalues) Creates a NameValueList Soap Element given a List namevalues object which sets the fields to be retrieved.
static SelectFields	generatePopulatedSelectFields(List<String> fieldnames) Creates a SelectFields Soap Object given a List fieldnames object which sets the fields to be retrieved.
static void	logMarshalledObject(Object jibxObject) This method marshals the contents of a JAXB Element and outputs the results to the Logger.
static void	logMarshalledObjectOsgi(PrintStream out, Object jibxObject) This method marshals the contents of a JAXB Element and outputs the results to the Karaf output console.
static Map<String,String>	mapFromElement(Element el) Returns a Map containing SUgarCRM identifiers
static String	md5(String value) Encrypts a given String into a MD5 format.
static HashMap<String,HashMap<String,String>>	responseFactory(String responseString)
static String	translateDsStatusDescription(String description) Translates the description of a Dataset status to its stored value.
static String	translateStatus(String sugarcrmStatusStr) Translates the status code returned by SugarCRM into a human readable form.
static String	translateType(String provtype) Translates the status code returned by SugarCRM into a human readable form.

Methods inherited from class java.lang.Object

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

Method Detail

logMarshalledObject

public static void logMarshalledObject(Object jibxObject)

This method marshals the contents of a JAXB Element and outputs the results to the Logger.

Parameters:

jaxbObject - A JIBX representation of a SugarCRM SOAP Element.

logMarshalledObjectOsgi

public static void logMarshalledObjectOsgi(PrintStream out,
                                           Object jibxObject)

This method marshals the contents of a JAXB Element and outputs the results to the Karaf output console.

Parameters:

out - the (Karaf console) printwriter

jibxObject -

md5

public static String md5(String value)

Encrypts a given String into a MD5 format.

Parameters:

value - The string to be encrypted

Returns:

the encrypted String

createStandardLoginObject

public static Login createStandardLoginObject(String username,
                                              String passwrd)

Creates a Login Soap Request given the user credentials.

Parameters:

username -

passwrd -

Returns:

a Login Soap Request Jaxb representation

generatePopulatedSelectFields

public static SelectFields generatePopulatedSelectFields(List<String> fieldnames)

Creates a SelectFields Soap Object given a List fieldnames object which sets the fields to be retrieved.

Parameters:

fieldnames -

Returns:

generatePopulatedNameValueList

public static NameValueList generatePopulatedNameValueList(List<NameValue> namevalues)

Creates a NameValueList Soap Element given a List namevalues object which sets the fields to be retrieved.

Parameters:

fieldnames -

Returns:

responseFactory

public static HashMap<String,HashMap<String,String>> responseFactory(String responseString)
                                                              throws ParserConfigurationException,
                                                                     SAXException,
                                                                     IOException,
                                                                     XPathExpressionException

Parameters:

responseString -

Returns:

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

extractSimpleResponse

public static String extractSimpleResponse(String responseString)

Parameters:

responseString -

Returns:

extractFromElement

public static String extractFromElement(String value,
                                        Element el)

Auxiliary method for extracting information from DOM objects embedded in SOAP responses

Parameters:

value - The value to be extracted

el - the DOM element

Returns:

the value

mapFromElement

public static Map<String,String> mapFromElement(Element el)

Returns a Map containing SUgarCRM identifiers

Parameters:

el -

Returns:

the populated map

translateStatus

public static String translateStatus(String sugarcrmStatusStr)

Translates the status code returned by SugarCRM into a human readable form.

Parameters:

sugarcrmStatusStr -

Returns:

translateDsStatusDescription

public static String translateDsStatusDescription(String description)

Translates the description of a Dataset status to its stored value.

Parameters:

description -

Returns:

translateType

public static String translateType(String provtype)

Translates the status code returned by SugarCRM into a human readable form.

Parameters:

sugarcrmStatusStr -

Returns: