You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by ge...@apache.org on 2010/10/31 11:13:35 UTC
svn commit: r1029292 - in /servicemix/documentation/trunk: ./
src/main/scripts/ src/main/webapp/commands/ src/main/webapp/jbi/components/
Author: gertv
Date: Sun Oct 31 10:13:35 2010
New Revision: 1029292
URL: http://svn.apache.org/viewvc?rev=1029292&view=rev
Log:
Allow for XBean-generated wiki docs to be included when necessary
Added:
servicemix/documentation/trunk/src/main/scripts/
servicemix/documentation/trunk/src/main/scripts/GenerateComponentDocs.scala
Modified:
servicemix/documentation/trunk/pom.xml
servicemix/documentation/trunk/src/main/webapp/commands/toc.ssp
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-bean.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-bc.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-se.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-drools.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-eip.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-file.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-ftp.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-http.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-jms.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-mail.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-osworkflow.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-quartz.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-saxon.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-scripting.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-snmp.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-validation.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-vfs.conf
servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-xmpp.conf
Modified: servicemix/documentation/trunk/pom.xml
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/pom.xml?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/pom.xml (original)
+++ servicemix/documentation/trunk/pom.xml Sun Oct 31 10:13:35 2010
@@ -51,6 +51,7 @@
<scalate.mode>production</scalate.mode>
<scalate.workdir>${basedir}/target/scalateWorkDir</scalate.workdir>
+ <components.version>2010.02-SNAPSHOT</components.version>
<karaf.version>2.1.99-SNAPSHOT</karaf.version>
<servicemix.version>4.3.0-SNAPSHOT</servicemix.version>
</properties>
@@ -78,6 +79,134 @@
<version>1.6.0</version>
</dependency>
+ <!-- ensure that the components are available in the local repo -->
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-bean</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-cxf-bc</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-cxf-se</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-drools</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-eip</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-file</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-ftp</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-http</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-jms</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-mail</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-osworkflow</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-quartz</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-saxon</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-scripting</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-snmp</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-validation</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-vfs</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-xmpp</artifactId>
+ <version>${components.version}</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
@@ -94,10 +223,22 @@
<version>2.14.1</version>
<executions>
<execution>
+ <id>compile</id>
<goals>
<goal>compile</goal>
</goals>
</execution>
+ <execution>
+ <id>generate-components-docs</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>script</goal>
+ </goals>
+ <configuration>
+ <includeScopes>plugin</includeScopes>
+ <scriptFile>src/main/scripts/GenerateComponentDocs.scala</scriptFile>
+ </configuration>
+ </execution>
</executions>
</plugin>
Added: servicemix/documentation/trunk/src/main/scripts/GenerateComponentDocs.scala
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/scripts/GenerateComponentDocs.scala?rev=1029292&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/scripts/GenerateComponentDocs.scala (added)
+++ servicemix/documentation/trunk/src/main/scripts/GenerateComponentDocs.scala Sun Oct 31 10:13:35 2010
@@ -0,0 +1,83 @@
+/**
+ * Copyright (C) 2009-2010 the original author or authors.
+ * See the notice.md file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * 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.
+ */
+import io.Source
+import java.io.{PrintWriter, File}
+import java.net.{URI}
+import java.util.jar.JarFile
+
+val outputDirectory = new File("target/webapp/jbi/components")
+lazy val version = project.getProperties.get("components.version").asInstanceOf[String]
+
+def run() = {
+ outputDirectory.mkdirs
+
+ Array("servicemix-bean", "servicemix-cxf-bc", "servicemix-cxf-se",
+ "servicemix-drools", "servicemix-eip", "servicemix-file",
+ "servicemix-ftp", "servicemix-http", "servicemix-jms",
+ "servicemix-mail", "servicemix-osworkflow", "servicemix-quartz",
+ "servicemix-saxon", "servicemix-scripting", "servicemix-snmp",
+ "servicemix-validation", "servicemix-vfs", "servicemix-xmpp").foreach(generateDocumentation)
+}
+
+def generateDocumentation(component: String) {
+ val wiki = component + ".xsd.wiki"
+ log.info("Reading %s(%s)".format(jar(component).getAbsolutePath, wiki))
+
+ val file = new JarFile(jar(component))
+ val entry = file.getEntry(component + ".xsd.wiki")
+
+ if (entry == null) {
+ log.warn("No wiki file found in %s, skipping component %s".format(file, component))
+ } else {
+ findElement(component,
+ Source.fromInputStream(file.getInputStream(entry)).getLines.toSeq)
+ }
+}
+
+def findElement(component: String, lines: Seq[String]) : Unit = {
+ val startsAtElement = lines.dropWhile(line => !(line.startsWith("{anchor:") && line.endsWith("-element}")))
+
+ if (!startsAtElement.isEmpty) {
+ val name = startsAtElement.head.drop(8).replace("-element}", "")
+
+ val (element, remaining) = startsAtElement.span(line => !line.trim.isEmpty)
+
+ writeElementDocs(component, name, element)
+ findElement(component, remaining)
+ }
+}
+
+def writeElementDocs(component: String, name: String, lines: Seq[String]) {
+ val file = new File(outputDirectory, "_%s-%s.conf".format(component, name))
+ log.info("... creating " + file.getAbsolutePath)
+
+ val writer = new PrintWriter(file)
+
+ try {
+ for (line <- lines.map(_.trim).dropWhile(!_.startsWith("|"))) {
+ writer.println(line)
+ }
+ writer.flush
+ } finally {
+ writer.close
+ }
+}
+
+def jar(component: String) = new File(
+ new URI("%s/org/apache/servicemix/%s/%s/%2$s-%3$s.jar".format(
+ session.getLocalRepository.getUrl, component, version)))
Modified: servicemix/documentation/trunk/src/main/webapp/commands/toc.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/commands/toc.ssp?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/commands/toc.ssp (original)
+++ servicemix/documentation/trunk/src/main/webapp/commands/toc.ssp Sun Oct 31 10:13:35 2010
@@ -1,4 +1,5 @@
<!-- TODO: generate this file automatically, this is just a subset of the available commands for demo purposes -->
+<% %>
<ul>
<li id="comfig-commands">
<a href="#">Using ConfigAdmin</a>
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-bean.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-bean.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-bean.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-bean.conf Sun Oct 31 10:13:35 2010
@@ -4,7 +4,7 @@ h3. Overview
The ServiceMix Bean component provides integration with beans (POJOs) with the JBI bus to make it easy to use POJOs to process JBI message exchanges. Like in an Message Driven Bean in J2EE a POJO will receive a message from the NMR and process it in any way it likes. Unlike in a JMS component where the coding is already done the Bean component gives the developer the freedom to create any type of message handling but it must be hand coded all the way.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/bean/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/bean/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:bean="http://servicemix.apache.org/bean/1.0">
@@ -18,6 +18,9 @@ The servicemix-bean component only defin
h3. {{Endpoint bean:endpoint}}
+h4. Endpoint properties
+{include:jbi/components/_servicemix-bean-endpoint.conf}
+
h4. Using a Java class
When definining a {{bean:endpoint}} specifying a Java class name, a new instance of this class will be created for handling a single message exchange.
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-bc.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-bc.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-bc.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-bc.conf Sun Oct 31 10:13:35 2010
@@ -16,7 +16,7 @@ The main features are:
* WS-Addressing support
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/cxfbc/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/cxfbc/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:cxfbc="http://servicemix.apache.org/cxfbc/1.0">
@@ -30,3 +30,12 @@ The servicemix-cxf-bc component defines
- {{cxfbc:consumer}} :: a server-side cxf endpoint that will consume plain HTTP+SOAP requests and send them into the NMR to a given JBI endpoint
- {{cxfbc:provider}} :: a client-side jbi endpoint which can receive requests from the NMR and send them to a given url where the service is provided
+h3. {{cxfbc:consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-cxf-bc-consumer.conf}
+
+h3. {{cxfbc:provider}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-cxf-bc-provider.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-se.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-se.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-se.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-cxf-se.conf Sun Oct 31 10:13:35 2010
@@ -12,7 +12,7 @@ Features:
* MTOM / attachments support
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/cxfse/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/cxfse/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:cxfse="http://servicemix.apache.org/cxfse/1.0">
@@ -25,3 +25,14 @@ h4. Endpoint types
The servicemix-cxf-bc component defines one endpoint type:
- {{cxfse:endpoint}} :: no description yet
+h3. {{cxfse:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-cxf-se-endpoint.conf}
+
+h3. {{cxfbc:proxy}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-cxf-se-proxy.conf}
+
+
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-drools.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-drools.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-drools.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-drools.conf Sun Oct 31 10:13:35 2010
@@ -8,7 +8,7 @@ This Service Engine can be used to deplo
A router will mostly act as a transparent proxy between the consumer and the target service provider mad will mostly be implemented by the jbi.route(uri) method below. This method creates a new exchange identical to the one received by the component and will send it to the specified destination. You can also send back a Fault if needed. A router can also be implemented by using directly the JBI Apis (available with the jbi helper) by using the provided client.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/drools/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/drools/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:drools="http://servicemix.apache.org/drools/1.0">
@@ -21,3 +21,9 @@ h4. Endpoint types
The servicemix-drools component defines one endpoint type:
- {{drools:endpoint}} :: no description yet
+h3. {{drools:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-drools-endpoint.conf}
+
+
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-eip.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-eip.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-eip.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-eip.conf Sun Oct 31 10:13:35 2010
@@ -5,7 +5,7 @@ The servicemix-eip component is a routin
This component is based on the great Enterprise Integration Patterns book.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/eip/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/eip/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:drools="http://servicemix.apache.org/eip/1.0">
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-file.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-file.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-file.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-file.conf Sun Oct 31 10:13:35 2010
@@ -5,7 +5,7 @@ The ServiceMix File component provides J
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/file/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/file/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:file="http://servicemix.apache.org/file/1.0">
@@ -19,3 +19,12 @@ The servicemix-file component defines tw
- {{file:poller}} :: Periodically polls a directory for files and sends an exchange for every file
- {{file:sender}} :: Writes the contents of an exchange to a file
+h3. {{file:poller}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-file-poller.conf}
+
+h3. {{file:sender}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-file-sender.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-ftp.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-ftp.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-ftp.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-ftp.conf Sun Oct 31 10:13:35 2010
@@ -5,7 +5,7 @@ The ServiceMix FTP component provides JB
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/ftp/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/ftp/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:ftp="http://servicemix.apache.org/ftp/1.0">
@@ -19,3 +19,12 @@ The servicemix-ftp component defines two
- {{ftp:poller}} :: Periodically polls a directory on an FTP server for files and sends an exchange for every file
- {{ftp:sender}} :: Writes the contents of an exchange to a file on an FTP server
+h3. {{ftp:poller}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-ftp-poller.conf}
+
+h3. {{ftp:sender}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-ftp-sender.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-http.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-http.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-http.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-http.conf Sun Oct 31 10:13:35 2010
@@ -19,7 +19,7 @@ Here are the main features:
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/http/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/http/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:http="http://servicemix.apache.org/http/1.0">
@@ -39,3 +39,27 @@ The servicemix-http component defines fo
It also provides one additional legacy endpoints, which are still available to ease migration from ServiceMix 3:
- {{http:endpoint}} :: (Deprecated) Legacy endpoint, capable to acting as a consumer or provider based on the configuration
+h3. {{http:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-http-endpoint.conf}
+
+h3. {{http:consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-http-consumer.conf}
+
+h3. {{http:provider}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-http-provider.conf}
+
+h3. {{http:soap-consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-http-soap-consumer.conf}
+
+h3. {{http:soap-provider}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-http-soap-provider.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-jms.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-jms.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-jms.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-jms.conf Sun Oct 31 10:13:35 2010
@@ -1,4 +1,4 @@
-h2. servicemix-http
+h2. servicemix-jms
h3. Overview
ServiceMix ships with a JBI compliant JMS binding component named servicemix-jms.
@@ -14,7 +14,7 @@ Here are the main features:
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/jms/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/jms/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:jms="http://servicemix.apache.org/jms/1.0">
@@ -36,3 +36,33 @@ The servicemix-jms component defines six
It also provides one additional legacy endpoints, which are still available to ease migration from ServiceMix 3:
- {{jms:endpoint}} :: (Deprecated) Legacy endpoint, capable to acting as a consumer or provider based on the configuration
+
+h3. {{jms:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-jms-endpoint.conf}
+
+h3. {{jms:consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-jms-consumer.conf}
+
+h3. {{jms:provider}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-jms-provider.conf}
+
+h3. {{jms:soap-consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-jms-soap-consumer.conf}
+
+h3. {{jms:soap-provider}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-jms-soap-provider.conf}
+
+h3. {{jms:jca-consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-jms-jca-consumer.conf}
\ No newline at end of file
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-mail.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-mail.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-mail.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-mail.conf Sun Oct 31 10:13:35 2010
@@ -5,7 +5,7 @@ he ServiceMix Mail component provides su
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/mail/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/mail/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:mail="http://servicemix.apache.org/mail/1.0">
@@ -19,3 +19,12 @@ The servicemix-mail component defines tw
- {{mail:poller}} :: Connect to a POP3 or IMAP server and send a MessageExchange for every mail
- {{mail:sender}} :: Connect to an SMTP server and send a mail for every JBI MessageExchange it receives
+h3. {{mail:poller}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-mail-poller.conf}
+
+h3. {{mail:sender}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-mail-sender.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-osworkflow.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-osworkflow.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-osworkflow.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-osworkflow.conf Sun Oct 31 10:13:35 2010
@@ -5,7 +5,7 @@ The ServiceMix OSWorkflow component prov
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/osworkflow/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/osworkflow/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:osworkflow="http://servicemix.apache.org/osworkflow/1.0">
@@ -18,3 +18,7 @@ h4. Endpoint types
The servicemix-osworkflow component defines a single endpoint type:
- {{osworkflow:endpoint}} :: The endpoint will receive messages from the NMR and will then start the processing of the workflow.
+h3. {{osworkflow:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-osworkflow-endpoint.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-quartz.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-quartz.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-quartz.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-quartz.conf Sun Oct 31 10:13:35 2010
@@ -4,7 +4,7 @@ h3. Overview
The servicemix-quartz component is a standard JBI Service Engine able to schedule and trigger jobs using the great Quartz scheduler.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/quartz/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/quartz/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:osworkflow="http://servicemix.apache.org/quartz/1.0">
@@ -17,3 +17,7 @@ h4. Endpoint types
The servicemix-quartz component defines a single endpoint type:
- {{quartz:endpoint}} :: The quartz endpoint can be used to fire message exchanges at a given (recurrent) time.
+h3. {{quartz:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-quartz-endpoint.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-saxon.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-saxon.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-saxon.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-saxon.conf Sun Oct 31 10:13:35 2010
@@ -27,6 +27,9 @@ The XSLT endpoint can be used to apply a
resource="classpath:transform.xsl" />
{pygmentize}
+h4. Endpoint properties
+{include:jbi/components/_servicemix-saxon-xslt.conf}
+
h4. Mandatory properties
The endpoint requires one of these two properties to be specified:
|| Attribute || Type || description ||
@@ -66,6 +69,9 @@ One common use case is the need to trans
</saxon:proxy>
{pygmentize}
+h4. Endpoint properties
+{include:jbi/components/_servicemix-saxon-proxy.conf}
+
h4. Mandatory properties
Depending on the MEP, you have to set one or more XSL stylesheets to be used for converting the message payloads:
|| Attribute || Type || Description ||
@@ -92,6 +98,9 @@ The XQuery endpoint can be used to apply
resource="classpath:query.xq" />
{pygmentize}
+h4. Endpoint properties
+{include:jbi/components/_servicemix-saxon-xquery.conf}
+
h4. Mandatory properties
You need to specify one of {{query}}, {{resource}} or {{expression}}
|| Attribute || Type || Description ||
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-scripting.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-scripting.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-scripting.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-scripting.conf Sun Oct 31 10:13:35 2010
@@ -9,7 +9,7 @@ The component is currently shipping with
* Rhino JavaScript (1.7R1)
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/scripting/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/scripting/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:scripting="http://servicemix.apache.org/scripting/1.0">
@@ -22,3 +22,7 @@ h4. Endpoint types
The servicemix-scripting component defines a single endpoint type:
- {{scripting:endpoint}} :: The scripting endpoint can be used to use scripts to handle exchanges or send new exchanges
+h3. {{scripting:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-scripting-endpoint.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-snmp.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-snmp.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-snmp.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-snmp.conf Sun Oct 31 10:13:35 2010
@@ -4,7 +4,7 @@ h3. Overview
The ServiceMix SNMP component provides support for receiving SNMP events via the enterprise service bus by using the SNMP4J library.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/snmp/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/snmp/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:snmp="http://servicemix.apache.org/snmp/1.0">
@@ -18,3 +18,13 @@ The servicemix-snmp component defines tw
- {{snmp:poller}} :: Periodically polls a device status using SNMP and sends the OIDs as a JBI MessageExchange
- {{snmp:trap-consumer}} :: Consumes an SNMP trap message and sends the OIDs as a JBI MessageExchange
+
+h3. {{snmp:poller}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-snmp-poller.conf}
+
+h3. {{vfs:trap-consumer}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-snmp-trap-consumer.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-validation.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-validation.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-validation.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-validation.conf Sun Oct 31 10:13:35 2010
@@ -4,7 +4,7 @@ h3. Overview
The ServiceMix Validation component provides schema validation of documents using JAXP 1.3 and XMLSchema or RelaxNG.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/validation/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/validation/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:scripting="http://servicemix.apache.org/validation/1.0">
@@ -17,3 +17,7 @@ h4. Endpoint types
The servicemix-validation component defines a single endpoint type:
- {{validation:endpoint}} :: Validates the incoming XML message - can be configured to fail the exchange or to send validation errors back to the sender in the message body.
+h3. {{validation:endpoint}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-validation-endpoint.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-vfs.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-vfs.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-vfs.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-vfs.conf Sun Oct 31 10:13:35 2010
@@ -4,7 +4,7 @@ h3. Overview
The ServiceMix VFS component provides support for reading from and writing to virtual file systems via the enterprise service bus by using the Apache commons-vfs library.
h4. Namespace and xbean.xml
-The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/vfs/1.0}}. This is an example of <filename>xbean.xml</filename> file with a namespace definition with prefix {{bean}}.
+The namespace URI for the servicemix-bean JBI component is {{http://servicemix.apache.org/vfs/1.0}}. This is an example of an {{xbean.xml}} file with a namespace definition with prefix {{bean}}.
{pygmentize:lang=xml}
<beans xmlns:vfs="http://servicemix.apache.org/vfs/1.0">
@@ -18,3 +18,12 @@ The servicemix-vfs component defines two
- {{vfs:poller}} :: Periodically polls a directory on one of the VFS-supported file systems for files and sends an exchange for every file
- {{vfs:sender}} :: Writes the contents of an exchange to a file on one of the VFS-supported file systems
+h3. {{vfs:poller}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-vfs-poller.conf}
+
+h3. {{vfs:sender}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-vfs-sender.conf}
Modified: servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-xmpp.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-xmpp.conf?rev=1029292&r1=1029291&r2=1029292&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-xmpp.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/jbi/components/servicemix-xmpp.conf Sun Oct 31 10:13:35 2010
@@ -4,3 +4,13 @@ h3. Overview
The ServiceMix XMPP component is used to communicate with XMPP (Jabber) servers through the JBI bus.
+
+h3. {{xmpp:receiver}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-xmpp-receiver.conf}
+
+h3. {{xmpp:sender}}
+
+h4. Endpoint properties
+{include:jbi/components/_servicemix-xmpp-sender.conf}