Author: keith
Date: Sat Jan 26 23:18:47 2008
New Revision: 12983
Log:
Updating details of where the scripts should be placed and so on
Modified:
trunk/mashup/java/xdocs/helloworldservice.html
Modified: trunk/mashup/java/xdocs/helloworldservice.html
==============================================================================
--- trunk/mashup/java/xdocs/helloworldservice.html (original)
+++ trunk/mashup/java/xdocs/helloworldservice.html Sat Jan 26 23:18:47 2008
@@ -2,23 +2,32 @@
<html>
<head>
- <meta http-equiv="content-type" content="">
- <title></title>
+
+ <meta http-equiv="content-type" content="">
- <link href="styles.css" rel="stylesheet" type="text/css" media="all">
+
+
+
+ <title></title>
+ <link href="styles.css" rel="stylesheet" type="text/css" media="all">
</head>
+
<body>
+
<div id="main-content">
<h1>Writing a Hello World Service !!</h1>
+
<h2>JavaScript</h2>
+
<p></p>
+
<p>The Mashup Server supports the quick and easy creation of Web
services
written in JavaScript. Just as a Web server such as Apache or
@@ -27,77 +36,101 @@
Mashup
Server takes JavaScript files, placed in a local directory, and exposes
the
- functions as Web Service operations. <br/>
+ functions as Web Service operations. <br>
- <br/>
- The simplest way to deploy a new Web service is simply to write some
- JavaScript and place it in the 'scripts' directory of the Mashup
- Server.
- Follow these simple steps: </p>
+ <br>
+The simplest way to deploy a new Web service is simply to write some
+JavaScript and place it in your home directory (A directory which
+corresponds to your username. Placing it in any sub folder which is
+under the scripts directory will work, but the Author of the service is
+infered from where the script was placed.) which is located under the
+'scripts' directory of the Mashup Server. Alternatively you
+can use the <a href="adminguide.html#CreatingNewMashup">Create new
service wizard</a> from the UI. Follow these simple steps (Assuming that your
username is bob): </p>
+
<p></p>
+
<h3>Step 1:</h3>
+
In Notepad or your favorite IDE, type the following text:
-<p class="Code">function hello() {<br/>
+<p class="Code">function hello() {<br>
+
+
+ return "Hello
+ World";<br>
- return <response>Hello
- World</response>;<br/>
}</p>
-<br/>
+
+<br>
+
<h3>Step 2:</h3>
+Save this file as 'helloworld.js' in your home directory (Assuming that
+your username is bob) which is located under the 'scripts' directory of
+the Mashup Server.<br>
+
-Save this file as 'helloworld.js' in the directory 'scripts' within the
-Mashup Server directory. <br/>
+<img src="images/scripts_dir.png" title="Mashup server directory structure -
scripts folder"> <br>
-<img src="images/scripts_dir.png" title="Mashup server directory structure -
scripts folder"> <br/>
<h3>Step 3:</h3>
+
That's it, the 'hello world' service is now live, exposing a single
operation
-'hello' that returns some XML. But let's try it out to make
+'hello' that returns the text "Hello
+ World". But let's try it out to make
sure it's
working properly. Open up the WSO2 Mashup Server web-based
console
(typically at <a href="https://localhost:9443/";>https://localhost:7443/</a>)
-and look for 'helloworld' in the list of the available mashups. <br/>
+and look for 'the helloworld mashup you just created (If yu are signed
+in it will be listed under your mashups else you can use the searching
+facility of the Mashup Server to look for the helloworld mashup). <br>
+
-<br/>
+<br>
-<img src="images/helloworld_listing.png" title="hello world service listed in
available mashups">
-<br/>
-Click the '<strong>Try helloworld</strong>' link in the
-mashup widget or try
-typing the tryit URL (typically at <a
href="http://127.0.0.1:9762/services/helloworld?tryit";>http://127.0.0.1:7762/services/helloworld?tryit</a>)
+<img src="images/helloworld_listing.png" title="hello world service listed in
available mashups"><br>
+<br>
+
+
+
+Click the '<strong>Try the service</strong>' link which is in the human
resources section of the Mashup Page or try
+typing the tryit URL (typically at <a
href="http://127.0.0.1:9762/services/helloworld?tryit";>http://localhost:7762/services/bob/helloworld?tryit</a>)
in the browser, and you will get a web-based client that can interact
with
the Web service. In this case just click
the button titled <span style="font-weight: bold;">hello >></span>
-to invoke the hello operation. The response is illustrated below: <br/>
+to invoke the hello operation. The response is illustrated below: <br>
+
-<br/>
+<br>
-<img src="images/helloworld_tryit.png" title="Try the helloworld mashup"> <br/>
-<br/>
+<img src="images/helloworld_tryit.png" title="Try the helloworld mashup"> <br>
-The Helloworld mashup widget also contains many helpful resources. <br/>
-<br/>
+<br>
+<br>
+The Helloworld mashup also contains many helpful resources which are
described <a href="#Automatically_Generated_Resources">here</a>. <br>
-<img src="images/helloworld_widget.png" title="Helloworld mashup widget"> <br/>
-<br/>
+ <br>
+
+
+<br>
+
<h2>Adding an user Interface for your service</h2>
+
<p>When a service is deployed, Mashup server automatically
creates a folder
to store the resources that belong to the service. This folder is named
@@ -110,9 +143,8 @@
created
"www" folder. This user interface will appear when you point your
browser to
- the End Point Reference of the service (eg:
- http://localhost:7762/services/helloworld). Refer to the <a
-
href="http://www.wso2.org/wiki/display/mashup/Deploying+Javascript+Services";>deploying
+ the Endpoint Reference of the service (eg:
+ http://localhost:7762/services/bob/helloworld). Refer to the <a
href="http://www.wso2.org/wiki/display/mashup/Deploying+Javascript+Services";>deploying
Javascript services</a> for more details on the mashup server
deployment structure. The Mashup Server also creates a "_private"
folder under your resources folder. Any content placed in this
@@ -120,113 +152,24 @@
mashups. Therefore this folder can be used to save data that you
need to keep private during shring of mashups.</p>
+
<p><img src="images/www_folder.png" title="servicejsfilename.resources folder
structure"></p>
+
<p>Please refer to <a href="helloworldclient.html">"writing
hello world
client"</a> for more information about creating AJAX clients for
the mashup
- services deployed in the WSO2 mashup server.</p>
-
-<h2>Automatically Generated Resources</h2>
-
-<p></p>
-
-<p>Just by virtue of deploying the service, the WSO2 mashup
- server generates
- a number of descriptive artifacts and tools to make it easy to consume
- the
- web service you've just created. These artifacts are linked from the
- management console for the service, or can be accessed directly from
- the
- endpoint URI associated with the service. Typically the endpoint URI is
- http://{host ip}:7762/services/{service name}, where the service name
- is by
- default the name of the JavaScript file defining the service (minus the
- '.js'). By appending one of the following queries to the endpoint URI,
- different artifacts and tools can be accessed: <br/>
-
- <br/>
-
+ services deployed in the WSO2 mashup server.<br>
</p>
-<table class="MsoTableGrid" style="margin-left: 0.5in; border-collapse:
collapse;" border="1"
- cellpadding="5" cellspacing="0">
-
- <tbody>
-
- <tr>
-
- <td valign="top"><a
href="generatedresources.html#WSDL">?wsdl2</a></td>
-
- <td valign="top">WSDL 2.0 description of the service</td>
-
- </tr>
-
- <tr>
-
- <td valign="top"><a
href="generatedresources.html#WSDL">?wsdl</a></td>
-
- <td valign="top">WSDL 1.1 description of the service</td>
-
- </tr>
-
- <tr>
-
- <td valign="top"><a
href="generatedresources.html#Schema">?xsd</a></td>
-
- <td valign="top">XML Schema description of the
- service
- </td>
-
- </tr>
-
- <tr>
- <td valign="top"><a
href="generatedresources.html#stub">?stub</a></td>
+<br>
- <td valign="top">JavaScript or E4X stub for
- accessing the service
- </td>
- </tr>
-
- <tr>
-
- <td valign="top"><a
href="generatedresources.html#Try-it">?tryit</a></td>
-
- <td valign="top">Ajax client for simple, generic
- interactions with the service
- </td>
-
- </tr>
-
- <tr>
-
- <td valign="top"><a
href="generatedresources.html#Source">?source</a></td>
-
- <td valign="top">The JavaScript source code for the
- service
- </td>
-
- </tr>
-
- <tr>
-
- <td valign="top"><a
href="generatedresources.html#Doc">?doc</a></td>
-
- <td valign="top">API Documentation for the service</td>
-
- </tr>
-
- </tbody>
-</table>
-
-<br/>
+</div>
-<br/>
+<p>� WSO2 Inc.</p>
-</div>
-<p>© WSO2 Inc.</p>
</body>
</html>
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
