Author: keith Date: Sat Jul 19 01:25:17 2008 New Revision: 19623 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19623
Log: Adding documentation for the Request Host object Added: trunk/mashup/java/xdocs/requesthostobject.html Modified: trunk/mashup/java/xdocs/hostedobjects.html trunk/mashup/java/xdocs/toc.html Modified: trunk/mashup/java/xdocs/hostedobjects.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/hostedobjects.html?rev=19623&r1=19622&r2=19623&view=diff ============================================================================== --- trunk/mashup/java/xdocs/hostedobjects.html (original) +++ trunk/mashup/java/xdocs/hostedobjects.html Sat Jul 19 01:25:17 2008 @@ -1,4 +1,5 @@ -<!-- +<!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"); @@ -13,8 +14,6 @@ ~ See the License for the specific language governing permissions and ~ limitations under the License. --> -<html> -<head> @@ -29,10 +28,8 @@ - <title>WSO2 Mashup Server, Host Objects</title> - <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> -</head> - + + <title>WSO2 Mashup Server, Host Objects</title><link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"></head> <body lang="EN-US"> @@ -71,7 +68,9 @@ <li><a href="filehostobject.html">File</a>: An object that allows files to be read and written to the .resources - folder.</li> + folder.</li><li><a href="requesthostobject.html">Request</a>: + A global object that provides the ability for users +to get information regarding the request it received. </li> @@ -118,8 +117,7 @@ -<p>� WSO2 Inc.</p> +<p>� 2007-2008 WSO2 Inc.</p> -</body> -</html> +</body></html> \ No newline at end of file Added: trunk/mashup/java/xdocs/requesthostobject.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/requesthostobject.html?pathrev=19623 ============================================================================== --- (empty file) +++ trunk/mashup/java/xdocs/requesthostobject.html Sat Jul 19 01:25:17 2008 @@ -0,0 +1,80 @@ +<!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. +--> +<meta http-equiv="content-type" content=""><title>Request Host Object</title> + +<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> +</head> +<body> +<div id="main-content"> +<h1>Request Host Object</h1> +<h3>1.0 Introduction</h3> +<p>The 'request' host object provides the ability for users +to get information regarding the request it received and hence it +consists of a set of readOnly properties. The request +object is global and thus does not need to be instantiated explicitly. +The request host object was introduced in vertion 1.5 of the Mashup +Server.</p> +<h3>1.1 Example</h3> +<div class="code"> +<pre>function securedUsingUTOverHTTPS() {<br> system.log("This mashup was invoked by the following User : " + request.authenticatedUser );<br> system.log("This mashup was invoked from the following IP : " + request.remoteIP );<br> system.log("This mashup was invoked with the following URL : " + request.address );<br>}</pre> +</div> +<h3>2.0 Request Object</h3> +<h3>2.1 Request Object Interface</h3> +<p>{<br> readonly property string address;<br> + readonly property string remoteIP;<br> + readonly property string authenticatedUser;<span style="font-weight: normal;"></span><br style="font-weight: bold;"> +}</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>readonly property string address;</b> +</td> +<td>Returns the URL corresponding to the request a s a String <br clear="all"> + <em>var requestURL = +system.address;</em></td> +<td> 1.5</td> +</tr><tr><td><b>readonly property string remoteIP;</b></td><td>Returns the remoteIP that the request was made from.<br> + <em>var remoteIP = +system.remoteIP;</em></td><td>1.5</td></tr><tr><td><b>readonly property string authenticatedUser;</b></td><td>Appplicable to Mashups that are secured using scecurity scenario 1 (UsernameToken with Timestamp over HTTPS). This method will return the username of the user who called this mashup.<br><span style="font-style: italic;"> + </span><em style="font-style: italic;">var </em><span style="font-style: italic;">authenticatedUser</span><em style="font-style: italic;"> = +system.</em><span style="font-style: italic;">authenticatedUser</span><em style="font-style: italic;">;</em></td><td>1.5</td></tr> + + + + + + + +</tbody> +</table> +<h3>3.0 References</h3> +<ul> +<li><a href="apidocs/org/wso2/mashup/hostobjects/request/Request.html">JavaDoc +for the request host Object</a></li> +</ul> +</div> +<p>� 2007-2008 WSO2 Inc.</p> +</body></html> \ No newline at end of file Modified: trunk/mashup/java/xdocs/toc.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/toc.html?rev=19623&r1=19622&r2=19623&view=diff ============================================================================== --- trunk/mashup/java/xdocs/toc.html (original) +++ trunk/mashup/java/xdocs/toc.html Sat Jul 19 01:25:17 2008 @@ -1,177 +1,84 @@ +<!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> +~ 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>WSO2 Mashup Server Documentation - Table of Contents</title> - - - <meta http-equiv="content-type" content=""> - - - - - - <title></title> - <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> +<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> </head> - <body style="margin: 0px; padding: 0px; direction: ltr;" lang="en-US"> - - <div class="nav_header">Documentation Index</div> - - <div id="nav_list"> <p><a href="introduction.html" target="mainFrame">Introduction</a></p> - - <p><a href="community.html" target="mainFrame">WSO2 Mashup Server Community</a></p> - - <p><a target="mainFrame" href="installationguide.html">Installation</a></p> - - <p><a href="adminguide.html" target="mainFrame">Managing Services</a></p> <p><a href="usermanagement.html" target="mainFrame">Managing Users</a></p> -<p><a href="apidocs/index.html" target="_blank">API Docs</a></p> - +<p><a href="apidocs/index.html" target="_blank">API +Docs</a></p> <h3>Writing Services</h3> - - <ul> - - - <li><a href="helloworldservice.html" target="mainFrame">Writing a Hello World Service</a></li> - - - - - <li><a href="generatedresources.html" target="mainFrame">Automatically +<li><a href="helloworldservice.html" target="mainFrame">Writing a Hello World Service</a></li> +<li><a href="generatedresources.html" target="mainFrame">Automatically Generated Resources</a></li> - - - <li><a href="annotations.html" target="mainFrame">Javascript +<li><a href="annotations.html" target="mainFrame">Javascript Web Service Annotations</a></li> - - - <li><a href="dataBinding.html" target="mainFrame">Javascript +<li><a href="dataBinding.html" target="mainFrame">Javascript Data Binding</a></li> - - - <li><a href="restyservices.html" target="mainFrame">Writing RESTful services</a></li> - - - <li><a href="e4xquickstart.html" target="mainFrame">E4X +<li><a href="restyservices.html" target="mainFrame">Writing +RESTful services</a></li> +<li><a href="e4xquickstart.html" target="mainFrame">E4X Quick Start Guide</a></li> - - - <li><a href="tooling.html" target="mainFrame">Productivity +<li><a href="tooling.html" target="mainFrame">Productivity Tools</a></li> - - </ul> - - <h3>Consuming Services</h3> - - <ul> - - - <li><a href="helloworldclient.html" target="mainFrame">Hello +<li><a href="helloworldclient.html" target="mainFrame">Hello World Client</a></li> - - - <li><a href="consumingservices.html" target="mainFrame">Using +<li><a href="consumingservices.html" target="mainFrame">Using stubs</a></li> - - - <li><a href="hostedobjects.html" target="mainFrame">Hosted +<li><a href="hostedobjects.html" target="mainFrame">Hosted Objects</a> - - <ul> - - - <li><a href="apphostobject.html" target="mainFrame">APP</a></li> - - - <li><a href="emailhostobject.html" target="mainFrame">Email</a> - </li> - - - <li><a href="feedhostobject.html" target="mainFrame">Feed</a></li> - - - <li><a href="filehostobject.html" target="mainFrame">File</a></li> - - - <li><a href="imhostobject.html" target="mainFrame">IM</a></li> - - - <li><a href="scraperhostobject.html" target="mainFrame">Scraper</a></li> - - - <li><a href="sessionhostobject.html" target="mainFrame">Session</a></li> - - - <li><a href="systemhostobject.html" target="mainFrame">System</a></li> - - - <li><a href="wsrequesthostobject.html" target="mainFrame">WSRequest</a></li> - - - - </ul> - - - </li> - - +<ul> +<li><a href="apphostobject.html" target="mainFrame">APP</a></li> +<li><a href="emailhostobject.html" target="mainFrame">Email</a> </li> +<li><a href="feedhostobject.html" target="mainFrame">Feed</a></li> +<li><a href="filehostobject.html" target="mainFrame">File</a></li> +<li><a href="imhostobject.html" target="mainFrame">IM</a></li> +<li><a href="requesthostobject.html">Request</a></li> +<li><a href="scraperhostobject.html" target="mainFrame">Scraper</a></li> +<li><a href="sessionhostobject.html" target="mainFrame">Session</a></li> +<li><a href="systemhostobject.html" target="mainFrame">System</a></li> +<li><a href="wsrequesthostobject.html" target="mainFrame">WSRequest</a></li> +</ul> +</li> </ul> - - <h3>Other References</h3> - - <ul> - - - <li><a href="http://mooshup.com"; target="blank">mooshup.com</a></li> - - - <li><a href="http://www.wso2.org/wiki/display/mashup/WSO2+Mashup+Server+Reference"; target="blank">WSO2 Mashup Server Reference</a></li> - - - <li><a href="http://www.wso2.org/taxonomy/term/303/all"; target="blank">The WSO2 Oxygen Tank Library</a></li> - - - <li><a href="http://wso2.org/forum/226"; target="blank">WSO2 +<li><a href="http://mooshup.com"; target="blank">mooshup.com</a></li> +<li><a href="http://www.wso2.org/wiki/display/mashup/WSO2+Mashup+Server+Reference"; target="blank">WSO2 Mashup Server Reference</a></li> +<li><a href="http://www.wso2.org/taxonomy/term/303/all"; target="blank">The WSO2 Oxygen Tank Library</a></li> +<li><a href="http://wso2.org/forum/226"; target="blank">WSO2 Mashup Server Community Forum</a></li> - - </ul> - - </div> - - -</body> -</html> +</body></html> \ No newline at end of file
_______________________________________________ Mashup-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev
