Introduction

This HOW TO describes how to quickly start using SOPERA on a Mac. Basically the SOPERA ASF is not certified for use on the Mac OS X, and you will not find a suitable installation bundle for Mac. However, as any well-written Java-based software it works quite well under Mac OS X. You just need to find a way to install it there :)

What you need to get started

Basically here is the list of software you need to have in order to run SOPERA on Mac OS X Snow Leopard (tested on 10.6.3 and Java 1.6.0_20 64-Bit Server VM)

• Java 5 or 6. Since you are using Mac I assume you already have it.
• SOPERA ASF 3.3 Linux Distribution; you can download it from here. You can also download an ISO image that contains everything (Windows and Linux distribution).
• Eclipse JEE Package Galileo; you can download it from eclipse.org. More about SOPERA Tooling installation on Mac you can read in MacQuickStartTooling.

What we are going to do next

To keep your installation simple I suggest that you only install SOPERA ASF 3.3 SBB locally on your Mac and leave the whole infrastructure services running elsewhere. As you know SOEPRA ASF is a distributed ESB where each participant is running on its own host. Each participant uses a little piece of software that connects it to a distributed ESB, this piece of software is what we call ServiceBackbone or in short SBB. To coordinate the distributed participants we have a centralized infrastructure which itself is represented by 4 dedicated participants, also known as Technical Service Providers (TSPs). These TSPs are responsible for different tasks, for example, authenticating participants, providing a routing information, authorizing participant operations, etc.

So in this HOW TO we are going to install only the SBB on your Mac, however you can also install full Infrastructure installation on your mac the same way as described here.

Install SOPERA SBB

For installation of SOPERA SBB we are going to use the standard SOPERA Unix installer, open Terminal and extract downloaded Linux distribution of SOPERA (or if you mounted the SOPERA ASF ISO just copy the Binaries/unix/ to some folder). For me it would be ~/tmp/SOPERA33/.

tar -xvf RuntimeFramework_3.3.0_B001.tar_01.gz 
cd RuntimeFramework/Binaries/unix/SOPinstall/bin
chmod u+x *

So, now you are ready to start our installer for instance, you can start in interactive mode. However, before doing that you need to fix one little issue in the deployment_lib.sh file that prevents the installer from working properly on Mac OS X. You can either patch the file on your disk using this patch or just replace the existing deployment_lib.sh with already patched version.

Snow Leopard Users with Java6 should install the other patch. It contains patched versions of Apache Open DS ZIP archive, patched Deployment/bin/install_tomcat.sh script as well as deployment_lib.sh (fixed issues are ESB-324, ESB-323 and ESB-315).

cp deployment_lib.sh deployment_lib.sh.backup
patch deployment_lib.sh < deployment_lib.sh.patch 

Now you are ready to start the SOPERA installer in interactive mode:

./sopinstall.sh -i

You will need to answer on couple of questions:

Select the type of Installation
* SOPERA Participant Server (P)
* SOPERA Infrastructure Server (I)
* SOPERA Additional Components (A)

You need to answer P - SOPERA Participant Server.

Specify the SOPERA home directory where SOPERA Participant should be installed.
SOPW_HOME [/Users/zubairov/opt/SOPera]

You need to specify where you would like to install SOPERA SBB. Please note: you have to have the write permissions for this directory or it's parent to create it. WARNING: specify directory name without the slash on the end.

The installation directory will be /Users/zubairov/opt/SOPera. Continue (Y/N)
proceed [Y]: Y

Select the SOPERA components to be installed.
You can choose multiple components one by one.
You can select all the components with (L).
You can clear and restart the selection with (C).
You can end the selection and continue with (E).
* ResourceAdapter (R) 
* Tomcat (T) 

Select all with (L)
Clear selection with (C)
End selection with (E)

Here you need to select the Tomcat by entering T and then end the selection by entering E.

The installation prepares a Tomcat for a business participant. This Tomcat would use ports x8480 for http and x8843 for https.
Specify the value for x within range (1..5).
portPattern [1]: 

The default value is good enough. Accept 1.

Specify the hostname of SOPERA infrastructure.
SOPW_INFRA_HOST [infrahost]: 

This is an interesting part, I recommend that you simply specify some alias here sopinfra we will define this alias later using /etc/hosts file.

pecify the port range used by SOPERA infrastructure.
portPattern [1]: 

Default value is good enough. Accept 1.

Specify the hostname used by the directory server for SOPERA infrastructure.
SOPW_LDAP_HOST [sopinfra]: 

Specify the port used by the directory server for SOPERA infrastructure.
SOPW_LDAP_PORT [389]: 

Specify the fully qualified root DN for the SOPERA data structure in the directory server.
If the node o=SOPware itself is the root DN, do not specify any value.
ldapRootDn []: 

Accept the default values.

Specify the Java directory to be used by SOPERA.
SOPW_DEPL_JAVA_DETECTED []: 

You need to specify here where your JAVA_HOME is, on Mac OS X it's usually /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home/.

Do you want to execute the installation (X) or generate a response file (G)?
mode [X]: 

Now you can just enter X and the installation will start right away. However, the beauty of SOPERA installers is that all the values you specified can be stored in a so-called Response File. Later on you can just re-use the response file to reinstall everything with the same configuration on a different host, by typing:

./sopinstall.sh -r SOPERA.response

After the installation is successfully completed you will see something like this:

Info:  * end finalize /Users/zubairov/SOPera/TSPDetector/install/scripts/finalize.epm
Info:  ************************************************************
Info:  ./sopinstall.sh done Tue Apr 13 14:20:21 CEST 2010

Configure SOPERA Infrastructure Alias

Each installation of SOPERA SBB is pre-configured to one particular infrastructure. The distributed nature of the ESB gives us a lot of flexibility, however this flexibility always comes with an additional configuration overhead. The installer assumes that all 4 of SOPERA Infrastructure services are running on the same host, however what we entered was not a real host name but simply an alias sopinfra. The advantage of using an alias is that we could easily target our SBB instance to a different infrastructure by modifying the alias into IP binding. For that purpose we are going to edit /etc/hosts file. Please note that you have to be root to do this.

To add an alias to your /etc/hosts file use your favorite text editor and add the following line:

192.168.150.215 sopinfra # SOPERA SBB Alias

Where the 192.168.150.215 is an IP where your infrastructure server is running.

Test your installation

That's it, now you are done with installation. Let's start the Tomcat to see whether we did everything right. Go to your SOPW_HOME and do the following (Note: I'm using bash):

cd ~/SOPera/
source ./sopera_environment.sh 

Now you can use pre-defined aliases for bash (Note: make sure your remote infrastructure is up and running):

sophelp
showall
tspping

You can start a specially-configured Tomcat server instance.

starttombiz

As well as tail log from business tomcat

logtombiz

Done!

Oh, and by the way, from now on you can use your SOPERA SBB for developing Java participants by simply specifying -Dorg.sopware.sbb.home=/Your/SOP_HOME/ServiceBackbone as a JVM parameter when running your Java code, but that would be the topic of the next HOW TO. Please comment on this post if you would like to see it here :)

And on how to install the SOEPRA Tooling on Mac you can read in MacQuickStartTooling.

Appendix

To complete your installation it would also be nice to install the command line Admin Tool. You can do it using the same sopinstall.sh script, just select "Additional components" and then "Admin Tool", as shown here:

Info:  Existing SOPERA environment variables have been cleared.

-------------------------
The next page displays the Eclipse Public License (EPL). Use (F) or (B) to scroll the License Agreement.
To exit the display of the license agreement, type (Q).

To read the license agreement, type (R).
If you agree, type (Y).
If you disagree, type (N).
----------------------

agreement []: Y
Info:  Performing installation in interactive mode.

Select the type of Installation
* SOPERA Participant Server (P)
* SOPERA Infrastructure Server (I)
* SOPERA Additional Components (A)

instType [P]: A
Info:  Performing additional components installation.

Specify the SOPERA home directory where additional SOPERA components should be installed.
SOPW_HOME [/Users/zubairov/opt/SOPera]: /Users/zubairov/SOPera

The installation directory will be /Users/zubairov/SOPera. Continue (Y/N)
proceed [Y]: 
...

Select the additional SOPERA components to be installed.
You can choose multiple components one by one.
You can clear and restart the selection with (C).
You can end the selection and continue with (E).
* ResourceAdapter (R) 
* AdminTool (A)
* NagiosIntegration (N)
* HypericPlugin (H) 

Clear selection with (C)
End selection with (E)

selection [R]: A

Info:  ************************************************************
Info:  Currently selected components are:  AdminTool
Info:  ************************************************************

Select the additional SOPERA components to be installed.
You can choose multiple components one by one.
You can clear and restart the selection with (C).
You can end the selection and continue with (E).
* ResourceAdapter (R) 
* AdminTool (A)
* NagiosIntegration (N)
* HypericPlugin (H) 

Clear selection with (C)
End selection with (E)

selection [R]: E