Package org.eclipse.remote.core

Interface IRemoteConnectionType

  • public interface IRemoteConnectionType
    A remote connection type manages a list of connections that implement the same services. Services may be registered on the individual connections, or at the connection type level for service that apply to all connections of this type.
    Since:
    2.0

    • Method Detail

      • getRemoteServicesManager

        IRemoteServicesManager getRemoteServicesManager()
        Get the remote services manager. This is a convenient way to get back to the root.
        Returns:
        remote services manager

      • getId

        java.lang.String getId()
        Get unique ID of this service. Can be used as a lookup key.
        Returns:
        unique ID

      • getName

        java.lang.String getName()
        Get display name of this service.
        Returns:
        display name

      • getScheme

        java.lang.String getScheme()
        Get the EFS scheme provided by this service.
        Returns:
        display name

      • canAdd

        boolean canAdd()
        Can you add new connections of this type using the API.
        Returns:
        can add

      • canEdit

        boolean canEdit()
        Can you edit connections of this type, i.e. create working copies.
        Returns:
        can edit

      • canRemove

        boolean canRemove()
        Can you remove connections of this type using the API.
        Returns:
        can remove

      • getService

        <T extends IRemoteConnectionType.Service> T getService​(java.lang.Class<T> service)
        Get the service for this remote services implementation that implements the given interface.
        Parameters:
        service - the interface the required service must implements
        Returns:
        the desired service or null if there is no such service available
        Throws:
        org.eclipse.core.runtime.CoreException
        Since:
        2.0

      • hasService

        <T extends IRemoteConnectionType.Service> boolean hasService​(java.lang.Class<T> service)
        Does this connection type support the given service.
        Parameters:
        service - the service to be tested
        Returns:
        true if this connection type supports this service

      • getServices

        java.util.List<java.lang.String> getServices()
        Return the list of connection type services supported by this type.
        Returns:
        connection type services

      • hasConnectionService

        <T extends IRemoteConnection.Service> boolean hasConnectionService​(java.lang.Class<T> service)
        Do connections created by this connection type support the given service.
        Parameters:
        service - the service to be tested
        Returns:
        true if connections created by this connection type support this service

      • getConnectionServices

        java.util.List<java.lang.String> getConnectionServices()
        Return the list of connection services supported by connections of this type.
        Returns:
        connection services

      • hasProcessService

        <T extends IRemoteProcess.Service> boolean hasProcessService​(java.lang.Class<T> service)
        Do processes created by this connection type support the given service.
        Parameters:
        service - the service to be tested
        Returns:
        true if processes created by this connection type support this service

      • getProcessServices

        java.util.List<java.lang.String> getProcessServices()
        Return the list of process services supported by connections of this type.
        Returns:
        process services

      • getConnection

        IRemoteConnection getConnection​(java.lang.String name)
        Gets the remote connection corresponding to the supplied name.
        Parameters:
        name - name of the connection (as returned by IRemoteConnection.getName())
        Returns:
        remote connection or null if no connection exists

      • getConnection

        IRemoteConnection getConnection​(java.net.URI uri)
        Gets the remote connection corresponding to the supplied URI.
        Parameters:
        uri - URI containing a schema for this remote connection
        Returns:
        remote connection or null if no connection exists or the schema is incorrect
        Since:
        4.0

      • getConnections

        java.util.List<IRemoteConnection> getConnections()
        Get all the connections for this service provider.
        Returns:
        connections that we know about

      • newConnection

        IRemoteConnectionWorkingCopy newConnection​(java.lang.String name)
                                    throws RemoteConnectionException
        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.
        Parameters:
        name - name of the connection
        Returns:
        a new connection working copy with the supplied name
        Throws:
        RemoteConnectionException - if connection creation failed
        Since:
        5.0