/*
 * Copyright 2007 EDL FOUNDATION
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they
 * will be approved by the European Commission - subsequent
 * versions of the EUPL (the "Licence");
 * you may not use this work except in compliance with the
 * Licence.
 * You may obtain a copy of the Licence at:
 *
 * http://ec.europa.eu/idabc/eupl
 *
 * Unless required by applicable law or agreed to in
 * writing, software distributed under the Licence is
 * distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
package eu.europeana.uim.sugarcrmclient.ws;

import org.springframework.ws.client.core.WebServiceTemplate;

import eu.europeana.uim.sugarcrmclient.jibxbindings.IsUserAdmin;
import eu.europeana.uim.sugarcrmclient.jibxbindings.IsUserAdminResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetEntryList;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetEntryListResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetEntry;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetEntryResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetEntries;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetEntriesResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.SetEntry;
import eu.europeana.uim.sugarcrmclient.jibxbindings.SetEntryResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.Logout;
import eu.europeana.uim.sugarcrmclient.jibxbindings.LogoutResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetModuleFields;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetModuleFieldsResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetAvailableModules;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetAvailableModulesResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetUserId;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetUserIdResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.Login;
import eu.europeana.uim.sugarcrmclient.jibxbindings.LoginResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.SetNoteAttachment;
import eu.europeana.uim.sugarcrmclient.jibxbindings.SetNoteAttachmentResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetNoteAttachment;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetNoteAttachmentResponse;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetRelationships;
import eu.europeana.uim.sugarcrmclient.jibxbindings.GetRelationshipsResponse;
import eu.europeana.uim.sugarcrmclient.ws.exceptions.*;

/**
 * The core class for performing SOAP based sugarCRM operations
 * 
 * @author Georgios Markakis
 */
public class SugarWsClientImpl implements SugarWsClient {

	private WebServiceTemplate webServiceTemplate;

	private String username;

	private String password;

	private String sessionID;

	/**
	 * Default Constructor
	 */
	public SugarWsClientImpl(){
	}

	/**
	 * Used for unit/integration tests
	 * @param username
	 * @param password
	 */
	public SugarWsClientImpl(String username,String password){
		this.username = username;
		this.password = password;
	}

	/**
	 * Generic auxiliary method for marshalling and unmarshalling requests and
	 * responses via Spring-WS
	 * 
	 * @param <T>
	 *            Class of the request Object
	 * @param <S>
	 *            Class of the response object
	 * @param wsOperation
	 *            the instance of the request operation
	 * @return the unmarshalled response object
	 */
	private <T, S> S invokeWSTemplate(T wsOperation, Class<S> responseClass) {

		@SuppressWarnings("unchecked")
		S wsResponse = (S) webServiceTemplate.marshalSendAndReceive(wsOperation);

		return wsResponse;
	}

	/**
	 * Public method for performing Login operations (see Junit test for usage
	 * example)
	 * 
	 * @param login
	 *            the Login object
	 * @return a String containing the current Session id
	 * @throws JIXBLoginFailureException
	 *             when login credentials are incorrect
	 * @throws GenericSugarCrmException
	 */
	@Override
	public String login(Login login) throws JIXBLoginFailureException {

		LoginResponse response = invokeWSTemplate(login, LoginResponse.class);
		String sessionID = response.getReturn().getId();
		this.sessionID = sessionID;

		if ("-1".equals(sessionID)) {
			throw new JIXBLoginFailureException(response.getReturn().getError());
		}
		return sessionID;
	}

	/**
	 * Public method for performing Login operations (see JUnit test for usage
	 * example)
	 * 
	 * @param login
	 * @return a LoginResponse object
	 * @throws JIXBLoginFailureException
	 *             when login credentials are incorrect
	 * @throws GenericSugarCrmException
	 */
	@Override
	public LoginResponse login2(Login login) throws JIXBLoginFailureException {

		LoginResponse response = invokeWSTemplate(login, LoginResponse.class);

		if ("-1".equals(response.getReturn().getId())) {
			throw new JIXBLoginFailureException(response.getReturn().getError());
		}
		return response;

	}

	/**
	 * Public method for performing Logout operations (see Junit test for usage
	 * example)
	 * 
	 * @param a logout request object
	 * @return a LogoutResponse object
	 * @throws JIXBLogoutFailureException
	 *             when logout fails
	 * @throws GenericSugarCrmException
	 */
	@Override
	public LogoutResponse logout(Logout request)
			throws JIXBLogoutFailureException {

		LogoutResponse response = invokeWSTemplate(request,
				LogoutResponse.class);

		String returnvalue = response.getReturn().getNumber();

		if (!"0".equals(returnvalue)) {

			throw new JIXBLogoutFailureException(response.getReturn()
					.getDescription());
		}
		return response;
	}

	/**
	 * This method returns an object indicating that the current user has admin
	 * privileges or not.
	 * 
	 * @param request
	 * @return
	 * @throws GenericSugarCrmException
	 */
	@Override
	public IsUserAdminResponse isUserAdmin(IsUserAdmin request)
			throws Exception {

		try {
			IsUserAdminResponse response = invokeWSTemplate(request,
					IsUserAdminResponse.class);

			return response;
		} catch (Exception e) {
			throw new Exception();
		}
	}

	/**
	 * This method gives the user name of the user who "owns" the specific
	 * session
	 * 
	 * @param request
	 * @return
	 * @throws GenericSugarCrmException
	 */
	@Override
	public GetUserIdResponse getUserId(GetUserId request)
			throws Exception {

		try {
			GetUserIdResponse response = invokeWSTemplate(request,
					GetUserIdResponse.class);

			return response;
		} catch (Exception e) {
			throw new Exception();
		}
	}

	/**
	 * Shows all the available module names in SugarCRM
	 * 
	 * @param request
	 * @return
	 * @throws JIXBQueryResultException
	 * @throws GenericSugarCrmException
	 */
	@Override
	public GetAvailableModulesResponse getAvailableModules(
			GetAvailableModules request) throws JIXBQueryResultException {

		GetAvailableModulesResponse response = invokeWSTemplate(request,
				GetAvailableModulesResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBQueryResultException(response.getReturn().getError());
		}
		return response;
	}

	/**
	 * Get the fields for a specific module
	 * 
	 * @param request
	 * @return a GetModuleFieldsResponse containing a list of module fields
	 * @throws JIXBQueryResultException
	 */
	@Override
	public GetModuleFieldsResponse getModuleFields(GetModuleFields request)
			throws JIXBQueryResultException {

		GetModuleFieldsResponse response = invokeWSTemplate(request,
				GetModuleFieldsResponse.class);
		/*
		 * if(!"0".equals(response.getReturn().getError().getNumber())){ throw
		 * new JIXBQueryResultException(response.getReturn().getError()); }
		 */
		return response;
	}

	/**
	 * Performs a query on the records contained in sugarCRM
	 * 
	 * @param request
	 * @return
	 * @throws JIXBQueryResultException
	 */
	@Override
	public GetEntryListResponse getEntryList(GetEntryList request)
			throws JIXBQueryResultException {

		GetEntryListResponse response = invokeWSTemplate(request,
				GetEntryListResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBQueryResultException(response.getReturn().getError());
		}

		return response;
	}

	/**
	 * Gets a specific entry
	 * 
	 * @param request
	 * @return
	 * @throws JIXBQueryResultException
	 */
	@Override
	public GetEntryResponse getEntry(GetEntry request)
			throws JIXBQueryResultException {

		GetEntryResponse response = invokeWSTemplate(request,
				GetEntryResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBQueryResultException(response.getReturn().getError());
		}

		return response;
	}

	/**
	 * Creates/Updates an entry in SugarCRM
	 * 
	 * @param request
	 * @return
	 * @throws JIXBQueryResultException
	 */
	@Override
	public SetEntryResponse setEntry(SetEntry request)
			throws JIXBQueryResultException {

		SetEntryResponse response = invokeWSTemplate(request,
				SetEntryResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBQueryResultException(response.getReturn().getError());
		}

		return response;
	}

	/**
	 * Gets the entries for a request
	 * 
	 * @param request
	 * @return
	 * @throws JIXBQueryResultException
	 */
	@Override
	public GetEntriesResponse getEntries(GetEntries request)
			throws JIXBQueryResultException {

		GetEntriesResponse response = invokeWSTemplate(request,
				GetEntriesResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBQueryResultException(response.getReturn().getError());
		}

		return response;
	}

	/**
	 * Sets a note attachment to a record
	 * 
	 * @param request
	 * @return
	 */
	@Override
	public SetNoteAttachmentResponse setNoteAttachment(SetNoteAttachment request)
			throws JIXBFileAttachmentException {

		SetNoteAttachmentResponse response = invokeWSTemplate(request,
				SetNoteAttachmentResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBFileAttachmentException(response.getReturn()
					.getError());
		}

		return response;
	}

	/**
	 * Gets a note attachment from a record
	 * 
	 * @param request
	 * @return
	 */
	@Override
	public GetNoteAttachmentResponse getNoteAttachment(GetNoteAttachment request)
			throws JIXBFileAttachmentException {

		GetNoteAttachmentResponse response = invokeWSTemplate(request,
				GetNoteAttachmentResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBFileAttachmentException(response.getReturn()
					.getError());
		}

		return response;
	}

	/**
	 * Gets the Relationships for a specific module
	 * 
	 * @param request
	 * @return
	 * @throws JIXBQueryResultException
	 */
	@Override
	public GetRelationshipsResponse getRelationships(GetRelationships request)
			throws JIXBQueryResultException {

		GetRelationshipsResponse response = invokeWSTemplate(request,
				GetRelationshipsResponse.class);

		if (!"0".equals(response.getReturn().getError().getNumber())) {
			throw new JIXBQueryResultException(response.getReturn().getError());
		}
		return response;
	}

	/**
	 * @return
	 */
	@Override
	public String getSessionID() {
		return sessionID;
	}

	@Override
	public String getUsername() {
		return username;
	}

	@Override
	public void setUsername(String username) {
		this.username = username;
	}

	@Override
	public String getPassword() {
		return password;
	}

	@Override
	public void setPassword(String password) {
		this.password = password;
	}

	/* Getters & Setters */

	/**
	 * @return
	 */
	public WebServiceTemplate getWebServiceTemplate() {
		return this.webServiceTemplate;
	}

	/**
	 * @param webServiceTemplate
	 */
	public void setWebServiceTemplate(WebServiceTemplate webServiceTemplate) {
		this.webServiceTemplate = webServiceTemplate;
	}

	/**
	 * @param defaultUri
	 */
	public void setDefaultUri(String defaultUri) {

		webServiceTemplate.setDefaultUri(defaultUri);
	}

	/**
	 * @return
	 */
	public String getDefaultUri() {
		return webServiceTemplate.getDefaultUri();
	}

	@Override
	public void setSessionID(String sessionID) {
		this.sessionID = sessionID;
	}
}