eu.europeana.uim.sugarcrmclient.ws

Class SugarWsClientImpl

java.lang.Object

eu.europeana.uim.sugarcrmclient.ws.SugarWsClientImpl

All Implemented Interfaces:

SugarWsClient

public class SugarWsClientImpl
extends Object
implements SugarWsClient

The core class for performing SOAP based sugarCRM operations

Author:

Georgios Markakis

Constructor Summary

Constructors

Constructor and Description
SugarWsClientImpl() Default Constructor
SugarWsClientImpl(String username, String password) Used for unit/integration tests

Method Summary

Methods

Modifier and Type	Method and Description
GetAvailableModulesResponse	getAvailableModules(GetAvailableModules request) Shows all the available module names in SugarCRM
String	getDefaultUri()
GetEntriesResponse	getEntries(GetEntries request) Gets the entries for a request
GetEntryResponse	getEntry(GetEntry request) Gets a specific entry
GetEntryListResponse	getEntryList(GetEntryList request) Performs a query on the records contained in sugarCRM
GetModuleFieldsResponse	getModuleFields(GetModuleFields request) Get the fields for a specific module
GetNoteAttachmentResponse	getNoteAttachment(GetNoteAttachment request) Gets a note attachment from a record
String	getPassword()
GetRelationshipsResponse	getRelationships(GetRelationships request) Gets the Relationships for a specific module
String	getSessionID() Get the current session id
GetUserIdResponse	getUserId(GetUserId request) This method gives the user name of the user who "owns" the specific session
String	getUsername()
org.springframework.ws.client.core.WebServiceTemplate	getWebServiceTemplate()
IsUserAdminResponse	isUserAdmin(IsUserAdmin request) This method returns an object indicating that the current user has admin privileges or not.
String	login(Login login) Public method for performing Login operations (see Junit test for usage example)
LoginResponse	login2(Login login) Public method for performing Login operations (see JUnit test for usage example)
LogoutResponse	logout(Logout request) Public method for performing Logout operations (see Junit test for usage example)
void	setDefaultUri(String defaultUri)
SetEntryResponse	setEntry(SetEntry request) Creates/Updates an entry in SugarCRM
SetNoteAttachmentResponse	setNoteAttachment(SetNoteAttachment request) Sets a note attachment to a record
void	setPassword(String password)
void	setSessionID(String sessionID) Set session id
void	setUsername(String username)
void	setWebServiceTemplate(org.springframework.ws.client.core.WebServiceTemplate webServiceTemplate)

Methods inherited from class java.lang.Object

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

Constructor Detail

SugarWsClientImpl

public SugarWsClientImpl()

Default Constructor

SugarWsClientImpl

public SugarWsClientImpl(String username,
                 String password)

Used for unit/integration tests

Parameters:

username -

password -

Method Detail

login

public String login(Login login)
             throws JIXBLoginFailureException

Public method for performing Login operations (see Junit test for usage example)

Specified by:

login in interface SugarWsClient

Parameters:

login - the Login object

Returns:

a String containing the current Session id

Throws:

JIXBLoginFailureException - when login credentials are incorrect

GenericSugarCrmException

login2

public LoginResponse login2(Login login)
                     throws JIXBLoginFailureException

Public method for performing Login operations (see JUnit test for usage example)

Specified by:

login2 in interface SugarWsClient

Parameters:

login -

Returns:

a LoginResponse object

Throws:

JIXBLoginFailureException - when login credentials are incorrect

GenericSugarCrmException

logout

public LogoutResponse logout(Logout request)
                      throws JIXBLogoutFailureException

Public method for performing Logout operations (see Junit test for usage example)

Specified by:

logout in interface SugarWsClient

Parameters:

a - logout request object

Returns:

a LogoutResponse object

Throws:

JIXBLogoutFailureException - when logout fails

GenericSugarCrmException

isUserAdmin

public IsUserAdminResponse isUserAdmin(IsUserAdmin request)
                                throws Exception

This method returns an object indicating that the current user has admin privileges or not.

Specified by:

isUserAdmin in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

GenericSugarCrmException

Exception

getUserId

public GetUserIdResponse getUserId(GetUserId request)
                            throws Exception

This method gives the user name of the user who "owns" the specific session

Specified by:

getUserId in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

GenericSugarCrmException

Exception

getAvailableModules

public GetAvailableModulesResponse getAvailableModules(GetAvailableModules request)
                                                throws JIXBQueryResultException

Shows all the available module names in SugarCRM

Specified by:

getAvailableModules in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

GenericSugarCrmException

getModuleFields

public GetModuleFieldsResponse getModuleFields(GetModuleFields request)
                                        throws JIXBQueryResultException

Get the fields for a specific module

Specified by:

getModuleFields in interface SugarWsClient

Parameters:

request -

Returns:

a GetModuleFieldsResponse containing a list of module fields

Throws:

JIXBQueryResultException

getEntryList

public GetEntryListResponse getEntryList(GetEntryList request)
                                  throws JIXBQueryResultException

Performs a query on the records contained in sugarCRM

Specified by:

getEntryList in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

getEntry

public GetEntryResponse getEntry(GetEntry request)
                          throws JIXBQueryResultException

Gets a specific entry

Specified by:

getEntry in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

setEntry

public SetEntryResponse setEntry(SetEntry request)
                          throws JIXBQueryResultException

Creates/Updates an entry in SugarCRM

Specified by:

setEntry in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

getEntries

public GetEntriesResponse getEntries(GetEntries request)
                              throws JIXBQueryResultException

Gets the entries for a request

Specified by:

getEntries in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

setNoteAttachment

public SetNoteAttachmentResponse setNoteAttachment(SetNoteAttachment request)
                                            throws JIXBFileAttachmentException

Sets a note attachment to a record

Specified by:

setNoteAttachment in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBFileAttachmentException

getNoteAttachment

public GetNoteAttachmentResponse getNoteAttachment(GetNoteAttachment request)
                                            throws JIXBFileAttachmentException

Gets a note attachment from a record

Specified by:

getNoteAttachment in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBFileAttachmentException

getRelationships

public GetRelationshipsResponse getRelationships(GetRelationships request)
                                          throws JIXBQueryResultException

Gets the Relationships for a specific module

Specified by:

getRelationships in interface SugarWsClient

Parameters:

request -

Returns:

Throws:

JIXBQueryResultException

getSessionID

public String getSessionID()

Description copied from interface: SugarWsClient

Get the current session id

Specified by:

getSessionID in interface SugarWsClient

Returns:

getUsername

public String getUsername()

Specified by:

getUsername in interface SugarWsClient

Returns:

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface SugarWsClient

getPassword

public String getPassword()

Specified by:

getPassword in interface SugarWsClient

Returns:

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface SugarWsClient

getWebServiceTemplate

public org.springframework.ws.client.core.WebServiceTemplate getWebServiceTemplate()

Returns:

setWebServiceTemplate

public void setWebServiceTemplate(org.springframework.ws.client.core.WebServiceTemplate webServiceTemplate)

Parameters:

webServiceTemplate -

setDefaultUri

public void setDefaultUri(String defaultUri)

Parameters:

defaultUri -

getDefaultUri

public String getDefaultUri()

Returns:

setSessionID

public void setSessionID(String sessionID)

Description copied from interface: SugarWsClient

Set session id

Specified by:

setSessionID in interface SugarWsClient