You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by jb...@apache.org on 2010/08/19 16:56:24 UTC

svn commit: r987178 - in /servicemix/archetypes/trunk: servicemix-validation-service-unit/src/main/resources/archetype-resources/ servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/ servicemix-vfs-service-unit/...

Author: jbonofre
Date: Thu Aug 19 14:56:23 2010
New Revision: 987178

URL: http://svn.apache.org/viewvc?rev=987178&view=rev
Log:
Complete xbean comments.

Modified:
    servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/pom.xml
    servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/address.xsd
    servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/schema.xsd
    servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml
    servicemix/archetypes/trunk/servicemix-vfs-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml
    servicemix/archetypes/trunk/servicemix-xmpp-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml

Modified: servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/pom.xml
URL: http://svn.apache.org/viewvc/servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/pom.xml?rev=987178&r1=987177&r2=987178&view=diff
==============================================================================
--- servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/pom.xml (original)
+++ servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/pom.xml Thu Aug 19 14:56:23 2010
@@ -1,22 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
-	<!--
-
-		Licensed to the Apache Software Foundation (ASF) under one or more
-		contributor license agreements. See the NOTICE file distributed with
-		this work for additional information regarding copyright ownership.
-		The ASF licenses this file to You 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.
-	-->
+	<!-- Generated by Apache ServiceMix Archetype -->
 
 	<modelVersion>4.0.0</modelVersion>
 

Modified: servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/address.xsd
URL: http://svn.apache.org/viewvc/servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/address.xsd?rev=987178&r1=987177&r2=987178&view=diff
==============================================================================
--- servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/address.xsd (original)
+++ servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/address.xsd Thu Aug 19 14:56:23 2010
@@ -1,22 +1,5 @@
 <?xml version="1.0"?>
-<!--
-
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements.  See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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.
-
--->
+<!-- Generated by Apache ServiceMix Archetype -->
 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 
   <xsd:complexType name="USAddress">

Modified: servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/schema.xsd
URL: http://svn.apache.org/viewvc/servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/schema.xsd?rev=987178&r1=987177&r2=987178&view=diff
==============================================================================
--- servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/schema.xsd (original)
+++ servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/schema.xsd Thu Aug 19 14:56:23 2010
@@ -1,22 +1,5 @@
 <?xml version="1.0"?>
-<!--
-
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements.  See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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.
-
--->
+<!-- Generated by Apache ServiceMix Archetype -->
 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 
   <xsd:annotation>

Modified: servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml
URL: http://svn.apache.org/viewvc/servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml?rev=987178&r1=987177&r2=987178&view=diff
==============================================================================
--- servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml (original)
+++ servicemix/archetypes/trunk/servicemix-validation-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml Thu Aug 19 14:56:23 2010
@@ -1,29 +1,35 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-
-    Licensed to the Apache Software Foundation (ASF) under one or more
-    contributor license agreements.  See the NOTICE file distributed with
-    this work for additional information regarding copyright ownership.
-    The ASF licenses this file to You 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.
--->
+<!-- Generated by Apache ServiceMix Archetype -->
 <beans xmlns:validation="http://servicemix.apache.org/validation/1.0"
        xmlns:replaceMe="http://servicemix.apache.org/replaceMe"
        xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-       xsi:schemaLocation="http://servicemix.apache.org/validation/1.0 http://servicemix.apache.org/schema/servicemix-validation-@{components-version}.xsd
-       http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd" >
+       xsi:schemaLocation="
+            http://servicemix.apache.org/validation/1.0 http://servicemix.apache.org/schema/servicemix-validation-@{components.version}.xsd
+            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd" >
+
+    <!-- 
+        The ServiceMix Validation component provides schema validation of documents
+        using JAXP 1.3 and XMLSchema or RelaxNG.
+        
+            http://servicemix.apache.org/servicemix-validation.html
+    -->
        
-    <!-- BEGIN SNIPPET: validation-fault-flow -->   
+    <!-- BEGIN SNIPPET: validation-fault-flow -->
+    <!-- 
+        The Validation Fault Flow endpoint validate incoming message using schema.xsd file
+        and send a fault if the message couldn't be validated.
+        
+        Attributes:
+            service                         : the endpoint service name
+            endpoint                        : the endpoint name
+            schema                          : javax.xml.validation.Schema
+            schemaLanguage                  : the schema language (http://www.w3.org/2001/XMLSchema by default)
+            schemaSource                    : javax.xml.transform.Source
+            schemaResource                  : the Spring resource for the schema file
+            handlingErrorMethod             : the error handling mode
+            errorHandlerFactory             : implementation of MessageAwareErrorHandlerFactory
+    -->
 	<validation:endpoint service="replaceMe:serviceName" 
     					 endpoint="validation-fault-flow" 
             			 schemaResource="classpath:schema.xsd"
@@ -37,7 +43,7 @@
     					 handlingErrorMethod="FAULT_JBI"/>
     <!-- END SNIPPET: validation-fault-jbi -->    					 
             							 
-    <!-- BEGIN SNIPPET: validation-error-handler -->            							 
+    <!-- BEGIN SNIPPET: validation-error-handler -->				 
 	<validation:endpoint service="replaceMe:serviceName" 
     					 endpoint="validation-error-handler" 
     					 schemaResource="classpath:schema.xsd"

Modified: servicemix/archetypes/trunk/servicemix-vfs-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml
URL: http://svn.apache.org/viewvc/servicemix/archetypes/trunk/servicemix-vfs-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml?rev=987178&r1=987177&r2=987178&view=diff
==============================================================================
--- servicemix/archetypes/trunk/servicemix-vfs-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml (original)
+++ servicemix/archetypes/trunk/servicemix-vfs-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml Thu Aug 19 14:56:23 2010
@@ -7,8 +7,38 @@
        xsi:schemaLocation="
             http://servicemix.apache.org/vfs/1.0 http://servicemix.apache.org/schema/servicemix-vfs-@{components.version}.xsd
             http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
+
+    <!-- 
+        The ServiceMix VFS component provides support for reading from and writing to virtual file system
+        via the bus. It uses Apache Commons VFS (http://commons.apache.org/vfs) library.
+        
+            http://servicemix.apache.org/servicemix-vfs.html
+    -->            
             
     <!-- BEGIN SNIPPET: vfs-poller -->
+    <!-- 
+        The VFS Poller endpoint read file in a given VFS location, marshals it and send to the NMR.
+        
+        Attributes:
+            service                         : the endpoint service name
+            endpoint                        : the endpoint name
+            interfaceName                   : the endpoint interface name
+            targetService                   : the target endpoint service name
+            targetEndpoint                  : the target endpoint name
+            targetInterface                 : the target endpoint interface name
+            targetUri                       : the target endpoint URI
+            firstTime                       : datetime before first poll can take place
+            delay                           : amount of time first polling is delayed after start
+            period                          : amount of time between polls
+            path                            : sets the VFS path to poll
+            deleteFile                      : delete file when it is processed
+            recursive                       : process sub directories
+            marshaler                       : implementation of FileMarshaler to read/write message
+            lockManager                     : implementation of LockManager
+            selector                        : implementation of FileSelector to use
+            comparator                      : implementation of Comparator to order file process
+            fileSystemManager               : sets the VFS file manager object
+    -->
     <vfs:poller service="replaceMe:serviceName"
                 endpoint="vfs-poller"
                 path="tgz:http://remote/file.tar.gz!/inner/directory"
@@ -24,6 +54,17 @@
     <!-- END SNIPPET: vfs-poller -->
     
     <!-- BEGIN SNIPPET: vfs-sender -->
+    <!-- 
+        The VFS Sender endpoint expects message coming from the NMR, marshals it and sent to the 
+        VFS file destination.
+        
+        Attributes:
+            service                         : the endpoint service name
+            endpoint                        : the endpoint name
+            path                            : sets the VFS path where to write file
+            marshaler                       : implementation of FileMarshaler used to read/write file
+            fileSystemManager               : set the VFS file system manager
+    -->
     <vfs:sender service="replaceMe:serviceName"
                 endpoint="vfs-sender"
                 path="sftp://username:password@hostname/path">

Modified: servicemix/archetypes/trunk/servicemix-xmpp-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml
URL: http://svn.apache.org/viewvc/servicemix/archetypes/trunk/servicemix-xmpp-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml?rev=987178&r1=987177&r2=987178&view=diff
==============================================================================
--- servicemix/archetypes/trunk/servicemix-xmpp-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml (original)
+++ servicemix/archetypes/trunk/servicemix-xmpp-service-unit/src/main/resources/archetype-resources/src/main/resources/xbean.xml Thu Aug 19 14:56:23 2010
@@ -4,10 +4,42 @@
        xmlns:xmpp="http://servicemix.apache.org/xmpp/1.0"
        xmlns:replaceMe="http://servicemix.apache.org/replaceMe"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-       xsi:schemaLocation="http://servicemix.apache.org/xmpp/1.0 http://servicemix.apache.org/schema/servicemix-xmpp-@{components-version}.xsd
-                           http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
+       xsi:schemaLocation="
+            http://servicemix.apache.org/xmpp/1.0 http://servicemix.apache.org/schema/servicemix-xmpp-@{components.version}.xsd
+            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
+
+    <!-- 
+        The ServiceMix XMPP component provides support for receiving and sending XMPP messages via the bus.
+           
+            http://servicemix.apache.org/servicemix-xmpp.html
+    -->
 
     <!-- BEGIN SNIPPET: xmpp-receiver -->
+    <!-- 
+        The XMPP Received endpoint connects to XMPP server (Jabber) and waiting for incoming
+        Jabber message. When a Jabber message arrives, it marshals it and send to the NMR.
+        
+        Attributes:
+            service                         : the endpoint service name
+            endpoint                        : the endpoint name
+            targetService                   : the target endpoint service name
+            targetEndpoint                  : the target endpoint name
+            host                            : the XMPP (Jabber) server hostname/IP
+            port                            : the XMPP (Jabber) server port number
+            user                            : the XMPP (Jabber) server user name
+            password                        : the XMPP (Jabber) server password
+            resource                        : the name of resource/client
+            room                            : full room name (for example area51@conference.myserver.com) or null
+            proxyHost                       : the hostname/IP of the proxy to use
+            proxyPort                       : the port number of the proxy to use
+            proxyUser                       : the user name of the proxy to use
+            proxyPass                       : the user password of the proxy to use
+            proxyType                       : the proxy type to use (NONE, HTTP, SOCKS4, SOCKS5)
+            login                           : a flag if the user should login to the XMPP account
+            createAccount                   : a flag if an account should be created for unknown users
+            filter                          : implementation of PacketFilter
+            marshaler                       : implementation of XMPPMarshaler to convert XMPP message to NMR message
+    -->
     <xmpp:receiver service="replaceMe:serviceName" 
                    endpoint="xmpp-receiver"
                    targetService="replaceMe:targetServiceName"
@@ -20,6 +52,32 @@
     <!-- END SNIPPET: xmpp-receiver -->  
     
     <!-- BEGIN SNIPPET: xmpp-sender -->
+    <!-- 
+        The XMPP Sender endpoint expects message coming from the NMR, converts it to XMPP message and send
+        via the XMPP server.
+        
+        Attributes:
+            service                         : the endpoint service name
+            endpoint                        : the endpoint name
+            targetService                   : the target endpoint service name
+            targetEndpoint                  : the target endpoint name
+            host                            : the XMPP (Jabber) server hostname/IP
+            port                            : the XMPP (Jabber) server port number
+            user                            : the XMPP (Jabber) server user name
+            password                        : the XMPP (Jabber) server password
+            resource                        : the name of resource/client
+            participant                     : the name of the person to chat with (if you specify this, leave room null)
+            room                            : full room name (for example area51@conference.myserver.com) or null
+            proxyHost                       : the hostname/IP of the proxy to use
+            proxyPort                       : the port number of the proxy to use
+            proxyUser                       : the user name of the proxy to use
+            proxyPass                       : the user password of the proxy to use
+            proxyType                       : the proxy type to use (NONE, HTTP, SOCKS4, SOCKS5)
+            login                           : a flag if the user should login to the XMPP account
+            createAccount                   : a flag if an account should be created for unknown users
+            filter                          : implementation of PacketFilter
+            marshaler                       : implementation of XMPPMarshaler to convert XMPP message to NMR message
+    -->
     <xmpp:sender service="replaceMe:serviceName" 
                  endpoint="xmpp-sender"
                  host="my.jabberserver.lan"