plugins/connection.core/src/main/java/org/apache/directory/studio/connection/core/jobs/CheckNetworkParameterRunnable.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.connection.core.jobs;


import javax.net.ssl.SSLSession;

import org.apache.directory.studio.common.core.jobs.StudioProgressMonitor;
import org.apache.directory.studio.connection.core.Connection;
import org.apache.directory.studio.connection.core.Messages;


/**
 * Runnable to check if a connection to a directory server could be established
 * using the given connection parmeter.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class CheckNetworkParameterRunnable implements StudioConnectionRunnableWithProgress
{

    private Connection connection;
    private SSLSession sslSession;

    /**
     * Creates a new instance of CheckNetworkParameterJob.
     * 
     * @param connection the connection
     */
    public CheckNetworkParameterRunnable( Connection connection )
    {
        this.connection = connection;
    }


    /**
     * {@inheritDoc}
     */
    public Object[] getLockedObjects()
    {
        return new Object[]
            { connection };
    }


    /**
     * {@inheritDoc}
     */
    public String getName()
    {
        return Messages.jobs__check_network_name;
    }


    /**
     * {@inheritDoc}
     */
    public void run( StudioProgressMonitor monitor )
    {
        monitor.beginTask( Messages.jobs__check_network_task, 3 );
        monitor.reportProgress( " " ); //$NON-NLS-1$
        monitor.worked( 1 );

        connection.getConnectionWrapper().connect( monitor );
        this.sslSession = connection.getConnectionWrapper().getSslSession();
        connection.getConnectionWrapper().disconnect();
    }


    /**
     * {@inheritDoc}
     */
    public String getErrorMessage()
    {
        return Messages.jobs__check_network_error;
    }


    /**
     * {@inheritDoc}
     */
    public Connection[] getConnections()
    {
        return null;
    }


    public SSLSession getSslSession()
    {
        return sslSession;
    }
}