From f1fab0110497d9d3a7adc2bfff2f9aaa5689328b Mon Sep 17 00:00:00 2001 From: Martin Oberhuber Date: Mon, 11 Jun 2007 11:01:36 +0000 Subject: [doc] Add tm.discovery.doc.isv contribution from Javier --- .../org.eclipse.tm.discovery.doc.isv/.cvsignore | 7 ++ .../org.eclipse.tm.discovery.doc.isv/.project | 11 ++ .../META-INF/MANIFEST.MF | 8 ++ .../org.eclipse.tm.discovery.doc.isv/book.css | 112 +++++++++++++++++++++ .../guide/device.html | 25 +++++ .../guide/images/discovery.png | Bin 0 -> 7681 bytes .../guide/images/discovery_model.gif | Bin 0 -> 7727 bytes .../guide/images/list.png | Bin 0 -> 13358 bytes .../guide/model.html | 27 +++++ .../guide/network.html | 17 ++++ .../guide/overview.html | 27 +++++ .../guide/pair.html | 27 +++++ .../guide/protocol.html | 26 +++++ .../guide/service.html | 23 +++++ .../guide/servicetype.html | 28 ++++++ .../guide/transport.html | 26 +++++ .../guide/usage.html | 46 +++++++++ .../guide/view.html | 37 +++++++ .../plugin.properties | 16 +++ .../org.eclipse.tm.discovery.doc.isv/plugin.xml | 9 ++ .../reference/.cvsignore | 1 + .../reference/extension-points/.cvsignore | 1 + .../org.eclipse.tm.discovery.doc.isv/schema.css | 66 ++++++++++++ discovery/org.eclipse.tm.discovery.doc.isv/toc.xml | 27 +++++ 24 files changed, 567 insertions(+) create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/.cvsignore create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/.project create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/META-INF/MANIFEST.MF create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/book.css create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/device.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery.png create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery_model.gif create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/images/list.png create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/model.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/network.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/overview.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/pair.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/protocol.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/service.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/servicetype.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/transport.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/usage.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/guide/view.html create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/plugin.properties create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/plugin.xml create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/reference/.cvsignore create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/reference/extension-points/.cvsignore create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/schema.css create mode 100644 discovery/org.eclipse.tm.discovery.doc.isv/toc.xml diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/.cvsignore b/discovery/org.eclipse.tm.discovery.doc.isv/.cvsignore new file mode 100644 index 000000000..0700bef2a --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/.cvsignore @@ -0,0 +1,7 @@ +bin +index +build.xml +javadoc.link.location +temp.bin.log +temp.convert.txt +temp.options.txt diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/.project b/discovery/org.eclipse.tm.discovery.doc.isv/.project new file mode 100644 index 000000000..4a0948038 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/.project @@ -0,0 +1,11 @@ + + + org.eclipse.tm.discovery.doc.isv + + + + + + + + diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/META-INF/MANIFEST.MF b/discovery/org.eclipse.tm.discovery.doc.isv/META-INF/MANIFEST.MF new file mode 100644 index 000000000..8b3cdaf02 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/META-INF/MANIFEST.MF @@ -0,0 +1,8 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %pluginName +Bundle-SymbolicName: org.eclipse.tm.discovery.doc.isv;singleton:=true +Bundle-Version: 2.0.0.qualifier +Bundle-Localization: plugin +Eclipse-LazyStart: false +Bundle-Vendor: %providerName diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/book.css b/discovery/org.eclipse.tm.discovery.doc.isv/book.css new file mode 100644 index 000000000..9f3214354 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/book.css @@ -0,0 +1,112 @@ +P.Code { + display: block; + text-align: left; + text-indent: 0.00pt; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 15pt; + font-size: 10.000000pt; + font-weight: normal; + font-style: normal; + color: #4444CC; + text-decoration: none; + vertical-align: baseline; + text-transform: none; + font-family: "Courier New", Courier, monospace; +} +H6.CaptionFigColumn { + display: block; + text-align: left; + text-indent: 0.000000pt; + margin-top: 3.000000pt; + margin-bottom: 11.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; + font-size: 9.000000pt; + font-weight: bold; + font-style: Italic; + color: #000000; + text-decoration: none; + vertical-align: baseline; + text-transform: none; +} +P.Note { + display: block; + text-align: left; + text-indent: 0pt; + margin-top: 19.500000pt; + margin-bottom: 19.500000pt; + margin-right: 0.000000pt; + margin-left: 30pt; + font-size: 11.000000pt; + font-weight: normal; + font-style: Italic; + color: #000000; + text-decoration: none; + vertical-align: baseline; + text-transform: none; +} +EM.UILabel { + font-weight: Bold; + font-style: normal; + text-decoration: none; + vertical-align: baseline; + text-transform: none; +} +EM.CodeName { + font-weight: Bold; + font-style: normal; + text-decoration: none; + vertical-align: baseline; + text-transform: none; + font-family: "Courier New", Courier, monospace; +} + +body, html { border: 0px } + + +/* following font face declarations need to be removed for DBCS */ + +body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, Helvetica, sans-serif; color: #000000} +pre { font-family: "Courier New", Courier, monospace;} + +/* end font face declarations */ + +/* following font size declarations should be OK for DBCS */ +body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 10pt; } +pre { font-size: 10pt} + +/* end font size declarations */ + +body { background: #FFFFFF; margin-bottom: 1em } +h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 } +h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 } +h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 } +h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic } +p { margin-top: 10px; margin-bottom: 10px } +pre { margin-left: 6; font-size: 9pt; color: #4444CC } +a:link { color: #0000FF } +a:hover { color: #000080 } +a:visited { text-decoration: underline } +ul { margin-top: 10px; margin-bottom: 10px; } +li { margin-top: 5px; margin-bottom: 5px; } +li p { margin-top: 5px; margin-bottom: 5px; } +ol { margin-top: 10px; margin-bottom: 10px; } +dl { margin-top: 10px; margin-bottom: 10px; } +dt { margin-top: 5px; margin-bottom: 5px; font-weight: bold; } +dd { margin-top: 5px; margin-bottom: 5px; } +strong { font-weight: bold} +em { font-style: italic} +var { font-style: italic} +div.revision { border-left-style: solid; border-left-width: thin; + border-left-color: #7B68EE; padding-left:5 } +th { font-weight: bold } + +a.command-link { +} +a.command-link img { + border-width: 0px; + border-style: none; + vertical-align: middle; +} diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/device.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/device.html new file mode 100644 index 000000000..973624781 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/device.html @@ -0,0 +1,25 @@ + + + + + + + +Device + + +

Device

+

+Device represents a machine with a unique address in the network.
+It can contain as well a name for easier identification. +A device contains a list of service types. +

+

+

Attributes

+ +

+ + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery.png b/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery.png new file mode 100644 index 000000000..030ddbe93 Binary files /dev/null and b/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery.png differ diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery_model.gif b/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery_model.gif new file mode 100644 index 000000000..a3e530651 Binary files /dev/null and b/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery_model.gif differ diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/list.png b/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/list.png new file mode 100644 index 000000000..e2012531c Binary files /dev/null and b/discovery/org.eclipse.tm.discovery.doc.isv/guide/images/list.png differ diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/model.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/model.html new file mode 100644 index 000000000..1b6f13847 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/model.html @@ -0,0 +1,27 @@ + + + + + + + +Model + + +

Model

+

+Service discovery stores the information in a EMF model as following: +

+ +

+

+ +
+

+

+The service discovery engine will fill this model using the provided protocol and transport implementations, and can be accessed after using the standard EMF methods. +

+ + + + diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/network.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/network.html new file mode 100644 index 000000000..4f8cfa960 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/network.html @@ -0,0 +1,17 @@ + + + + + + + +Network + + +

Network

+

+The Network is the top level or root of the discovered services model.
+It contains a list of devices +

+ + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/overview.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/overview.html new file mode 100644 index 000000000..e1983ee56 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/overview.html @@ -0,0 +1,27 @@ + + + + + + + +Overview + + +

Overview

+

+

+ +
+

+

+

+ +
+

+ + + + + + diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/pair.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/pair.html new file mode 100644 index 000000000..c4249b359 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/pair.html @@ -0,0 +1,27 @@ + + + + + + + +Pair + + +

Pair

+

+Each service can contain multiple pairs of keys and values to provide extra information about the service.
+

+

+Using service discovery with the Remote System Explorer requires a "tranport" key matching the transport specified in org.eclipse.rse.core.subsystemConfigurations. +

+ +

+

Attributes

+ +

+ + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/protocol.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/protocol.html new file mode 100644 index 000000000..d4ee7b4a7 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/protocol.html @@ -0,0 +1,26 @@ + + + + + + + +Protocol + + +

Protocol

+

+It specifies the protocol that will be used to interact with the remote devices.
+Protocols have to be specified as extensions of org.eclipse.tm.discovery.engine.discoveryProtocol.
+

+

+Examples of discovery protocols are: +

+

+ + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/service.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/service.html new file mode 100644 index 000000000..0d870ef74 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/service.html @@ -0,0 +1,23 @@ + + + + + + + +Service + + +

Service

+

+Service represents a discovered service available in the remote device grouped under a common service type.
+

+

+

Attributes

+ + +

+ + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/servicetype.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/servicetype.html new file mode 100644 index 000000000..4ae97d891 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/servicetype.html @@ -0,0 +1,28 @@ + + + + + + + +Service Type + + +

Service Type

+

+A service type represents a group of services of the same kind discovered in the parent device.
+Service type names should follow standard service names whenever possible. +

+ + +

+

Attributes

+ +

+ + + + + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/transport.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/transport.html new file mode 100644 index 000000000..ca9f91ebd --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/transport.html @@ -0,0 +1,26 @@ + + + + + + + +Transport + + +

Transport

+

+Transport defines how the remote devices are accessed to be queried for available services.
+Transports have to be specified as extensions of org.eclipse.tm.discovery.engine.discoveryTransport.
+

+

+Examples of transport are: +

+

+ + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/usage.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/usage.html new file mode 100644 index 000000000..ac381cf98 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/usage.html @@ -0,0 +1,46 @@ + + + + + + + +Programmatic usage + + +

Programmatic usage

+

+Perform service discovery session: +

+
+
+int timeout = 500; // milliseconds
+String query = "_services._dns-sd._udp.local.";	//DNS-SD query
+		
+//instantiate protocol by name attribute		
+IProtocol protocol = ProtocolFactory.getProtocol("DNS-SD");  
+
+//instantiate transport by name attribute
+ITransport transport = TransportFactory.getTransport("UDP", "224.0.0.251", timeout); 
+
+//get engine instance and kick off discovery		
+ServiceDiscoveryEngine serviceDiscoveryEngine = ServiceDiscoveryEngine.getInstance();	
+serviceDiscoveryEngine.doServiceDiscovery(query, protocol,transport);
+
+
+

+Access EMF model: +

+
+
+//get engine instance
+ServiceDiscoveryEngine serviceDiscoveryEngine = ServiceDiscoveryEngine.getInstance();	
+
+//access org.eclipse.emf.ecore.resource.Resource
+Resource model = serviceDiscoveryEngine.getResource();
+		
+
+ + + + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/guide/view.html b/discovery/org.eclipse.tm.discovery.doc.isv/guide/view.html new file mode 100644 index 000000000..1189ae0be --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/guide/view.html @@ -0,0 +1,37 @@ + + + + + + + +Discovery View + + +

Discovery View

+

+The Discovery view can be used to test new extensions and discover available services using the existing protocol and transport implementations.
+It can be accessed through the view "Service Discovery" -> "Service Discovery Properties".
+
+In the view, it's possible launching a wizard to select the protocol and transport to be used: +

+

+

+ +
+

+

+And inspect the discovered services and their attributes:
+

+

+

+ +
+

+

+Since the same model is used, launching multiple times the wizard adds new discovered services to the same model, even using different protocols and transports. +

+ + + + \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/plugin.properties b/discovery/org.eclipse.tm.discovery.doc.isv/plugin.properties new file mode 100644 index 000000000..7e69f616f --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/plugin.properties @@ -0,0 +1,16 @@ +############################################################################### +# Copyright (c) 2007 Symbian Software Ltd. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# Javier Montalvo Orus - initial API and implementation +############################################################################### + +# NLS_MESSAGEFORMAT_NONE +# NLS_ENCODING=UTF-8 + +pluginName=Service Discovery ISV Documentation +providerName=Eclipse.org diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/plugin.xml b/discovery/org.eclipse.tm.discovery.doc.isv/plugin.xml new file mode 100644 index 000000000..c98822571 --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/plugin.xml @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/reference/.cvsignore b/discovery/org.eclipse.tm.discovery.doc.isv/reference/.cvsignore new file mode 100644 index 000000000..9e5bfb42d --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/reference/.cvsignore @@ -0,0 +1 @@ +api \ No newline at end of file diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/reference/extension-points/.cvsignore b/discovery/org.eclipse.tm.discovery.doc.isv/reference/extension-points/.cvsignore new file mode 100644 index 000000000..9c59eabff --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/reference/extension-points/.cvsignore @@ -0,0 +1 @@ +org_eclipse_*.html diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/schema.css b/discovery/org.eclipse.tm.discovery.doc.isv/schema.css new file mode 100644 index 000000000..00f9d01bf --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/schema.css @@ -0,0 +1,66 @@ +H6.CaptionFigColumn#header { + font-size:16px; + display:inline +} + +P.Note#copyright { + font-size: smaller; + font-style: normal; + color: #336699; + display:inline; + margin-top: 3.000000pt; + margin-bottom: 11.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; +} + +P.Code#dtd { + color: #800000; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 10.000000pt; +} + +P.Code#dtdAttlist { + color: #800000; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 20.000000pt; +} + +P.Code#tag { + color: #000080; + display:inline; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; +} + +P.Code#cstring { + color: #008000; + display:inline; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; +} + +.ConfigMarkup#elementDesc { + color: black; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 10.000000pt; +} + +.ConfigMarkup#attlistDesc { + color: black; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 32.000000pt; +} + diff --git a/discovery/org.eclipse.tm.discovery.doc.isv/toc.xml b/discovery/org.eclipse.tm.discovery.doc.isv/toc.xml new file mode 100644 index 000000000..49c21b1af --- /dev/null +++ b/discovery/org.eclipse.tm.discovery.doc.isv/toc.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3