# HG changeset patch
# User dadubrow
# Date 1242765181 18000
# Node ID 88b7eb94b003e6ff4d9c5d4a593f71b1028e60d9
# Parent  b25acbfc406ae417c50050df84c46c43c790f49b
[Bug 9085] Add new TCP/IP connection type with port mappings and new service interface to optionally provide defaults.

diff -r b25acbfc406a -r 88b7eb94b003 connectivity/com.nokia.carbide.remoteConnections.tests/src/com/nokia/carbide/remoteconnections/tests/TCPIPConnectionTypeTests.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/connectivity/com.nokia.carbide.remoteConnections.tests/src/com/nokia/carbide/remoteconnections/tests/TCPIPConnectionTypeTests.java	Tue May 19 15:33:01 2009 -0500
@@ -0,0 +1,53 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*
+*/
+
+package com.nokia.carbide.remoteconnections.tests;
+
+import com.nokia.carbide.remoteconnections.RemoteConnectionsActivator;
+import com.nokia.carbide.remoteconnections.interfaces.*;
+import com.nokia.carbide.remoteconnections.tests.extensions.DefaultProvidingTCPIPService;
+import com.nokia.carbide.remoteconnections.tests.extensions.TestFilter;
+import com.nokia.carbide.trk.support.connection.TCPIPConnectionType;
+
+import java.util.Map;
+
+import junit.framework.TestCase;
+
+@SuppressWarnings("restriction")
+public class TCPIPConnectionTypeTests extends TestCase {
+
+	private static IConnectionType connectionType;
+
+	protected void setUp() throws Exception {
+		TestFilter.isTest = true;
+		IConnectionTypeProvider connectionTypeProvider = RemoteConnectionsActivator.getConnectionTypeProvider();
+		if (connectionType == null)
+			connectionType = connectionTypeProvider.getConnectionType(TCPIPConnectionType.ID);
+	}
+
+	protected void tearDown() throws Exception {
+	}
+
+	public void testTCPIPDefaultMappings() throws Exception {
+		Map<String, String> settings = connectionType.getConnectionFactory().getSettingsFromUI();
+		IConnection connection = connectionType.getConnectionFactory().createConnection(settings);
+		RemoteConnectionsActivator.getConnectionsManager().addConnection(connection);
+		settings = connection.getSettings();
+		String defaultPort = settings.get(DefaultProvidingTCPIPService.ID);
+		assertEquals(DefaultProvidingTCPIPService.DEFAULT_PORT, defaultPort);
+	}
+}
diff -r b25acbfc406a -r 88b7eb94b003 connectivity/com.nokia.carbide.remoteConnections.tests/src/com/nokia/carbide/remoteconnections/tests/extensions/DefaultProvidingTCPIPService.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/connectivity/com.nokia.carbide.remoteConnections.tests/src/com/nokia/carbide/remoteconnections/tests/extensions/DefaultProvidingTCPIPService.java	Tue May 19 15:33:01 2009 -0500
@@ -0,0 +1,125 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*
+*/
+
+package com.nokia.carbide.remoteconnections.tests.extensions;
+
+import com.nokia.carbide.remoteconnections.interfaces.*;
+import com.nokia.carbide.trk.support.connection.TCPIPConnectionFactory;
+
+import org.osgi.framework.Version;
+
+import java.util.Collections;
+import java.util.Map;
+
+@SuppressWarnings("restriction")
+public class DefaultProvidingTCPIPService implements IService2 {
+
+	public static final String DEFAULT_PORT = "4144";
+	public static String ID = DefaultProvidingTCPIPService.class.getName();
+
+	public DefaultProvidingTCPIPService() {
+	}
+
+	public String getAdditionalServiceInfo() {
+		return "No testing available for this service";
+	}
+
+	public String getDisplayName() {
+		return "Default Providing Service";
+	}
+
+	public String getIdentifier() {
+		return ID;
+	}
+
+	public IRemoteAgentInstallerProvider getInstallerProvider() {
+		return null;
+	}
+
+	public boolean isTestable() {
+		return false;
+	}
+
+	public Map<String, String> getDefaults() {
+		return Collections.singletonMap(TCPIPConnectionFactory.IP_PORT, DEFAULT_PORT);
+	}
+
+	public IConnectedService createInstance(IConnection connection) {
+		final IConnectedService[] connectedService = { null }; 
+		IConnectedService cs = new IConnectedService() {
+			private boolean enabled;
+
+			public void addStatusChangedListener(IStatusChangedListener listener) {
+			}
+
+			public void dispose() {
+			}
+
+			public IService getService() {
+				return DefaultProvidingTCPIPService.this;
+			}
+
+			public IStatus getStatus() {
+				return new IStatus() {
+					public IConnectedService getConnectedService() {
+						return connectedService[0];
+					}
+
+					public EStatus getEStatus() {
+						return EStatus.UNKNOWN;
+					}
+
+					public String getLongDescription() {
+						return "This is for testing only";
+					}
+
+					public String getShortDescription() {
+						return "Unknown status";
+					}
+				};
+			}
+
+			public boolean isEnabled() {
+				return enabled;
+			}
+
+			public void removeStatusChangedListener(IStatusChangedListener listener) {
+			}
+
+			public void setDeviceOS(String familyName, Version version) {
+			}
+
+			public void setEnabled(boolean enabled) {
+				this.enabled = enabled;
+			}
+
+			public void testStatus() {
+			}
+		};
+
+		connectedService[0] = cs;
+		return cs;
+	}
+
+	public boolean wantsDeviceOS() {
+		return false;
+	}
+
+	public Object getAdapter(Class adapter) {
+		return null;
+	}
+}
diff -r b25acbfc406a -r 88b7eb94b003 connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/interfaces/IService2.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/interfaces/IService2.java	Tue May 19 15:33:01 2009 -0500
@@ -0,0 +1,41 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*
+*/
+
+package com.nokia.carbide.remoteconnections.interfaces;
+
+import org.eclipse.core.runtime.IAdaptable;
+
+import java.util.Map;
+
+/**
+ * An extended interface for remote connections services 
+ */
+public interface IService2 extends IService, IAdaptable {
+
+	/**
+	 * Return whether this service uses the Device OS setting in the connection edit page
+	 * @return boolean
+	 */
+	boolean wantsDeviceOS();
+	
+	/**
+	 * Return a map of service specific default settings
+	 * @return Map 
+	 */
+	Map<String, String> getDefaults();
+
+}
diff -r b25acbfc406a -r 88b7eb94b003 debuggercdi/com.nokia.carbide.trk.support/src/com/nokia/carbide/trk/support/connection/TCPIPPortMappingConnection.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/debuggercdi/com.nokia.carbide.trk.support/src/com/nokia/carbide/trk/support/connection/TCPIPPortMappingConnection.java	Tue May 19 15:33:01 2009 -0500
@@ -0,0 +1,31 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*
+*/
+
+package com.nokia.carbide.trk.support.connection;
+
+import com.nokia.carbide.remoteconnections.interfaces.IConnectionType;
+
+import java.util.Map;
+
+public class TCPIPPortMappingConnection extends TCPIPConnection {
+
+	public TCPIPPortMappingConnection(IConnectionType connectionType, Map<String, String> settings) {
+		super(connectionType, settings);
+	}
+
+	
+}
diff -r b25acbfc406a -r 88b7eb94b003 debuggercdi/com.nokia.carbide.trk.support/src/com/nokia/carbide/trk/support/connection/TCPIPPortMappingConnectionFactory.java
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/debuggercdi/com.nokia.carbide.trk.support/src/com/nokia/carbide/trk/support/connection/TCPIPPortMappingConnectionFactory.java	Tue May 19 15:33:01 2009 -0500
@@ -0,0 +1,230 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*
+*/
+
+package com.nokia.carbide.trk.support.connection;
+
+import com.nokia.carbide.remoteconnections.RemoteConnectionsActivator;
+import com.nokia.carbide.remoteconnections.interfaces.*;
+
+import org.eclipse.jface.layout.GridDataFactory;
+import org.eclipse.jface.viewers.*;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.graphics.Image;
+import org.eclipse.swt.widgets.*;
+
+import java.util.*;
+import java.util.List;
+
+public class TCPIPPortMappingConnectionFactory extends TCPIPConnectionFactory {
+
+	private final class PortColumnEditingSupport extends EditingSupport {
+		private TextCellEditor editor;
+
+		private PortColumnEditingSupport(ColumnViewer viewer) {
+			super(viewer);
+			editor = new TextCellEditor((Composite) viewer.getControl(), SWT.NONE);
+		}
+
+		@Override
+		protected boolean canEdit(Object element) {
+			return true;
+		}
+
+		@Override
+		protected CellEditor getCellEditor(Object element) {
+			return editor;
+		}
+
+		@Override
+		protected Object getValue(Object element) {
+			return serviceIdToPortMappings.get(element.toString()).toString();
+		}
+
+		@Override
+		protected void setValue(Object element, Object value) {
+			Integer integer = getValidValue((String) value);
+			if (integer != null) {
+				serviceIdToPortMappings.put(element.toString(), integer);
+				viewer.refresh(true);
+				packColumns();
+			}
+		}
+
+	}
+
+	private final class TableLabelProvider implements ITableLabelProvider {
+		public Image getColumnImage(Object element, int columnIndex) {
+			return null;
+		}
+
+		public String getColumnText(Object element, int columnIndex) {
+			String serviceId = element.toString();
+			if (columnIndex == SERVICE_COLUMN) {
+				IService service = 
+					RemoteConnectionsActivator.getConnectionTypeProvider().findServiceByID(serviceId);
+				return service.getDisplayName();
+			}
+			else if (columnIndex == PORT_COLUMN) {
+				return String.valueOf(serviceIdToPortMappings.get(serviceId).intValue());
+			}
+			return null;
+		}
+
+		public void addListener(ILabelProviderListener listener) {
+		}
+
+		public void dispose() {
+		}
+
+		public boolean isLabelProperty(Object element, String property) {
+			return false;
+		}
+
+		public void removeListener(ILabelProviderListener listener) {
+		}
+	}
+
+	private static final int MIN_DYN_PORT_NUM = 49152;
+	private static final int MAX_DYN_PORT_NUM = 65535;
+	private static final int SERVICE_COLUMN = 0;
+	private static final int PORT_COLUMN = 1;
+	private Map<String, Integer> serviceIdToPortMappings;
+	private TableViewer viewer;
+	
+	public TCPIPPortMappingConnectionFactory(IConnectionType connectionType) {
+		super(connectionType);
+		serviceIdToPortMappings = new HashMap<String, Integer>();
+		initializePortMappings();
+	}
+
+	private void initializePortMappings() {
+		Collection<IService> services = RemoteConnectionsActivator.getConnectionTypeProvider().getCompatibleServices(connectionType);
+		for (IService service : services) {
+			IService2 service2 = service instanceof IService2 ? (IService2) service : null;
+			Integer defaultPort = null;
+			if (service2 != null) {
+				try {
+					String defaultPortString = service2.getDefaults().get(IP_PORT);
+					defaultPort = Integer.valueOf(defaultPortString);
+				} catch (NumberFormatException e) {
+					// if it doesn't parse as an int, we ignore it and provide a dynamic default
+				}
+			}
+			if (defaultPort != null)
+				serviceIdToPortMappings.put(service.getIdentifier(), defaultPort);
+		}
+		for (IService service : services) {
+			String identifier = service.getIdentifier();
+			if (!serviceIdToPortMappings.containsKey(identifier))
+				serviceIdToPortMappings.put(identifier, getUnusedDynamicDefault());
+		}
+		
+	}
+
+	private Integer getUnusedDynamicDefault() {
+		for (Integer val = MIN_DYN_PORT_NUM; val < MAX_DYN_PORT_NUM; val++) {
+			if (!serviceIdToPortMappings.containsValue(val))
+				return val;
+		}
+		return -1; // should never get here!!!
+	}
+
+	@Override
+	public IConnection createConnection(Map<String, String> settings) {
+		if (settings == null)
+			settings = getSettingsFromUI();
+		return new TCPIPPortMappingConnection(connectionType, settings);
+	}
+
+	@Override
+	public void createEditingUI(Composite parent, IValidationErrorReporter errorReporter, Map<String, String> initialSettings) {
+		super.createEditingUI(parent, errorReporter, initialSettings);
+		updatePortMappings(initialSettings);
+		Label label = new Label(composite, SWT.NONE);
+		GridDataFactory.defaultsFor(label).span(2, 1).applyTo(label);
+		label.setText("Service to port mappings");
+	
+		viewer = new TableViewer(composite, SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER | SWT.FULL_SELECTION);
+		viewer.setContentProvider(new ArrayContentProvider());
+		
+		TableViewerColumn serviceColumn = new TableViewerColumn(viewer, SWT.LEFT);
+		serviceColumn.getColumn().setText("Service");
+		
+		TableViewerColumn portColumn = new TableViewerColumn(viewer, SWT.RIGHT);
+		portColumn.getColumn().setText("Port");
+		portColumn.setEditingSupport(new PortColumnEditingSupport(viewer));
+		
+		viewer.setLabelProvider(new TableLabelProvider());
+		viewer.setInput(serviceIdToPortMappings.keySet());
+		
+		Table table = viewer.getTable();
+		table.setHeaderVisible(true);
+		GridDataFactory.defaultsFor(table).span(2, 1).hint(SWT.DEFAULT, 60).grab(true, false).applyTo(table);
+		table.setToolTipText("Service to port mappings for this connection. Port settings are user editable");
+		table.setData(UID, "TCPIPPortMappingConnectionFactory.table"); //$NON-NLS-1$
+		table.setData("viewer", viewer);
+		packColumns();
+	}
+
+	private Integer getValidValue(String value) {
+		try {
+			int intVal = Integer.parseInt(value);
+			if (intVal < 0)
+				return new Integer(0);
+			else if (intVal > MAX_DYN_PORT_NUM)
+				return new Integer(MAX_DYN_PORT_NUM);
+			else
+				return new Integer(intVal);
+		} catch (Exception e) {
+		}
+		return null;
+	}
+
+	private void updatePortMappings(Map<String, String> initialSettings) {
+		if (initialSettings != null) {
+			List<String> serviceIds = new ArrayList<String>(serviceIdToPortMappings.keySet());
+			for (String serviceId : serviceIds) {
+				String value = initialSettings.get(serviceId);
+				Integer validValue = getValidValue(value);
+				if (validValue != null)
+					serviceIdToPortMappings.put(serviceId, validValue);
+			}
+		}
+		
+	}
+
+	@Override
+	public Map<String, String> getSettingsFromUI() {
+		Map<String, String> settings = super.getSettingsFromUI();
+		addMappings(settings);
+		return settings;
+	}
+
+	private void addMappings(Map<String, String> settings) {
+		for (String serviceId : serviceIdToPortMappings.keySet()) {
+			settings.put(serviceId, String.valueOf(serviceIdToPortMappings.get(serviceId).intValue()));
+		}
+		settings.remove(IP_PORT);
+	}
+
+	private void packColumns() {
+		TableColumn[] columns = viewer.getTable().getColumns();
+		for (TableColumn tableColumn : columns) {
+			tableColumn.pack();
+		}
+	}
+}