# HG changeset patch # User dadubrow # Date 1260980914 21600 # Node ID ae5ff180a61d26f5ec76cc4fb56ce51929287bb8 # Parent 593d05f9d5cacc168765bc96884e09ba5a914e76 Changes to remote connections add javadoc to IConnectionsManager + IConnectionTypeProvider deprecate internal methods and don't use them internally from interface add new interfaces and methods to support host PnP diff -r 593d05f9d5ca -r ae5ff180a61d connectivity/com.nokia.carbide.remoteConnections/schema/deviceDiscoveryAgent.exsd --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/connectivity/com.nokia.carbide.remoteConnections/schema/deviceDiscoveryAgent.exsd Wed Dec 16 10:28:34 2009 -0600 @@ -0,0 +1,102 @@ + + + + + + + + + [Enter description of this extension point.] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [Enter the first release in which this extension point appears.] + + + + + + + + + [Enter extension point usage example here.] + + + + + + + + + [Enter API information here.] + + + + + + + + + [Enter information about supplied implementation of this extension point.] + + + + + diff -r 593d05f9d5ca -r ae5ff180a61d connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/internal/IConnectedService2.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/internal/IConnectedService2.java Wed Dec 16 10:28:34 2009 -0600 @@ -0,0 +1,35 @@ +/** +* 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.internal; + +import java.util.Map; + +import com.nokia.carbide.remoteconnections.interfaces.IConnectedService; + +/** + * An extended interface to a connected service + * @since 3.0 + */ +public interface IConnectedService2 extends IConnectedService { + + /** + * Return the properties for this connected service + * @return Map + */ + Map getProperties(); +} diff -r 593d05f9d5ca -r ae5ff180a61d connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/internal/IConnection2.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/internal/IConnection2.java Wed Dec 16 10:28:34 2009 -0600 @@ -0,0 +1,103 @@ +/** +* 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.internal; + +import org.eclipse.jface.resource.ImageDescriptor; + +import com.nokia.carbide.remoteconnections.interfaces.IConnection; + +/** + * An extended interface to a connection + * @since 3.0 + */ +public interface IConnection2 extends IConnection { + + /** + * Whether this connection is dynamic (managed by an automated process) + * Dynamic connections are not persisted or user editable. + * @return boolean + */ + boolean isDynamic(); + + /** + * Sets this connection's dynamic attribute. + * @see IConnection2#isDynamic() + * @param dynamic boolean + */ + void setDynamic(boolean dynamic); + + /** + * The status of a connection + */ + public interface IStatus { + enum EStatus { + READY, NOT_READY, IN_USE, IN_USE_DISCONNECTED + }; + + EStatus getEStatus(); + + String getDescription(); + } + + /** + * Gets this connection's status + * @return IStatus + */ + IStatus getStatus(); + + /** + * Sets this connection's status + * @see IConnection2#getStatus() + * @param status IStatus + */ + void setStatus(IStatus status); + + /** + * A listener for status changes + */ + public interface IStatusChangedListener { + void statusChanged(IStatus status); + } + + /** + * Adds a listener for status changes + * @param listener IStatusChangedListener + */ + void addStatusChangedListener(IStatusChangedListener listener); + + /** + * Removes a listener for status changes + * @param listener IStatusChangedListener + */ + void removeStatusChangedListener(IStatusChangedListener listener); + + /** + * An optional icon representing this connection. + * If none is set, the default icon is used. + * @return ImageDescriptor + */ + ImageDescriptor getImageDescriptor(); + + /** + * Set the image descriptor for this connection. + * @see IConnection2#getImageDescriptor() + * @param imageDescriptor + */ + void setImageDescriptor(ImageDescriptor imageDescriptor); + +} diff -r 593d05f9d5ca -r ae5ff180a61d connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/internal/IDeviceDiscoveryAgent.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/internal/IDeviceDiscoveryAgent.java Wed Dec 16 10:28:34 2009 -0600 @@ -0,0 +1,55 @@ +/** +* 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.internal; + +import java.net.URL; + +import org.eclipse.core.runtime.CoreException; + +/** + * An interface to a device discovery agent + * @since 3.0 + */ +public interface IDeviceDiscoveryAgent { + + /** + * Starts agent. Once started, runs until stopped. + * @throws CoreException + */ + void start() throws CoreException; + + /** + * Stops agent. + * @throws CoreException + */ + void stop() throws CoreException; + + /** + * Returns a URL to specific information about this discovery mechanism, + * troubleshooting, etc. + * @return URL + */ + URL getInformation(); + + // In addition, there may need to be an additional API to do a deeper form of discovery for + // connection mechanisms that require pairing (like BT or Wifi). In these cases, normal discovery + // will probably be for already paired devices, however, the user will want to discover all + // potential devices from some UI in order to set up a paired device. + // A method for doing this will need to be added. + +}