You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by de...@apache.org on 2005/07/01 10:24:04 UTC
svn commit: r208728 - /webservices/axis/trunk/java/xdocs/rest-ws.html
Author: deepal
Date: Fri Jul 1 01:24:03 2005
New Revision: 208728
URL: http://svn.apache.org/viewcvs?rev=208728&view=rev
Log:
formatted and added Client sourece code to the document
Modified:
webservices/axis/trunk/java/xdocs/rest-ws.html
Modified: webservices/axis/trunk/java/xdocs/rest-ws.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/rest-ws.html?rev=208728&r1=208727&r2=208728&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/rest-ws.html (original)
+++ webservices/axis/trunk/java/xdocs/rest-ws.html Fri Jul 1 01:24:03 2005
@@ -1,48 +1,48 @@
-
-<html>
-<head><TITLE>RESTful Web Services Support</TITLE></head>
-<body>
-
-<h1>RESTful Web Services Support</h1>
-<p>Axis2 can be configured as REST Cantainer and can be used to send and receive restful web services requests and responses. The REST Web Services can be access in two ways, using HTTP GET and POST. </p>
-
- <h2>Doing REST web services with HTTP POST</h2>
- <p>REST support can be enabled in the Server side by adding the following line to the axis.xml file.</p>
- <code>
-<parameter name="eanbleREST" locked="xsd:false">true</parameter>
- </code>
- <p>But it acts both as a REST endpoint as well as a SOAP endpoint. When a Message is received if the content type is text/xml andif the SOAP Action Headers are missing, then the Message is treated as a RESTful Message. Else they are treated as usual SOAP Messages.</p>
-
- <p>On sending a message out, the fact that the message is RESTful or not, can be decided from the client API or by deployment descriptor of the client.</p>
-<ol>
- <li> By adding an entry in the client.xml file similar to that of the axis.xml.</li>
-<li>Through client API e.g. call.setDoREST(true);</li>
-<code>call.setDoREST(true);</code>
-</ol>
+<html><head><TITLE>RESTful Web Services Support</TITLE></head><body><h1>RESTful Web Services Support</h1><p>Axis2 can be configured as REST Cantainer and can be used to send and receive restful web services requests and responses. The REST Web Services can be access in two ways, using HTTP GET and POST. </p> <h2>Doing REST web services with HTTP POST</h2> <p>REST support can be enabled in the Server side by adding the following line to the axis.xml file.</p><font color="blue"> < parameter name="eanbleREST" locked="xsd:false" > true </parameter> </font> <p>But it acts both as a REST endpoint as well as a SOAP endpoint. When a Message is received if the content type is text/xml andif the SOAP Action Headers are missing, then the Message is treated as a RESTful Message. Else they are treated as usual SOAP Messages.</p> <p>On sending a message out, the fact that the message is RESTful or not, can be decided from the client API or by deployment descriptor of the client.</p><ol> <li> By adding an entry in the client.xml file similar to that of the axis.xml.</li><li>Through client API e.g. call.setDoREST(true);</li>
+<code>call.setDoREST(true);</code></ol>
<h3>Sample REST - HTTP POST Client</h3>
-<p>There's a sample.axis2rest.MyServiceClient.java which demonstrates the usage of the above, using the <code>echo</code> operation of the <code>userguide.example1.MyService</code> of the samples.
-
- <h2>Access a REST Web Service Via HTTP GET</h2>
- <p>Axis2 let the users access Web Service that has simple type parameters via the HTTP GET. For example following URL requests the version service Via HTTP GET. But the Web Services arrived via GET assumes REST . Other parameter are converted in to the XML and put them in to the SOAP Body.</p>
- <code>http://127.0.0.1:8080/axis2/services/Version/getVersion</code>
- <p>Result can be shown in the browser as follows</p>
- <img src="images/userguide/http-get-ws.png"/>
-
-
- <p>For an example request <code>http://127.0.0.1:8080/axis2/services/Version/getVersion/code> will be converted to the following SOAP Message for processing by Axis2</p>
- <pre>
- <code>
-<soapenv:Envelope
- xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
- xmlns:xsd="http://www.w3.org/2001/XMLSchema"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
- <soapenv:Body>
- <axis2:getVersion xmlns:axis2="http://ws.apache.org/goGetWithREST" ></axis2:getVersion>
- </soapenv:Body>
-</soapenv:Envelope>
-</code>
- </pre>
-</body>
-</html>
+<p>There's a sample.axis2rest.MyServiceClient.java which demonstrates the usage of the above, using the <code>echo</code> operation of the <code>userguide.example1.MyService</code> of the samples. And the class source will be as follows
+<pre>
+<code>
+public class MyServiceClient {
+
+ private static String toEpr = "http://localhost:8080/axis2/services/MyService";
+
+ public static void main(String[] args) throws AxisFault {
+
+ Call call = new Call();
+ call.setTo(new EndpointReference(AddressingConstants.WSA_TO,toEpr));
+ call.setTransportInfo(Constants.TRANSPORT_HTTP,Constants.TRANSPORT_HTTP,false);
+ call.setDoREST(true);
+
+ OMElement result = call.invokeBlocking("echo", getPayload());
+
+ try {
+ XMLStreamWriter writer = XMLOutputFactory.newInstance().createXMLStreamWriter(System.out);
+ result.serializeWithCache(new OMOutput(writer));
+ writer.flush();
+ } catch (XMLStreamException e) {
+ e.printStackTrace();
+ } catch (FactoryConfigurationError e) {
+ e.printStackTrace();
+ }
+ }
+
+
+ private static OMElement getPayload() {
+ OMFactory fac = OMAbstractFactory.getOMFactory();
+ OMNamespace omNs = fac.createOMNamespace(
+ "http://example1.org/example1", "example1");
+ OMElement method = fac.createOMElement("echo", omNs);
+ OMElement value = fac.createOMElement("Text", omNs);
+ value.addChild(fac.createText(value, "Axis2 Echo String "));
+ method.addChild(value);
+
+ return method;
+ }
+}
+</code>
+</pre>
+
+ <h2>Access a REST Web Service Via HTTP GET</h2> <p>Axis2 let the users access Web Service that has simple type parameters via the HTTP GET. For example following URL requests the version service Via HTTP GET. But the Web Services arrived via GET assumes REST . Other parameter are converted in to the XML and put them in to the SOAP Body.</p> <code>http://127.0.0.1:8080/axis2/services/Version/getVersion</code> <p>Result can be shown in the browser as follows</p> <img src="images/userguide/http-get-ws.png"/> <p>For an example request <code>http://127.0.0.1:8080/axis2/services/Version/getVersion/code> will be converted to the following SOAP Message for processing by Axis2</p> <pre> <pre><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"<br> xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<br> xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing"><br><soapenv:Body> <br> <axis2:getVersion xmlns:axis2="http://ws.apache.org/goGetWithREST" ></axis2:getVersion><br> </soapenv:Body><br></soapenv:Envelope></pre> </pre></body></html>