NewServerWizard.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.studio.ldapservers.wizards;


import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.directory.studio.common.core.jobs.StudioProgressMonitor;
import org.apache.directory.studio.ldapservers.LdapServerAdapterExtensionsManager;
import org.apache.directory.studio.ldapservers.LdapServersManager;
import org.apache.directory.studio.ldapservers.model.LdapServer;
import org.apache.directory.studio.ldapservers.model.LdapServerAdapterConfigurationPage;
import org.apache.directory.studio.ldapservers.model.LdapServerAdapterExtension;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.ui.INewWizard;
import org.eclipse.ui.IWorkbench;


/**
 * This class implements the new server wizard.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class NewServerWizard extends Wizard implements INewWizard
{
    /** The wizard page */
    private NewServerWizardSelectionPage adapterSelectionPage;

    private Map<String, NewServerWizardConfigurationPage> configurationPages = new HashMap<String, NewServerWizardConfigurationPage>();


    /**
     * {@inheritDoc}
     */
    public void addPages()
    {
        adapterSelectionPage = new NewServerWizardSelectionPage();
        addPage( adapterSelectionPage );

        List<LdapServerAdapterExtension> ldapServerAdapterExtensions = LdapServerAdapterExtensionsManager.getDefault()
            .getLdapServerAdapterExtensions();
        for ( LdapServerAdapterExtension ldapServerAdapterExtension : ldapServerAdapterExtensions )
        {
            String configurationPageClassName = ldapServerAdapterExtension.getConfigurationPageClassName();
            if ( ( configurationPageClassName != null ) && ( !"".equals( configurationPageClassName ) ) ) //$NON-NLS-1$
            {
                try
                {
                    LdapServerAdapterConfigurationPage configurationPage = ldapServerAdapterExtension
                        .getNewConfigurationPageInstance();
                    NewServerWizardConfigurationPage configurationWizardPage = new NewServerWizardConfigurationPage(
                        configurationPage );
                    configurationPages.put( ldapServerAdapterExtension.getId(), configurationWizardPage );
                    addPage( configurationWizardPage );
                }
                catch ( Exception e )
                {
                    e.printStackTrace();
                }
            }
        }
    }


    /**
     * {@inheritDoc}
     */
    public boolean performFinish()
    {
        // Getting server name and adapter extension
        final String serverName = adapterSelectionPage.getServerName();
        final LdapServerAdapterExtension adapterExtension = adapterSelectionPage.getLdapServerAdapterExtension();

        // Getting the configuration page (in any
        NewServerWizardConfigurationPage configurationPage = getConfigurationPage();

        // Creating the new server
        final LdapServer server = new LdapServer();
        server.setName( serverName );
        server.setLdapServerAdapterExtension( adapterExtension );

        // Saving the configuration page (is any)
        if ( configurationPage != null )
        {
            configurationPage.saveConfiguration( server );
        }

        try
        {
            getContainer().run( true, false, new IRunnableWithProgress()
            {
                public void run( IProgressMonitor monitor )
                {
                    // Creating a StudioProgressMonitor
                    StudioProgressMonitor spm = new StudioProgressMonitor( monitor );

                    // Setting the title
                    spm.beginTask( Messages.getString( "NewServerWizard.CreatingLdapServer" ), IProgressMonitor.UNKNOWN ); //$NON-NLS-1$
                    spm.subTask( Messages.getString( "NewServerWizard.CreatingServerFolder" ) ); //$NON-NLS-1$

                    // Adding the new server to the servers handler
                    LdapServersManager.getDefault().addServer( server );

                    // Creating the folder for the new server
                    LdapServersManager.createNewServerFolder( server );

                    try
                    {
                        // Letting the LDAP Server Adapter finish the creation of the server
                        adapterExtension.getInstance().add( server, spm );
                    }
                    catch ( Exception e )
                    {
                        // Reporting the error to the progress monitor
                        spm.reportError( e );
                    }

                    // Reporting to the monitors that we're done
                    spm.done();
                }
            } );
        }
        catch ( Exception e )
        {
            // Will never occur
        }

        return true;
    }


    /**
     * {@inheritDoc}
     */
    public void init( IWorkbench workbench, IStructuredSelection selection )
    {
        setWindowTitle( Messages.getString( "NewServerWizard.NewLdapServer" ) ); //$NON-NLS-1$
        setNeedsProgressMonitor( true );
    }


    /**
     * {@inheritDoc}
     */
    public IWizardPage getNextPage( IWizardPage page )
    {
        IWizardPage configurationPage = getConfigurationPage();

        if ( adapterSelectionPage.equals( page ) )
        {
            return configurationPage;
        }

        return null;
    }


    /**
     * {@inheritDoc}
     */
    public boolean canFinish()
    {
        if ( adapterSelectionPage.isPageComplete() )
        {
            IWizardPage configurationPage = getConfigurationPage();

            if ( configurationPage != null )
            {
                return configurationPage.isPageComplete();
            }
            else
            {
                return true;
            }
        }

        return false;
    }


    /**
     * Gets the configuration page corresponding to the currently
     * selected LDAP Server Adapter Extension.
     *
     * @return the configuration page corresponding to the currently
     * selected LDAP Server Adapter Extension.
     */
    private NewServerWizardConfigurationPage getConfigurationPage()
    {
        LdapServerAdapterExtension ldapServerAdapterExtension = adapterSelectionPage
            .getLdapServerAdapterExtension();

        if ( ldapServerAdapterExtension != null )
        {
            String configurationPageClassName = ldapServerAdapterExtension.getConfigurationPageClassName();

            if ( ( configurationPageClassName != null ) && ( !"".equals( configurationPageClassName ) ) ) //$NON-NLS-1$
            {
                return configurationPages.get( ldapServerAdapterExtension.getId() );
            }
        }

        return null;
    }
}