From 4379b98a9c52ef5ef42ab1664a391e029c9a26f5 Mon Sep 17 00:00:00 2001 From: David Dykstal Date: Mon, 18 Jun 2007 20:55:57 +0000 Subject: [PATCH] [159581] added guide sections for connector services, hosts, services, and subsystems --- .../guide/rse_int_connectorservices.html | 16 +++++++++++- .../guide/rse_int_hosts.html | 14 ++++++++++- .../guide/rse_int_services.html | 20 ++++++++++++++- .../guide/rse_int_subsystems.html | 25 +++++++++++++++++-- .../guide/rse_int_ui.html | 16 ------------ .../org.eclipse.rse.doc.isv/topics_Guide.xml | 1 - 6 files changed, 70 insertions(+), 22 deletions(-) delete mode 100755 rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_ui.html diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_connectorservices.html b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_connectorservices.html index 0e908d1f82d..8dfb4872c60 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_connectorservices.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_connectorservices.html @@ -1,7 +1,7 @@ - + @@ -10,6 +10,20 @@

RSE Connector Services

+

+Connector Services provide the mechanism for maintaining a connection to a particular remote system, requesting whatever credentials are +required for authentication, and for controlling the persistence of those credentials. A connector service is typically created +or referenced by a subsystem configuration when a new subsystem instance is being created. +

+Every subsystem has a connector service. Some subsystems will share a connector service among themselves. +Subsystems that share a connector service all connect and disconnect at the same time. +For example, a file subsystem and +a shell subsystem that are both using the SSH protocol will share the same connector service instance so that their connections are established and +removed at the same time. +

+Connector services use credentials providers (see ICredentialsProvider) to establish any credentials needed for authentication to a +remote system. +

diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_hosts.html b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_hosts.html index 309efcbe56e..70940c1d272 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_hosts.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_hosts.html @@ -1,7 +1,7 @@ - + @@ -10,6 +10,18 @@

RSE Hosts

+

+Hosts, sometimes called "connections", are visible as the top level entities shown in the Remote Systems view. +Hosts are always created referencing a system type. +The system type determines the kinds of services that will be available to that host. +System types are defined by the org.eclipse.rse.core.systemTypes extension point, which lists the subsystemConfigurations +that are valid for type. +

+Once instantiated, hosts can be connected to their target systems. +This causes the connector services associated with +the subsystems belonging to that host to request connection. +Disconnect works similarly. +

diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_services.html b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_services.html index 451a1056d76..a92a0f6d262 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_services.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_services.html @@ -1,7 +1,7 @@ - + @@ -10,6 +10,24 @@

RSE Services

+

+RSE is built on top of a service layer that provides services that access the remote systems. +These service implementations are typically protocol-specific but will obey an interface that defined for that paricular service. +For example, a file service will obey the interface defined in the package +org.eclipse.rse.services.files, but there +exist implementations for the dstore, FTP, and SSH protocols. +

+

+RSE supplies service definitions for a file service, a shell service for submitting remote commands, a search service, and a process service. +Implementers that which to use different protocols than the ones supplied should use the existing service definitions to fit into the current +structure. +

+

+It is not absolutely necessary to have a services layer. +Implementers of subsystems that provide access to resources that in narrow domains +could forgo the creation of explicit service classes and embed the +support directly in the subsystem. +

diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_subsystems.html b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_subsystems.html index f4799a5399b..1336d32a95c 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_subsystems.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_subsystems.html @@ -1,7 +1,7 @@ - + @@ -10,6 +10,27 @@

RSE Subsystems

+

+Subsystems provide a layer of abstraction on the set of services provided at lower layers. +Subsystems make remote resources individually visible to their clients and expose the relationships among these resources - such as the parent-child +relationship between directories and files on a remote file system. +

+

+There should typically be only one subsystem implementation for each type of remote resource. +Minor differences between remote systems or +the protocols required to access them should be provided by different +implementations of an underlying service. +For example, RSE provides a single +exemplary file subsystem, but that file subsystem uses different file services to use different remote file access protocols. +The duty of tieing a subsystem to its underlying service goes to the subsystem configuration. +

+

+A subsystem configuration creates subsystems of the kind it understands and, in addition, create them with the appropriate +underlying service if there is one. These configuration classes are registered with RSE using the +org.eclipse.rse.core.subsystemConfigurations extension point. +

+

+RSE supplies ready-made subsystems for files, command execution, and processes. +

- diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_ui.html b/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_ui.html deleted file mode 100755 index 33bba22aa5c..00000000000 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/rse_int_ui.html +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - -RSE UI - - - - -

RSE UI

- - \ No newline at end of file diff --git a/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml b/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml index 43c1fd31473..bcc95d699d1 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml +++ b/rse/doc/org.eclipse.rse.doc.isv/topics_Guide.xml @@ -12,7 +12,6 @@ -