Author: keith
Date: Thu May 1 09:48:22 2008
New Revision: 16443
Log:
Fixing Mashup-769
Modified:
trunk/mashup/java/xdocs/apphostobject.html
Modified: trunk/mashup/java/xdocs/apphostobject.html
==============================================================================
--- trunk/mashup/java/xdocs/apphostobject.html (original)
+++ trunk/mashup/java/xdocs/apphostobject.html Thu May 1 09:48:22 2008
@@ -2,83 +2,92 @@
<html>
<head>
- <meta http-equiv="content-type" content="">
+ <meta http-equiv="content-type" content="">
+ <title>WSO2 Mashup Server, Atom Publishing Protocol (APP) Host
+Object Guide</title>
- <title>WSO2 Mashup Server, Atom Publishing Protocol (APP) Host Object
Guide</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>
+
<div id="main-content">
- <h1> WSO2 Mashup Server, Atom Publishing Protocol (APP) Host
- Object Guide </h1>
+<h1> WSO2 Mashup Server, Atom Publishing Protocol (APP) Host
+Object Guide </h1>
+
+This document describes the set of host objects available for
+publishing using the Atom Publishing Protocol (APP). <br>
+
+<br>
- This document describes the set of host objects available for
- publishing using the Atom Publishing Protocol (APP). <br/>
+<h2>1.0 Introduction </h2>
- <br/>
+The APP implementation consists of three main host objects, namely
+AtomFeed, AtomEntry and APPClient.<br>
- <h2>1.0 Introduction </h2>
+ <br>
- The APP implementation consists of three main host objects, namely
- AtomFeed, AtomEntry and APPClient.<br/>
+<h3> 1.1 AtomFeed </h3>
- <br/>
+The "AtomFeed" host object serves as the top level element of
+an Atom Feed Document, acting as a container for meta data and data
+associated with the feed. Its element children consist of meta data
+elements followed by zero or more "AtomEntry" child elements.<br>
- <h3> 1.1 AtomFeed </h3>
+<h3> 1.2 AtomEntry </h3>
- The "AtomFeed" host object serves as the top level element of
- an Atom Feed Document, acting as a container for meta data and data
- associated with the feed. Its element children consist of meta data
- elements followed by zero or more "AtomEntry" child elements.<br/>
+The "AtomEntry" host object represents an individual entry, acting as a
+container for meta data and data associated with the entry. This
+element can appear as a child of the "AtomFeed" element, or it can
+appear as the document (i.e., top-level) element of a stand-alone Atom
+Entry Document.<br>
- <h3> 1.2 AtomEntry </h3>
+<br>
- The "AtomEntry" host object represents an individual entry, acting as a
- container for meta data and data associated with the entry. This
- element
- can appear as a child of the "AtomFeed" element, or it can appear as
- the document (i.e., top-level) element of a stand-alone Atom Entry
- Document.<br/>
+<h3>1.3 APPClient</h3>
- <br/>
+The "APPClient" host object acts as a client to an APP server. It is
+capable of authenticating using the given credentials and performing
+HTTP operations GET, POST, PUT and DELETE.<br>
- <h3>1.3 APPClient</h3>
+<br>
- The "APPClient" host object acts as a client to an APP server. It is
- capable of authenticating using the given credentials and performing
- HTTP operations GET, POST, PUT and DELETE.<br/>
+<br>
- <br/>
+<h2>2.0 Examples</h2>
- <br/>
+<br>
- <h2>2.0 Examples</h2>
+<div class="code">
+<pre> <br> //Creating an instance of APPClient<br> var client = new
APPClient(); <br><br> //Creating an instance of AtomFeed<br> var feed = new
AtomFeed(); <br><br> //Setting login credentials for the client <br>
client.credentials={username:"[EMAIL
PROTECTED]",password:"xxx",service:"blogger",authtype:"google"};<br><br>
//Retrieving and online feed<br> feed =
client.getFeed("http://www.blogger.com/feeds/000/posts/full/000"); <br><br>
//Getting an array of individual entries from the feed <br> var entries = new
Array();<br> entries = feed.getEntries(); <br><br> //Writing the retrieved feed
to a file <br> feed.writeTo("my-file-name.xml");<br><br></pre>
- <br/>
+</div>
+
+<br>
+
+<h2>3.0 References</h2>
- <div class="code">
- <pre> <br/> //Creating an instance of APPClient<br/> var client = new
APPClient(); <br/><br/> //Creating an instance of AtomFeed<br/> var feed = new
AtomFeed(); <br/><br/> //Setting login credentials for the client <br/>
client.credentials={username:"[EMAIL
PROTECTED]",password:"xxx",service:"blogger",authtype:"google"};<br/><br/>
//Retrieving and online feed<br/> feed =
client.getFeed("http://www.blogger.com/feeds/000/posts/full/000"); <br/><br/>
//Getting an array of individual entries from the feed <br/> var entries = new
Array();<br/> entries = feed.getEntries(); <br/><br/> //Writing the retrieved
feed to a file <br/> feed.writeTo("my-file-name.xml");<br/><br/></pre>
+<ul>
- </div>
+ <li><a
href="apidocs/org/wso2/mashup/hostobjects/atom/AtomFeedHostObject.html">JavaDoc
+for the AtomFeed host Object</a></li>
- <br/>
+ <li><a
href="apidocs/org/wso2/mashup/hostobjects/atom/AtomEntryHostObject.html">JavaDoc
+for the AtomEntry host Object</a></li>
- <h3>3.0 References</h3>
+ <li><a
href="apidocs/org/wso2/mashup/hostobjects/atom/APPClientHostObject.html">JavaDoc
+for the APPClient host Object</a></li>
+</ul>
- <ul>
- <li><a
href="apidocs/org/wso2/mashup/hostobjects/atom/AtomFeedHostObject.html">JavaDoc
for
- the AtomFeed host Object</a></li>
- <li><a
href="apidocs/org/wso2/mashup/hostobjects/atom/AtomEntryHostObject">JavaDoc for
the
- AtomEntry host Object</a></li>
- <li><a
href="apidocs/org/wso2/mashup/hostobjects/atom/APPClientHostObject">JavaDoc for
the
- AtomClient host Object</a></li>
- </ul>
- <br/>
+<br>
</div>
-<p>© WSO2 Inc.</p>
+
+<p>� WSO2 Inc.</p>
+
</body>
-</html>
\ No newline at end of file
+</html>
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev