Author: keith Date: Fri Jul 18 21:44:49 2008 New Revision: 19608 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19608
Log: Updating the system HO docs Modified: trunk/mashup/java/xdocs/sessionhostobject.html Modified: trunk/mashup/java/xdocs/sessionhostobject.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/sessionhostobject.html?rev=19608&r1=19607&r2=19608&view=diff ============================================================================== --- trunk/mashup/java/xdocs/sessionhostobject.html (original) +++ trunk/mashup/java/xdocs/sessionhostobject.html Fri Jul 18 21:44:49 2008 @@ -1,171 +1,137 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head> <!-- - ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) - ~ - ~ Licensed under the Apache License, Version 2.0 (the "License"); - ~ you may not use this file except in compliance with the License. - ~ You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> -<html> -<head> - - <meta http-equiv="content-type" content=""> - <title>Session Host Object</title> - - - <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> +~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) +~ +~ Licensed under the Apache License, Version 2.0 (the "License"); +~ you may not use this file except in compliance with the License. +~ You may obtain a copy of the License at +~ +~ http://www.apache.org/licenses/LICENSE-2.0 +~ +~ Unless required by applicable law or agreed to in writing, software +~ distributed under the License is distributed on an "AS IS" BASIS, +~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~ See the License for the specific language governing permissions and +~ limitations under the License. +--> +<meta http-equiv="content-type" content=""><title>Session Host Object</title> +<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> </head> - <body> <div id="main-content"> <h1>Session Host Object</h1> - <h3> 1.0 Introduction</h3> - <p>The 'session' hosted object provides the ability for the users to share objects across different service invocations. The session object is global and thus does not need to be instantiated explicitly.</p> - <h3>1.1 Example</h3> - <div class="code"> <pre>this.serviceName = "ApplicationScopeService";<br>this.scope="application";<br>var key = "number";<br>function putValue(param){<br> session.put(key,2);<br> return <success/>;<br>}<br><br>function getValue(param){<br> number = session.get(key);<br> return <number>{number}</number>;<br>}<br><br>function removeValue(param){<br> number = session.remove(key);<br> return <success/>;<br>}<br><br>function clearSession(param){<br> session.clear();<br> return <success/>;<br>}</pre> - </div> - <h3>2.0 Session Object</h3> - <p>Session scope for a deployed mashup can be given using the "scope" service property annotation. Following are the set of supported scopes.</p> - <p> <b>'request'</b> - The state date stored in the session object will be <b><em>available only for the current invocation</em></b> of the service. In other words the session object has no effect in this scope.</p> - <p> <b>'transportsession'</b> - The state date stored in the session object will be <b><em>available only for the</em></b> <b><em>life time of the transport session</em></b> used for invoking this service. This can be used to store data across invocations for a specific client.</p> - <p> '<b>application</b>' - The state date stored in the session object will be <b><em>available throughout the life time</em></b> of the service.</p> - <p> <b>'soapsession'</b> - WS-Addressing is required for this. <font color="#ff0000"><b>< Not Implemented as yet ></b></font><br> - </p> - <p>By default, Mashup services deployed in the WSO2 Mashup Server are running in the "request" scope.</p> - <h3>2.1 Session Object Interface</h3> - <p>{ <br> - function void put(key,object);<br> - function object get(key);<br> - function void remove(key);<br> - function void clear();<br> - + function int size();<br> + function String[] getKeys();<br> }</p> - <h3>2.2 API Documentation </h3> - <table class="MsoTableGrid" style="margin-left: 0.5in; border-collapse: collapse;" border="1" cellpadding="5" cellspacing="0"> - - <tbody> - - <tr> - - <td> Member</td> - - <td> Description</td> - - <td> Supported in version</td> - - </tr> - - <tr> - - <td><b>void put(key,object);</b></td> - - <td> Puts the key value pair in to the session object. This +<tbody> +<tr> +<td> Member</td> +<td> Description</td> +<td> Supported in version</td> +</tr> +<tr> +<td><span style="font-weight: bold;">function</span> +<b>void put(key,object);</b></td> +<td> Puts the key value pair in to the session object. This pair will be available for the service invocations across the session. <br clear="all"> - - <em> session.put("name", +<em> session.put("name", "WSO2 Mashup Server");</em></td> - - <td> 0.1</td> - - </tr> - - <tr> - - <td><b>object get(key);</b></td> - - <td> Retrieves the value associated with the given "key" +<td> 0.1</td> +</tr> +<tr> +<td><span style="font-weight: bold;">function </span><b>object +get(key);</b></td> +<td> Retrieves the value associated with the given "key" from the current session object. <br clear="all"> - - <em> +<em> session.get("name"); </em></td> - - <td> 0.1</td> - - </tr> - <tr> - <td><b>void remove(key);</b></td> - <td> Removes the value associated with the given "key" +<td> 0.1</td> +</tr> +<tr> +<td><span style="font-weight: bold;">function </span><b>void +remove(key);</b></td> +<td> Removes the value associated with the given "key" from the current session object. <br clear="all"> - - <em> +<em> session.remove("name"); </em></td> - <td>1.0</td> - </tr> - <tr> - <td><b>void clear();</b></td> - <td> Removes all values from the current session object. <br clear="all"> - - <em> +<td>1.0</td> +</tr> +<tr> +<td><span style="font-weight: bold;">function </span><b>void +clear();</b></td> +<td> Removes all values from the current session object. <br clear="all"> +<em> session.clear(); </em></td> - <td>1.0</td> - </tr> - - </tbody> +<td>1.0</td> +</tr> +<tr> +<td><span style="font-weight: bold;">function +int</span><b> size();</b></td> +<td>Returns the number of entries in the current session.<br> +<span style="font-style: italic;"> + var size = session.size();</span></td> +<td>1.5</td> +</tr> +<tr> +<td><span style="font-weight: bold;">function +String[]</span><b> getKeys();</b></td> +<td>Returns an array of strings containing all the key +values, which represent the entries stored in the current session.\<br> +<span style="font-style: italic;"> + var keys = session.getKeys();</span></td> +<td>1.5</td> +</tr> +</tbody> </table> - <h3><a name="SessionHostObject-3.0References"></a>3.0 References</h3> - <ul> - - <li><a href="http://www.wso2.org/wiki/display/mashup/Javascript+Web+Service+Annotations"; title="Javascript Web Service Annotations">Javascript Web +<li><a href="http://www.wso2.org/wiki/display/mashup/Javascript+Web+Service+Annotations"; title="Javascript Web Service Annotations">Javascript Web Service Annotations</a> </li> - - <li><a href="apidocs/org/wso2/mashup/hostobjects/session/SessionHostObject.html">JavaDoc +<li><a href="apidocs/org/wso2/mashup/hostobjects/session/SessionHostObject.html">JavaDoc for the session host Object</a></li> - </ul> - </div> - -<p>� WSO2 Inc.</p> - -</body> -</html> +<p>� 2007-2008 WSO2 Inc.</p> +</body></html> \ No newline at end of file
_______________________________________________ Mashup-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev
