You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ode.apache.org by va...@apache.org on 2012/12/10 22:35:57 UTC
svn commit: r1419798 - in /ode/site/trunk/content: jbi-deployment.mdtext
smx4-osgi-deployment.mdtext user-guide.mdtext war-deployment.mdtext
Author: vanto
Date: Mon Dec 10 21:35:56 2012
New Revision: 1419798
URL: http://svn.apache.org/viewvc?rev=1419798&view=rev
Log:
fix formatting.
Modified:
ode/site/trunk/content/jbi-deployment.mdtext
ode/site/trunk/content/smx4-osgi-deployment.mdtext
ode/site/trunk/content/user-guide.mdtext
ode/site/trunk/content/war-deployment.mdtext
Modified: ode/site/trunk/content/jbi-deployment.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/jbi-deployment.mdtext?rev=1419798&r1=1419797&r2=1419798&view=diff
==============================================================================
--- ode/site/trunk/content/jbi-deployment.mdtext (original)
+++ ode/site/trunk/content/jbi-deployment.mdtext Mon Dec 10 21:35:56 2012
@@ -1,23 +1,26 @@
Title: JBI Deployment
+
+## Overview
Here's a quick overview to deploy PXE/ODE on a JBI container (e.g. [ServiceMix](http://servicemix.apache.org))
<a name="JBIDeployment-1)DownloadtheJBIdistribution"></a>
-#### 1) Download the JBI distribution
+## 1) Download the JBI distribution
Check our [download page](getting-ode.html) and get the latest JBI-based distribution. Unzip it in a directory of your choice. We'll now refer to this directory as ODE_HOME.
<a name="JBIDeployment-2)InstallonJBIcontainer"></a>
-#### 2) Install on JBI container
+## 2) Install on JBI container
For example, with ServiceMix you can use file-system deployment:
+ :::text
(from ode/jbi directory)
cp ODE_HOME/ode-jbi-1.1.zip SERVICEMIX_DIR/install
The above will result in ODE being installed with the default settings. You may wish to first modify the `ode-jbi.properties` file found in the root of the installer ZIP.
<a name="JBIDeployment-3)DeployingProcesses"></a>
-#### 3) Deploying Processes
+### 3) Deploying Processes
We are assuming that the reader is familiar with JBI deployment concepts. Deploying a process consists of the following steps:
@@ -33,7 +36,7 @@ We are assuming that the reader is famil
1. Copy the service assembly archive into the appropriate _deploy_ directory
<a name="JBIDeployment-Examples"></a>
-#### Examples
+## Examples
Some JBI examples are available under the _examples_ directory of the ODE distro:
@@ -45,43 +48,46 @@ Extract the distro-jbi-2.0-SNAPSHOT.zip
To compile the examples, you may wish to define the ODE_HOME environment variable. The build script does a good job of figuring this out without ODE_HOME set, however.
-
+ :::text
# On Linux/Unix
export ODE_HOME=/path/to/ode/distribution
-
+
# On Windows
set ODE_HOME=C:\Path\To\ODE\Distribution
and run Ant in the example's directory:
+ ::text
cd %ODE_HOME%/examples/PingPong
ant
This will create a JBI service assembly in the "build" subdirectory. With ServiceMix you can simply copy it to the file-system hot deployment directory:
+ :::text
(from PingPong directory)
cp build/PingPing-sa.zip SERVICEMIX_DIR/deploy
Finally, you can test the example by typing:
+ :::text
(from PingPong directory)
ant test
<a name="JBIDeployment-JBIEndpoints"></a>
-### JBI Endpoints
+## JBI Endpoints
ODE now relies strictly on abstract web service definitions (i.e., without binding/service/port definitions), meaning that you only need abstract WSDLs when compiling processes. Since JBI uses normalized messages (in theory, at least), there is no need to define bindings for the BPEL service engine.
In deploy.xml, you simply define the JBI internal endpoints invoked or provided by your partnerLinks,
-
+ :::xml
<?xml version="1.0" encoding="UTF-8"?>
<deploy xmlns="http://www.apache.org/ode/schemas/dd/2007/03"
xmlns:process="urn:/Ping.bpel"
xmlns:ping="urn:/Ping.wsdl"
xmlns:pong="urn:/Pong.wsdl">
-
+
<process name="process:Ping">
<active>true</active>
<provide partnerLink="PingPartnerLink">
@@ -91,24 +97,24 @@ In deploy.xml, you simply define the JBI
<service name="pong:PongService" port="PongPort"/>
</invoke>
</process>
-
+
</deploy>
One may use JBI binding components to make services externally available and therefore providing concrete bindings to those binding components. An example of exposing process services via SOAP/HTTP can be found in the PingPong [ping-http service unit](http://svn.apache.org/repos/asf/ode/branches/APACHE_ODE_1.X/distro/src/examples-jbi/PingPong/ping-http/).
<a name="JBIDeployment-Database"></a>
-### Database
+## Database
The generated installer will use an internally-managed embedded Derby database. No configuration is required. To use an external database one needs to modify `ode-jbi.properties` found in the component installer zip.
<a name="JBIDeployment-CompatibilityCaveat"></a>
-### Compatibility Caveat
+## Compatibility Caveat
Many binding components are not very good about delivering messages in the correct format for WSDL11 services.
<a name="JBIDeployment-KnownIssueswithServiceMix"></a>
-#### Known Issues with ServiceMix
+### Known Issues with ServiceMix
ServiceMix' so-called _lightweight components_ make it difficult to properly expose process services since they do not fully implement the JBI contract and do not allow the process engine to enquire about its external endpoints.
* SoapHelper needs to properly resolve the WSDL operation name (patch available)
Modified: ode/site/trunk/content/smx4-osgi-deployment.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/smx4-osgi-deployment.mdtext?rev=1419798&r1=1419797&r2=1419798&view=diff
==============================================================================
--- ode/site/trunk/content/smx4-osgi-deployment.mdtext (original)
+++ ode/site/trunk/content/smx4-osgi-deployment.mdtext Mon Dec 10 21:35:56 2012
@@ -1,9 +1,10 @@
Title: SMX4 OSGi Deployment
<a name="SMX4OSGiDeployment-DeployApacheODEOSGibundleandexampleprocess(PingPong)"></a>
-### Deploy Apache ODE OSGi bundle and example process (Ping Pong)
+## Deploy Apache ODE OSGi bundle and example process (Ping Pong)
Enter smx4 console and run following commands:
+ :::text
features:addUrl mvn:org.apache.ode/ode-jbi-karaf/1.3.5-SNAPSHOT/xml/features
features:install ode
features:install examples-ode-ping-pong
@@ -12,29 +13,30 @@ Enter smx4 console and run following com
This will install ODE with default settings (OpenJPA DAO, embedded Derby database)
<a name="SMX4OSGiDeployment-Configuringdatabase"></a>
-### Configuring database
+## Configuring database
-Create SMX4/etc/org.apache.ode.jbi.cfg file with following contents:
+Create `SMX4/etc/org.apache.ode.jbi.cfg` file with following contents:
+ :::text
ode-jbi.pidNamespace=urn:ode-jbi
ode-jbi.allowIncompleteDeployment=false
ode-jbi.messageMapper=org.apache.ode.jbi.msgmap.ServiceMixMapper
ode-jbi.event.listeners=org.apache.ode.bpel.common.evt.DebugBpelEventListener
-
+
#For MySQL
#ode-jbi.db.int.mcf=org.tranql.connector.mysql.XAMCF
#ode-jbi.db.int.mcf.databaseName=ODE
#ode-jbi.db.int.mcf.userName=root
#ode-jbi.db.int.mcf.password=root
#ode-jbi.db.int.mcf.serverName=localhost
-
+
#For Postgres
#ode-jbi.db.int.mcf=org.tranql.connector.postgresql.PGXAMCF
#ode-jbi.db.int.mcf.databaseName=ODE
#ode-jbi.db.int.mcf.userName=postgres
#ode-jbi.db.int.mcf.password=postgres
#ode-jbi.db.int.mcf.serverName=localhost
-
+
#For SQLServer
#ode-jbi.db.int.mcf=org.tranql.connector.sqlserver.XAMCF
#ode-jbi.db.int.mcf.databaseName=ODE
@@ -42,7 +44,7 @@ Create SMX4/etc/org.apache.ode.jbi.cfg f
#ode-jbi.db.int.mcf.password=sa
#ode-jbi.db.int.mcf.portNumber=1433
#ode-jbi.db.int.mcf.serverName=localhost
-
+
#For Oracle
ode-jbi.db.int.mcf=org.tranql.connector.oracle.LocalMCF
ode-jbi.db.int.mcf.databaseName=XE
@@ -51,8 +53,8 @@ Create SMX4/etc/org.apache.ode.jbi.cfg f
ode-jbi.db.int.mcf.portNumber=1521
ode-jbi.db.int.mcf.serverName=localhost
ode-jbi.db.int.mcf.driverType=thin
-
-
+
+
# Uncomment the following to enable hibernate (this is recommended for production use):
#ode-jbi.dao.factory=org.apache.ode.daohib.bpel.BpelDAOConnectionFactoryImpl
@@ -64,21 +66,23 @@ So you need to run following command fro
features:install ode-hib-oracle
-Please note that etc/org.apache.ode.jbi.cfg must be set to the same database (in this case oracle) to load required dependencies properly.
+Please note that `etc/org.apache.ode.jbi.cfg` must be set to the same database (in this case oracle) to load required dependencies properly.
<a name="SMX4OSGiDeployment-Tips"></a>
-### Tips
+## Tips
<a name="SMX4OSGiDeployment-HowtomakePMAPIwork?"></a>
-#### How to make PMAPI work?
+### How to make PMAPI work?
You can grab pmapi SA from here [http://markmail.org/message/ghigpzcpt2j3qnoo](http://markmail.org/message/ghigpzcpt2j3qnoo).
-Then edit SMX4 etc/config.properties and change from:
+Then edit SMX4 `etc/config.properties` and change from:
+ :::text
org.osgi.framework.bootdelegation=sun.*,com.sun*,javax.transaction,javax.transaction.*
to:
+ :::text
org.osgi.framework.bootdelegation=sun.*,com.sun*,javax.transaction,javax.transaction.*,javax.xml.stream,javax.xml.stream.*
Modified: ode/site/trunk/content/user-guide.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/user-guide.mdtext?rev=1419798&r1=1419797&r2=1419798&view=diff
==============================================================================
--- ode/site/trunk/content/user-guide.mdtext (original)
+++ ode/site/trunk/content/user-guide.mdtext Mon Dec 10 21:35:56 2012
@@ -3,7 +3,7 @@ Title: User Guide
<a name="UserGuide-GettingStarted"></a>
## Getting Started
-First of all, getting familiar with the [WS-BPEL 2.0](ws-bpel-2.0.html) standard is a very good idea. To use ODE, you will need to write processes using the BPEL language. There are several examples in our [distributions](getting-ode.html) that you can use to get started, but a decent understanding of the spec is assumed.
+First of all, getting familiar with the [WS-BPEL 2.0](ws-bpel-20.html) standard is a very good idea. To use ODE, you will need to write processes using the BPEL language. There are several examples in our [distributions](getting-ode.html) that you can use to get started, but a decent understanding of the spec is assumed.
Then, you can optionally check out [ODE Schema](ode-schema.html) page in order to install schema for your database. Please note that schemas from distribution sometimes contain errors, because of poor quality of ORM schema generators.
Modified: ode/site/trunk/content/war-deployment.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/war-deployment.mdtext?rev=1419798&r1=1419797&r2=1419798&view=diff
==============================================================================
--- ode/site/trunk/content/war-deployment.mdtext (original)
+++ ode/site/trunk/content/war-deployment.mdtext Mon Dec 10 21:35:56 2012
@@ -1,30 +1,31 @@
Title: WAR Deployment
<a name="WARDeployment-DeployingtheWAR"></a>
-#### Deploying the WAR
+## Deploying the WAR
Unzip the [distribution](getting-ode.html) somewhere on your disk, everything needed is inside.
-Get the WAR file in the distribution root directory, rename it to *ode.war* and copy this file to [Tomcat](http://tomcat.apache.org)'s webapp directory. Start Tomcat and ODE should be up and running. You should get the [Axis2|http://ws.apache.org/axis2] welcome page under [http://localhost:8080/ode]. The ODE WAR includes its own embedded database ([Derby|http://db.apache.org/derby]) so you don't have to worry about configuring any external database for now.
+Get the WAR file in the distribution root directory, rename it to *ode.war* and copy this file to [Tomcat](http://tomcat.apache.org)'s webapp directory. Start Tomcat and ODE should be up and running. You should get the [Axis2](http://ws.apache.org/axis2) welcome page under [http://localhost:8080/ode](http://localhost:8080/ode). The ODE WAR includes its own embedded database ([Derby](http://db.apache.org/derby)) so you don't have to worry about configuring any external database for now.
<a name="WARDeployment-Examples"></a>
-#### Examples
+### Examples
Copy the content of the _examples_ directory in the distribution (the 3 sub-directories) to _tomcat/webapps/ode/WEB-INF/processes_, this will automatically deploy the 3 example processes. Use the sendsoap command located in the distribution _bin_ directory to send test messages. The messages to run each of the 3 examples are provided in their respective directory (testRequest.soap). For each example type something like:
-
+ :::text
bin/sendsoap http://localhost:8080/ode/processes/helloWorld examples/HelloWorld2/testRequest.soap
The *sendsoap* executable can be found in the distribution _bin_ directory. The urls should be updated according to the address defined in the WSDL file for the process service.
<a name="WARDeployment-ConfiguringODEinTomcatwithaMySQLdatabase"></a>
-#### Configuring ODE in Tomcat with a MySQL database
+### Configuring ODE in Tomcat with a MySQL database
The ODE war should have been copied to the _webapps_ directory of Tomcat and the server should have been started at least once before following these instructions. This ensures that the webapp is properly exploded.
1. Drop the MySQL JDBC driver ([MySQL Connector/J](http://dev.mysql.com/downloads/#connector-j)) in the _common/lib_ directory of Tomcat.
1. Add the following stanza to _conf/server.xml_ inside the <Host> element:
+ :::xml
<Context path="/ode" docBase="ode" debug="5" reloadable="true" crossContext="true">
<Resource name="jdbc/ODEDB" auth="Container" type="javax.sql.DataSource"
maxActive="100" maxIdle="30" maxWait="10000"
@@ -34,6 +35,7 @@ The ODE war should have been copied to t
1. Make sure that MySQL is started and the [ODE schema](^ode_openjpa_mysql-1.3.2.sql.html) has been loaded in a _ode_ database.
+ :::text
$ mysql -u root
mysql> create database ode;
mysql> exit
@@ -41,18 +43,19 @@ The ODE war should have been copied to t
1. Add a file named _ode-axis2.properties_ under _webapps/ode/WEB-INF/conf_ with the following content:
- ode-axis2.db.mode=EXTERNAL
- ode-axis2.db.ext.dataSource=java:comp/env/jdbc/ODEDB
+ :::text
+ ode-axis2.db.mode=EXTERNAL
+ ode-axis2.db.ext.dataSource=java:comp/env/jdbc/ODEDB
You're done\!
<a name="WARDeployment-ConfiguringODEinJBosswithJNDIEXTERNALdatasource"></a>
-#### Configuring ODE in JBoss with JNDI EXTERNAL datasource
+## Configuring ODE in JBoss with JNDI EXTERNAL datasource
Create ode/WEB-INF/conf/ode-axis2.properties with following content:
-
+ :::text
#Uncomment for using dao hibernate
#ode-axis2.dao.factory=org.apache.ode.daohib.bpel.BpelDAOConnectionFactoryImpl
ode-axis2.db.mode=EXTERNAL