Changes between Version 2 and Version 3 of ExampleUsingXmlRpcBeans

Timestamp:

10/09/06 14:43:03 (18 years ago)

Author:

lauer

Comment:

--

ExampleUsingXmlRpcBeans

@@ -1 @@
-== Using XmlRpcBeans in you API ==
+== Using !XmlRpcBeans in you API ==
 
-What are XmlRpcBeans??
-
+What are !XmlRpcBeans??
 
 Sometimes parameter conversion is a straight-forward task which can be handed over to the XML-RPC runtime system.
 When a java class fulfills certain conditions (roughly, being a java bean with complatible types) it can be turned into a XmlRpcBean
-by annotating it with the @!XmlRpcBean annotation. It then can be used in every XML-RPC call without restriction.
+by annotating it with the @!XmlRpcBean annotation. It then can be used in every XML-RPC call without restriction.[[BR]]
+
 A XmlRpcBean must have
 
@@ -13 +13 @@
   - like a java bean: for each property which is supposed to be transported over XML-RPC there has to exist a public getter and setter method
 
-  - each peroperty type has to be XML-RPC compliant, that is it has to have one of the follwoing properties:
+  - each property type has to be a XML-RPC compliant type, that is it has to have one of the follwoing properties:
+    - it is a standard XML-RPC type
+    - it is annotated with a @!XmlRpc annotation and defines proper conversion methods
+    - a conversion mapping for that type is put at the XmlRpcBean (which then acts as an API itself)
+    - it is an XmlRpcBean (that is, XmlRpcBeans can be nested)
 
-   - it is a standard XML-RPC type
+Technically, an !XmlRpcBean is converted into a XML-RPC STRUCT. The field names of the tranfered map are the property names derived from the bean class.
 
-   - it is annotated with a @!XmlRpc annotation and defines proper conversion methods
 
-   - a conversion mapping for that type is put at the XmlRpcBean (which then acts as an API itself)
-
-   - it is an XmlRpcBean (that is, XmlRpcBeans can be nested)
+Lets look at an example !XmlRpcBean (note that this bean also defines a converter mapping for type ''URL''):
+{{{
+@XmlRpcBean
+@ConverterMappings( @Mapping(type=URL.class,converter=URLConverter.class) )
+public class CoffeeBean
+{
+    public URL getOrigin()
+    {
+        return mOrigin;
+    }
+    public void setOrigin( URL origin )
+    {
+        mOrigin = origin;
+    }
+    public String getType()
+    {
+        return mType;
+    }
+    public void setType( String type )
+    {
+        mType = type;
+    }
+    
+    public String toString()
+    {
+        return( "CoffeeBean(" + getType() + ") comming from '" + getOrigin() + "'" );
+    }
+    private String mType;
+    private URL mOrigin;
+}
+}}}
 
 See also [http://delight.opendfki.de/wiki/ExampleUsingOwnConceteTypes#UsingowntypesinCollectionsandMaps How to use own types in Collections an Maps].