RemoteConnectionType

java.lang.Object
- org.eclipse.remote.internal.core.RemoteConnectionType

All Implemented Interfaces:

IRemoteConnectionType
```
public class RemoteConnectionType
extends java.lang.Object
implements IRemoteConnectionType
```
The implementation for a given remote services collection.n

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.remote.core.IRemoteConnectionType
  IRemoteConnectionType.Service

Constructor Summary

Constructors
Constructor and Description

RemoteConnectionType(org.eclipse.core.runtime.IConfigurationElement ce, RemoteServicesManager manager)

Constructors
Constructor and Description
`RemoteConnectionType(org.eclipse.core.runtime.IConfigurationElement ce, RemoteServicesManager manager)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addService(org.eclipse.core.runtime.IConfigurationElement ce)` Called from the remote service manager to register a service extension for this remote services implementation
`boolean`	`canAdd()` Can you add new connections of this type using the API.
`boolean`	`canEdit()` Can you edit connections of this type, i.e.
`boolean`	`canRemove()` Can you remove connections of this type using the API.
`protected void`	`connectionAdded(IRemoteConnection connection)` Signal connection has been added.
`protected void`	`connectionRemoved(IRemoteConnection connection)` Signal a connnection is about to be removed.
`IRemoteConnection`	`getConnection(java.lang.String name)` Gets the remote connection corresponding to the supplied name.
`IRemoteConnection`	`getConnection(java.net.URI uri)` Gets the remote connection corresponding to the supplied URI.
`java.util.List<IRemoteConnection>`	`getConnections()` Get all the connections for this service provider.
`<T extends IRemoteConnection.Service> T`	`getConnectionService(IRemoteConnection connection, java.lang.Class<T> service)` Called from the connection to get a service object for that connection.
`java.util.List<java.lang.String>`	`getConnectionServices()` Return the list of connection services supported by connections of this type.
`java.lang.String`	`getId()` Get unique ID of this service.
`java.lang.String`	`getName()` Get display name of this service.
`<T extends IRemoteProcess.Service> T`	`getProcessService(IRemoteProcess process, java.lang.Class<T> service)` Called from the remote process to get a service object for that process.
`java.util.List<java.lang.String>`	`getProcessServices()` Return the list of process services supported by connections of this type.
`IRemoteServicesManager`	`getRemoteServicesManager()` Get the remote services manager.
`java.lang.String`	`getScheme()` Get the EFS scheme provided by this service.
`<T extends IRemoteConnectionType.Service> T`	`getService(java.lang.Class<T> service)` Get the service for this remote services implementation that implements the given interface.
`java.util.List<java.lang.String>`	`getServices()` Return the list of connection type services supported by this type.
`<T extends IRemoteConnection.Service> boolean`	`hasConnectionService(java.lang.Class<T> service)` Do connections created by this connection type support the given service.
`<T extends IRemoteProcess.Service> boolean`	`hasProcessService(java.lang.Class<T> service)` Do processes created by this connection type support the given service.
`<T extends IRemoteConnectionType.Service> boolean`	`hasService(java.lang.Class<T> service)` Does this connection type support the given service.
`IRemoteConnectionWorkingCopy`	`newConnection(java.lang.String name)` Creates a new remote connection named with supplied name.
`void`	`removeConnection(IRemoteConnection connection)` Remove a connection and all resources associated with it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RemoteConnectionType
```
public RemoteConnectionType(org.eclipse.core.runtime.IConfigurationElement ce,
                    RemoteServicesManager manager)
```
- Method Detail
  - getRemoteServicesManager
```
public IRemoteServicesManager getRemoteServicesManager()
```
    Description copied from interface: IRemoteConnectionType
    
    Get the remote services manager. This is a convenient way to get back to the root.
    
    Specified by:
    
    getRemoteServicesManager in interface IRemoteConnectionType
    
    Returns:
    remote services manager
  - getId
```
public java.lang.String getId()
```
    Description copied from interface: IRemoteConnectionType
    
    Get unique ID of this service. Can be used as a lookup key.
    
    Specified by:
    
    getId in interface IRemoteConnectionType
    
    Returns:
    unique ID
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: IRemoteConnectionType
    
    Get display name of this service.
    
    Specified by:
    
    getName in interface IRemoteConnectionType
    
    Returns:
    display name
  - getScheme
```
public java.lang.String getScheme()
```
    Description copied from interface: IRemoteConnectionType
    
    Get the EFS scheme provided by this service.
    
    Specified by:
    
    getScheme in interface IRemoteConnectionType
    
    Returns:
    display name
  - canAdd
```
public boolean canAdd()
```
    Description copied from interface: IRemoteConnectionType
    
    Can you add new connections of this type using the API.
    
    Specified by:
    
    canAdd in interface IRemoteConnectionType
    
    Returns:
    can add
  - canEdit
```
public boolean canEdit()
```
    Description copied from interface: IRemoteConnectionType
    
    Can you edit connections of this type, i.e. create working copies.
    
    Specified by:
    
    canEdit in interface IRemoteConnectionType
    
    Returns:
    can edit
  - canRemove
```
public boolean canRemove()
```
    Description copied from interface: IRemoteConnectionType
    
    Can you remove connections of this type using the API.
    
    Specified by:
    
    canRemove in interface IRemoteConnectionType
    
    Returns:
    can remove
  - getService
```
public <T extends IRemoteConnectionType.Service> T getService(java.lang.Class<T> service)
```
    Description copied from interface: IRemoteConnectionType
    
    Get the service for this remote services implementation that implements the given interface.
    
    Specified by:
    
    getService in interface IRemoteConnectionType
    
    Parameters:
    service - the interface the required service must implements
    
    Returns:
    the desired service or null if there is no such service available
  - getServices
```
public java.util.List<java.lang.String> getServices()
```
    Description copied from interface: IRemoteConnectionType
    
    Return the list of connection type services supported by this type.
    
    Specified by:
    
    getServices in interface IRemoteConnectionType
    
    Returns:
    connection type services
  - hasService
```
public <T extends IRemoteConnectionType.Service> boolean hasService(java.lang.Class<T> service)
```
    Description copied from interface: IRemoteConnectionType
    
    Does this connection type support the given service.
    
    Specified by:
    
    hasService in interface IRemoteConnectionType
    
    Parameters:
    service - the service to be tested
    
    Returns:
    true if this connection type supports this service
  - getConnectionService
```
public <T extends IRemoteConnection.Service> T getConnectionService(IRemoteConnection connection,
                                                           java.lang.Class<T> service)
```
    Called from the connection to get a service object for that connection.
    
    Parameters:
    connection - the connection to which the service applies
    service - the interface the service must implement
    
    Returns:
    the service object
    
    Throws:
    
    org.eclipse.core.runtime.CoreException
  - getConnectionServices
```
public java.util.List<java.lang.String> getConnectionServices()
```
    Description copied from interface: IRemoteConnectionType
    
    Return the list of connection services supported by connections of this type.
    
    Specified by:
    
    getConnectionServices in interface IRemoteConnectionType
    
    Returns:
    connection services
  - hasConnectionService
```
public <T extends IRemoteConnection.Service> boolean hasConnectionService(java.lang.Class<T> service)
```
    Description copied from interface: IRemoteConnectionType
    
    Do connections created by this connection type support the given service.
    
    Specified by:
    
    hasConnectionService in interface IRemoteConnectionType
    
    Parameters:
    service - the service to be tested
    
    Returns:
    true if connections created by this connection type support this service
  - getProcessService
```
public <T extends IRemoteProcess.Service> T getProcessService(IRemoteProcess process,
                                                     java.lang.Class<T> service)
```
    Called from the remote process to get a service object for that process.
    
    Parameters:
    process - the process to which the service applies
    service - the interface the service must implement
    
    Returns:
    the service object
    
    Throws:
    
    org.eclipse.core.runtime.CoreException
  - getProcessServices
```
public java.util.List<java.lang.String> getProcessServices()
```
    Description copied from interface: IRemoteConnectionType
    
    Return the list of process services supported by connections of this type.
    
    Specified by:
    
    getProcessServices in interface IRemoteConnectionType
    
    Returns:
    process services
  - hasProcessService
```
public <T extends IRemoteProcess.Service> boolean hasProcessService(java.lang.Class<T> service)
```
    Description copied from interface: IRemoteConnectionType
    
    Do processes created by this connection type support the given service.
    
    Specified by:
    
    hasProcessService in interface IRemoteConnectionType
    
    Parameters:
    service - the service to be tested
    
    Returns:
    true if processes created by this connection type support this service
  - addService
```
public void addService(org.eclipse.core.runtime.IConfigurationElement ce)
```
    Called from the remote service manager to register a service extension for this remote services implementation
    
    Parameters:
    ce - the extension element defining the service
  - connectionAdded
```
protected void connectionAdded(IRemoteConnection connection)
```
    Signal connection has been added.
    
    Since:
    
    2.0
  - connectionRemoved
```
protected void connectionRemoved(IRemoteConnection connection)
```
    Signal a connnection is about to be removed.
    
    Since:
    
    2.0
  - getConnection
```
public IRemoteConnection getConnection(java.lang.String name)
```
    Description copied from interface: IRemoteConnectionType
    
    Gets the remote connection corresponding to the supplied name.
    
    Specified by:
    
    getConnection in interface IRemoteConnectionType
    
    Parameters:
    name - name of the connection (as returned by IRemoteConnection.getName())
    
    Returns:
    remote connection or null if no connection exists
  - getConnection
```
public IRemoteConnection getConnection(java.net.URI uri)
```
    Description copied from interface: IRemoteConnectionType
    
    Gets the remote connection corresponding to the supplied URI.
    
    Specified by:
    
    getConnection in interface IRemoteConnectionType
    
    Parameters:
    uri - URI containing a schema for this remote connection
    
    Returns:
    remote connection or null if no connection exists or the schema is incorrect
  - getConnections
```
public java.util.List<IRemoteConnection> getConnections()
```
    Description copied from interface: IRemoteConnectionType
    
    Get all the connections for this service provider.
    
    Specified by:
    
    getConnections in interface IRemoteConnectionType
    
    Returns:
    connections that we know about
  - newConnection
```
public IRemoteConnectionWorkingCopy newConnection(java.lang.String name)
                                           throws RemoteConnectionException
```
    Description copied from interface: IRemoteConnectionType
    
    Creates a new remote connection named with supplied name. The connection attributes will be the default for the implementation. Returns a working copy of the remote connection. Callers must call IRemoteConnectionWorkingCopy.save() before the connection can be used.
    
    Specified by:
    
    newConnection in interface IRemoteConnectionType
    
    Parameters:
    name - name of the connection
    
    Returns:
    a new connection working copy with the supplied name
    
    Throws:
    
    RemoteConnectionException - if connection creation failed
  - removeConnection
```
public void removeConnection(IRemoteConnection connection)
                      throws RemoteConnectionException
```
    Description copied from interface: IRemoteConnectionType
    
    Remove a connection and all resources associated with it.
    
    Specified by:
    
    removeConnection in interface IRemoteConnectionType
    
    Parameters:
    connection - connection to remove
    
    Throws:
    
    RemoteConnectionException - if the connection could not be removed

Class RemoteConnectionType

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.remote.core.IRemoteConnectionType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RemoteConnectionType

Method Detail

getRemoteServicesManager

getId

getName

getScheme

canAdd

canEdit

canRemove

getService

getServices

hasService

getConnectionService

getConnectionServices

hasConnectionService

getProcessService

getProcessServices

hasProcessService

addService

connectionAdded

connectionRemoved

getConnection

getConnection

getConnections

newConnection

removeConnection