ConnectToRemoteHandler.java

/*
 * Copyright (C) 2012 The Android Open Source Project
 *
 * Licensed 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 com.motorola.studio.android.remote.handlers;

import java.io.IOException;
import java.util.Map;
import java.util.Properties;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.sequoyah.device.framework.events.InstanceEvent;
import org.eclipse.sequoyah.device.framework.events.InstanceEvent.InstanceEventType;
import org.eclipse.sequoyah.device.framework.events.InstanceEventManager;
import org.eclipse.sequoyah.device.framework.model.IInstance;
import org.eclipse.sequoyah.device.framework.model.handler.IServiceHandler;
import org.eclipse.sequoyah.device.framework.model.handler.ServiceHandler;

import com.motorola.studio.android.adt.DDMSFacade;
import com.motorola.studio.android.adt.ISerialNumbered;
import com.motorola.studio.android.common.log.StudioLogger;
import com.motorola.studio.android.remote.RemoteDeviceConstants;
import com.motorola.studio.android.remote.RemoteDevicePlugin;
import com.motorola.studio.android.remote.i18n.RemoteDeviceNLS;
import com.motorola.studio.android.remote.instance.RemoteDeviceInstance;

/**
 * Service handler responsible for connecting to a remote device
 */
public class ConnectToRemoteHandler extends ServiceHandler
{

    /*
     * (non-Javadoc)
     * @see org.eclipse.sequoyah.device.framework.model.handler.ServiceHandler#newInstance()
     */
    @Override
    public IServiceHandler newInstance()
    {
        return new ConnectToRemoteHandler();
    }

    /*
     * (non-Javadoc)
     * @see org.eclipse.sequoyah.device.framework.model.handler.ServiceHandler#runService(org.eclipse.sequoyah.device.framework.model.IInstance, java.util.Map, org.eclipse.core.runtime.IProgressMonitor)
     */
    @Override
    public IStatus runService(IInstance instance, Map<Object, Object> arguments,
            IProgressMonitor monitor)
    {

        StudioLogger
                .debug("TmL Connect to Remote Device Service: start connecting to remote device: "
                        + instance);

        if (arguments != null)
        {
            if (((Boolean) arguments.get(RemoteDeviceConstants.DUMMY_TRANSITION)).booleanValue())
            {
                StudioLogger.debug("TmL Connect to Remote Device Service: dummy transition");
                setSuffix(instance);
                return Status.OK_STATUS;
            }
        }

        IStatus status = Status.OK_STATUS;

        /*
         * Call ADB connect
         */
        Properties prop = instance.getProperties();
        String host = prop.getProperty(RemoteDeviceInstance.PROPERTY_HOST);
        String port = prop.getProperty(RemoteDeviceInstance.PROPERTY_PORT);
        String timeout = prop.getProperty(RemoteDeviceInstance.PROPERTY_TIMEOUT);

        try
        {
            status =
                    DDMSFacade.connectTcpIp((ISerialNumbered) instance, host, port,
                            Integer.parseInt(timeout), monitor);
        }
        catch (IOException e)
        {
            return new Status(IStatus.ERROR, RemoteDevicePlugin.PLUGIN_ID,
                    RemoteDeviceNLS.ERR_ConnectToRemote_AdbStart);
        }

        /* ------------------------------------------------------------ */

        if (status.getSeverity() == IStatus.OK)
        {
            setSuffix(instance);
        }
        else
        {
            instance.setNameSuffix(null);
            InstanceEventManager.getInstance().notifyListeners(
                    new InstanceEvent(InstanceEventType.INSTANCE_UPDATED, instance));
        }

        StudioLogger
                .debug("TmL Connect to Remote Device Service: finish connecting to remote device. status: "
                        + status.getSeverity());

        return status;
    }

    /*
     * (non-Javadoc)
     * @see org.eclipse.sequoyah.device.framework.model.handler.ServiceHandler#updatingService(org.eclipse.sequoyah.device.framework.model.IInstance, org.eclipse.core.runtime.IProgressMonitor)
     */
    @Override
    public IStatus updatingService(IInstance instance, IProgressMonitor monitor)
    {
        return Status.OK_STATUS;
    }

    /*
     * Set the instance suffix (its serial number)
     * 
     * @param instance the instance to which the suffix will be added
     */
    private void setSuffix(IInstance instance)
    {

        if (instance != null)
        {
            StudioLogger.debug("TmL Connect to Remote Device Service: setting suffix to instance "
                    + instance.getName());

            String suffix = ((ISerialNumbered) instance).getSerialNumber();
            if (!instance.getName().equals(suffix))
            {
                instance.setNameSuffix(suffix);
                InstanceEventManager.getInstance().notifyListeners(
                        new InstanceEvent(InstanceEventType.INSTANCE_UPDATED, instance));
            }
        }
    }
}