Wrapper and EnTray


Table of Contents

1. Description of Wrapper's batch and shell script files
Windows batch files
Unix shell script files
2. What is EnTray?
Starting EnTray
Stopping EnTray
Using EnTray (Single service mode)
Using EnTray (multiple service mode)
EnTray Configuration
Configutation options

Chapter 1. Description of Wrapper's batch and shell script files

Windows batch files

Description of the Windows batch files located in '<enhydra_root>/multiserver/enhydra/bin':

  • 'InstallEnhydra.bat'

    Installs Enhydra as a Windows NT/2000/XP service.

  • 'UninstallEnhydra.bat'

    Removes Enhydra as a Windows NT/2000/XP service.

  • 'StartEnhydra.bat'

    Starts Enhydra as a Windows NT/2000/XP service.

  • 'StopEnhydra.bat'

    Stops Enhydra as a Windows NT/2000/XP service.

  • 'Enhydra_App.bat'

    Starts Wrapper as console and starts Enhydra in it.

All mentioned batch files use Silver Egg's 'Java Service Wrapper'.

Unix shell script files

Description of the Unix batch files located in '<enhydra_root>/multiserver/enhydra/bin':

  • 'wrapper.sh'

    Shell script file with console, start, stop, restart and dump options.

These shell script file uses Silver Egg's 'Java Service Wrapper'.

Chapter 2. What is EnTray?

EnTray is a program which serves as an indicator of the state of the Enhydra Service (ES). ES is a Windows NT/2000/XP service and can be in one of the following states: Service(s) Started, Service(s) Stopped, Start Pending, Stop Pending.

EnTray, integrated in Enhydra Enterprise Server, is completely realized in java environment (development is based on Systray project which can be furtherly examined on projects home page).

NOTE: Multiple instances of EnTray are (currently) allowed to exist on Your system (at the same time).

Starting EnTray

Enhydra EnTray can be started through batch/shell script file.

  • Windows:

    '<enhydra_root>/entray/bin/entray.bat start'

    NOTE: Installation of Enhydra as Windows system service will automaticaly start EnTray on installation mashine.

  • Unix:

    '<enhydra_root>/entray/bin/entray.sh start'

NOTE: Under Windows Enhydra EnTray can also be started through 'Start -> Programs -> <Enhydra Enterprise Server section - installation option> -> EnTray -> Show Enhydra Tray Icon' link.

Stopping EnTray

Enhydra EnTray can be stopped through batch/shell script file.

  • Windows:

    '<enhydra_root>/entray/bin/entray.bat stop'
  • Unix:

    '<enhydra_root>/entray/bin/entray.sh stop'

NOTE: Under Windows Enhydra EnTray can also be stopped through 'Start -> Programs -> <Enhydra Enterprise Enterprise Server section - installation option> -> EnTray -> Hide Enhydra Tray Icon' link.

Using EnTray (Single service mode)

Upon start, EnTray displays an icon in Systray.

ES state is indicated by the color of the icon.

  • Green icon means that ES is started.

  • Red is for stopped service.

  • Yellow (green and red nose) represents both start (green nose) and stop (red nose) pending (i.e. service is in process of being started or stopped).

  • Yellow (black nose) represents initializing state of EnTray (moment when EnTray is collecting informations whether ES is already started or not).

IMPORTANT NOTE: EnTray is completely realized in JAVA and exists as separate virtual mashine which communicates with defined ES through RMI. EnTray is not able to get informations about ES state changing (only started and stopped state informations are available for EnTray). That may affect in the way that You are able to see red icon (and not adequate menu options) even if ES is in the starting process until ES is not completely started and running (stoping process for ES is much shorter (then starting process) and these problems (for stoping process) are not so obvious). Please, be patient during service state changing!

Right click on the icon opens a context menu with five options.

  • First option in the menu is 'About' option - shows the about dialog of EnTray.

  • Second option in the menu is 'Enhydra Quick start' option - opens 'Enhydra_quick_start.html' page placed in <enhydra_root>/multiserver/enhydra/doc directory.

  • Third option in the menu is 'Add Enhydra Service' option - opens Directory Chooser which is ment to be directed to the root directory of other Enhydra Enterprise Server installation (on the same mashine). EnTray configuration parameters will be automatically imported!

    IMPORTANT NOTE: multiple services with the same service name parameter are not supported and in that case the original (already existing) service configuration will remain!

  • Fourth option in the menu is 'Exit' option - removes the indicator from the systray.

  • Fifth option in the menu depends on the state of the service: it can stop the service if it has already been started or start it if it has not.

If ES is started, additional menu entries are displayed:

  • 'Refresh Application List' - EnTray collects list of deployed applications from ES on its startup. If you, during ES runtime, deploy additional application context it will not be displayed in EnTray application list (context will not be acessible trough EnTray). This action refreshes EnTray application list.

  • List of deployed applications (if any) in ES instance which are accessible trough HTTP/1.1 browser connection.

Double left click on the indicator icon opens 'Enhydra_quick_start.html' page placed in <enhydra_root>/multiserver/enhydra/doc directory (same as second menu option).

Single left click on the indicator icon will trigger 'Refresh Application List' action.

Using EnTray (multiple service mode)

Upon start, EnTray displays an icon in Systray.

ES state is indicated by the color of the icon.

  • Green icon means that all ESs are started.

  • Red is for stopped services.

  • Yellow (black nose) is representing state in which some ESs are started and some are stopped.

  • Yellow (green and red nose) represents both start (green nose) and stop (red nose) pending (i.e. service is in process of being started or stopped).

  • White (black nose) represents initializing state of EnTray (moment when EnTray is collecting informations whether all defined ESs are already started or not).

    IMPORTANT NOTE: This icon is shown at double click action - when all defined ESs are changing their state!

IMPORTANT NOTE: EnTray is completely realized in JAVA and exists as separate virtual mashine which communicates with defined ESs through RMI. EnTray is not able to get informations about ESs state changing (only started and stopped state informations of every ES defined are available to EnTray). That may affect in the way that You are able to see red icon (and not adequate menu options) even if some ES is in the starting process until ES is not completely started and running (stoping process for ESs is much shorter (then starting process) and these problems (for stoping process) are not so obvious). Please, be patient during service state changing!

Right click on the icon opens a context menu with next options.

  • First option in the menu is 'About' option - shows the about dialog of EnTray.

  • Second option in the menu is 'Enhydra Quick start' option - opens Enhydra_quick_start.html page placed in <enhydra_root>/multiserver/enhydra/doc directory.

  • Third option in the menu is 'Add Enhydra Service' option - opens Directory Chooser which is ment to be directed to the root directory of other Enhydra Enterprise Server installation (on the same mashine). EnTray configuration parameters will be automatically imported!

    IMPORTANT NOTE: multiple services with the same service name parameter are not supported and in that case the original (already existing) service configuration will remain!

  • Fourth option in the menu is 'Exit' option - removes the indicator from the systray.

  • Fifth option in the menu is 'STOP ALL' option - stops all services. Depending on the state of the services it can be disabled (all services are already stopped) or enabled (least one service is started).

  • Sixth option in the menu is 'START ALL' option - starts all services. Depending on the state of the services it can be disabled (all services are already started) or enabled (least one service is stopped).

  • Moreover, there are options that are named as defined services and are opening submenus with next option

    • First option is 'Remove this EnTray service' option in the menu which removes actual service from the EnTray (configuration).

    • Second is option in the menu which depends on the state of the service: it can stop the (singular) service if it has already been started or start it if it has not.

    • 'Refresh Application List' - EnTray collects list of deployed applications from ES on its startup. If you, during ES runtime, deploy additional application context it will not be displayed in EnTray application list (context will not be acessible trough EnTray). This action refreshes EnTray application list.

    • List of deployed applications (if any) in ES instance which are accessible trough HTTP/1.1 browser connection.

Double left click on the indicator icon opens 'Enhydra_quick_start.html' page placed in <enhydra_root>/multiserver/enhydra/doc directory (same as second menu option).

Single left click on the indicator icon will trigger 'Refresh Application List' action for all ES instances configured - mass refresh of application lists.

EnTray Configuration

EnTray configuration is done in entray.properties file which is placed in configuration directory of installed Enhydra Enterprise Server . EnTray reads these file at startup and, acording to property settings, initializes it self.

Configutation options

EnTray configuration options are specified inside entray.properties file.

EnTray configuration parameters are listed and explained in more detail in document 'Enhydra Configuration Parameters' ( html, pdf ).