Enhydra Enterprise Server Configurator

Slobodan Vujasinovic


Table of Contents

1. Introduction
2. Running the Enhydra Enterprise Configurator
3. Configuration Options
Connectors
Carol
Services
Administrator
Java
Enhydra Base
Output
Configure and Close Buttons

Chapter 1. Introduction

The Enhydra Enterprise Configurator is a swing based application with a friendly graphical user interface. It is developed with purpose to enable simple and reliable Enhydra Enterprise Server (post-install) configuration.

Enhydra Enterprise Configurator is completely JAVA based and, therefore, supports all operating systems supported by Enhydra Enterprise Server itself. Main reason for development of such tool is to offer Enhydra Enterprise Windows setup functionality to "other platform" users. Additionally, it enables users to (as easy as it gets) create fully functional and pre-configured 'JONAS_BASE' instances on local file system. This way you are able to have one (and only one) Enhydra Server installation ('JONAS_ROOT' instance) and multiple Enhydra Enterprise Server configurations ('JONAS_BASE' instances).

Lets get introduced with those directory concepts ('JONAS_ROOT' and 'JONAS_BASE'). Please note that we will try just to explain basics of 'JONAS_ROOT' and 'JONAS_BASE' directory logic and purpose (for further informations regarding this issue please consult JOnAS Documentation).

  • JONAS_ROOT: This environment variable indicates the location of the root Enhydra Enterprise Multiserver (JOnAS-Tomcat or JOnAS-Jetty) install directory. This is where Enhydra Enterprise (JOnAS-Tomcat or JOnAS-Jetty) can find the main scripts, system jar files, etc.

    Inner directory structure should contain:

    • 'bin' directory - contains executable's (bach/shell script files)

      The scripts were designed with the following in mind:

      • To be called both from the command line and during OS initialization and shutdown.

      • To set the appropriate environment variables.

      • To start the processes running.

    • 'lib' directory - contains server and common implementation (binaries) loaded on server startup.

    • 'enhydra' directory - contains EAF and Enhydra Tool (DODS, Octorpus, etc.) binaries, configuration files and startup scripts.

    • 'templates' directory - JOnAS Tool templates.

    • 'xml' directory - XML Schema and DTD files.

  • JONAS_BASE: When running multiple instances of Enhydra Enterprise Multiserver (JOnAS-Tomcat or JOnAS-Jetty) this variable indicates where the root location of one of the instances. This is so Enhydra Enterprise (JOnAS-Tomcat or JOnAS-Jetty) can find instance configuration information, temporary file locations, etc. When you have a single instance of Enhydra Enterprise Multiserver (JOnAS-Tomcat or JOnAS-Jetty) it is typically the same as $JONAS_ROOT.

    Inner directory structure should contain:

    • 'apps' directory - deployment directory for '.ear' files

    • 'clients' directory - deployment directory for '.jar' client files

    • 'conf' directory - server configuration files

    • 'ejbjars' directory - deployment directory for ejb '.jar' files

    • 'lib' directory:

      • apps - binaries that will be loaded by 'application class loader'

      • ext - binaries that will be loaded by 'commons class loader'

      • tools - binaries that will be loaded by 'tools class loader'

    • 'logs' directory - contains server log files

    • 'rars' directory - deployment directory for '.rar' files

    • 'webapps' directory - web application ('.war' files) deployment directory.

Chapter 2. Running the Enhydra Enterprise Configurator

As we already mentioned, Enhydra Enterprise Configurator is swing based application! It can be started trough 'configurator' batch/shell script file placed in '<enhydra_enterprise_root>/multiserver/enhydra/bin' directory.

To initiate Enhydra Enterprise Configurator just 'cd' to '<enhydra_enterprise_root>/multiserver/enhydra/bin' directory and issue next command:

  • Linux

    ./configurator
  • Windows

    configurator.bat

NOTE: If Enhydra Enterprise Server installation process is properly executed, you should have '<enhydra_enterprise_root>/multiserver/enhydra/bin' directory added in your PATH environment variable. Therefore, 'configurator' command should be automatically recognized by the system (you don't have to 'cd' to executables directory). Additionally, if enhydra is installed trough setup process (recommended for Windows operating systems), you can start Enhydra Enterprise Configurator trough Enhydra Enterprise Server section in 'Start -> Programs' menu.

Hopefully, Enhydra Enterprise Configurator Dialog will appear in front of you and we are ready to start with (re)configuration process!

Chapter 3. Configuration Options

At this stage we want to point out that Enhydra Enterprise Configurator is nothing else than swing based application developed with purpose to enable user friendly way to collect parameter entries that are transferred to configuration batch/shell script files (configure and configureBase) placed in '<enhydra_enterprise_root>/multiserver/enhydra' directory.

To start Enhydra Enterprise Server (re)configuration process just 'cd' to '<enhydra_enterprise_root>/multiserver/enhydra' directory and issue next command:

  • Linux

    ./configure
  • Windows

    configure.bat

This configuration batch/script file can accept number of configuration parameters that are explained (in more detail) in 'README.txt' file placed in '<enhydra_enterprise_root>/multiserver' directory.

To create pre-configured JONAS_BASE directory just 'cd' to '<enhydra_enterprise_root>/multiserver/enhydra' directory and issue next command:

  • Linux

    ./configureBase
  • Windows

    configureBase.bat

This configuration batch/script file can accept number of configuration parameters that are explained (in more detail) in 'README.txt' file placed in '<enhydra_enterprise_root>/multiserver' directory. In addition to 'configure' script, 'configureBase' can accept one additional parameter

  • base.dir - parameter value is pointing to directory which will become new JONAS_BASE instance.

Now, everything that Enhydra Enterprise Configurator is doing is actually collecting those parameter settings and transferring them to one of those two executable configuration scripts (depending on parameter settings).

Connectors

Here you can define connector set that will be initialized on next Enhydra Enterprise (JOnAS-Tomcat or JOnAS-Jetty) Server startup. The user is actually able to enable or disable configuration of every initially introduced connector type and additionally tune connector port parameter setting.

Carol

Here you can aditionally tune port parameter for Carol RMI/JRMP protocol.

Services

Here you can define services set that will be initialized on next Enhydra Enterprise (JOnAS-Tomcat or JOnAS-Jetty) Server startup.The user is actually able to enable or disable service of every introduced service type.

Administrator

Here you can define server administrator user setting.

Java

Here you can define server Java environment.

Enhydra Base

Here you can chose weather to define new JONAS_BASE directory (or just to adapt existing JONAS_BASE configuration). Service name entry should be specific (unique) for every separate JONAS_BASE instance. Path to JONAS_BASE directory should be unique also.

Output

Output tab displays the configuration process execution output.

Configure and Close Buttons

To start configuration process with predefines configuration parameter settings just pres 'Configure' button.

'Close' button will (of course) close Enhydra Enterprise Configurator dialog.