// ============================================================================
//
// Copyright (C) 2006-2016 Talend Inc. - www.talend.com
//
// This source code is available under agreement available at
// %InstallDIR%\features\org.talend.rcp.branding.%PRODUCTNAME%\%PRODUCTNAME%license.txt
//
// You should have received a copy of the agreement
// along with this program; if not, write to Talend SA
// 9 rue Pages 92150 Suresnes, France
//
// ============================================================================
package org.talend.dq.helper;

import org.apache.log4j.Logger;
import org.eclipse.core.commands.Command;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.commands.ICommandService;
import org.eclipse.ui.services.IServiceLocator;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;
import org.talend.cwm.management.i18n.Messages;
import org.talend.dq.CWMPlugin;

/**
 * created by yyin on 2015年1月12日 Detailled comment.
 *
 */
public abstract class AbstractOSGIServiceUtils {

    private static Logger log = Logger.getLogger(AbstractOSGIServiceUtils.class);

    private boolean hasShowDownloadWizard = false;

    public static final String COMMAND_ID = "org.talend.updates.show.wizard.command"; //$NON-NLS-1$

    /**
     * get the plugin name
     * 
     * @return
     */
    public abstract String getPluginName();

    /**
     * get the related service interface name
     * 
     * @return
     */
    public abstract String getServiceName();

    /**
     * check if the service installed or not
     * 
     * @return
     */
    public abstract boolean isServiceInstalled();

    protected void initService(boolean isNeedDownload) {
        BundleContext context = CWMPlugin.getDefault().getBundleContext();
        if (context == null) {
            return;
        }

        ServiceReference serviceReference = context.getServiceReference(getServiceName());
        if (serviceReference != null) {
            setService(context, serviceReference);
        } else if (isNeedDownload) {
            if (!hasShowDownloadWizard) {
                // show download jar dialog
                IServiceLocator serviceLocator = PlatformUI.getWorkbench();
                ICommandService commandService = (ICommandService) serviceLocator.getService(ICommandService.class);
                try {
                    Command command = commandService.getCommand(COMMAND_ID);
                    command.executeWithChecks(new ExecutionEvent());
                    hasShowDownloadWizard = true;
                } catch (Exception e) {
                    log.error(e);
                }
            } else {
                log.error(Messages.getString(getMissingMessageName()));
            }
        }
    }

    /**
     * getMissingMessageName.
     * 
     * @return
     */
    protected abstract String getMissingMessageName();

    /**
     * getRestartMessageName.
     * 
     * @return
     */
    protected abstract String getRestartMessageName();

    /**
     * DOC yyin Comment method "setService".
     * 
     * @param context
     * @param serviceReference
     */
    abstract protected void setService(BundleContext context, ServiceReference serviceReference);
}