Chapter 2. JEUS Environment

Table of Contents

2.1. Management Tools
2.2. Directory Structure
2.3. Environment Variables
2.4. Environment Configuration Files

This chapter describes JEUS management tools, directory structureenvironment variables, and XML configuration files.

2.1. Management Tools

The following tools are used to access JEUS.

ToolDescription
WebAdminHTML-based management tool that provides features to control, monitor, and manage JEUS. For more information, refer to "JEUS WebAdmin Guide".
startDomainAdminServerBasic tool for starting JEUS DAS. For more information, refer to "JEUS XML Reference".
startManagedServer

Basic tool for starting JEUS DAS. For more information, refer to "JEUS Reference Book".

jeusadmin

Used to control JEUS from a command prompt. For more information, refer to JEUS Reference Book. "4.2. jeusadmin"

Note

There are other tools that can start EJB and Servlet engines. For more information, refer to "JEUS Reference Book".

2.2. Directory Structure

The following figure shows the directory structure after JEUS has been installed.

[Figure 2.1] Directory Structure After Installing JEUS

Directory Structure After Installing JEUS


The following is a description of each directory and file.

{JEUS_HOME}

The top level directory of JEUS. The actual directory name and location are selected during installation.

bin

Contains the scripts to start and stop servers. The scripts are startDomainAdminServer, startManagedServer, and stopServer. This directory also contains the executable files including the JEUS console tool 'jeusadmin'.

derby

Contains Apache Derby, which helps users build sample applications or perform tests..

docs

Contains Javadoc documentations for the APIs provided by JEUS.

lib

Contains the libraries used to start JEUS. Users only need to access the shared directory.

DirectoryDescription
shared

Contains the libraries used by applications. Library information must be added to libraries.xml in order to use the libraries in the shared directory. Reference information about the library must also be specified in the JEUS deployment descriptor of the application that will use the library.

For detailed information about the shared library, refer to JEUS Applications & Deployment Guide. "3.3.2. Shared Library".

license

Contains JEUS license files that are needed to execute JEUS.

nodemanager

Contains the jeusnm.xml file used to configure JEUS nodemanager.

setup

Contains the files needed to set up the environment to use JEUS after JEUS has been installed.

templates

Contains configuration file templates.

samples

Contains example files for JEUS.

webserver

Directory where the JEUS Web server is installed during the JEUS installation. For details, refer to "JEUS Web Engine Guide".

domains

Each domain contains a file named nodes.xml that contains the information about the nodes used from DOMAIN_HOME and JEUS_HOME.

DOMAIN_HOME contains the following files and directories:

  • .applications

    Contains application files managed by the domain. These can only be added or deleted by using the install-application and uninstall-application commands. This is a JEUS system directory with restricted user access.

    For detailed information about each command, refer to JEUS Reference Book. "4.2.6.16. uninstall-application".

  • .deploymentplans

    Contains deployment plan files managed by the domain. These can only be added or deleted by using the install-deployment-plan and uninstall-deployment-plan commands. This is a JEUS system directory with restricted user access.

    For detailed information about each command, refer to JEUS Reference Book. "4.2.6.8. install-deployment-plan" and JEUS Reference Book. "4.2.6.17. uninstall-deployment-plan".

  • .libraries

    Contains library files managed by the domain. These can only be added or deleted by using the install-application and uninstall-application commands. This is a JEUS system directory with restricted user access.

    For detailed information about each command, refer to JEUS Reference Book. "4.2.6.7. install-application" and JEUS Reference Book. "4.2.6.16. uninstall-application".

  • bin

    Contains the scripts to start or stop the DAS and MSs of the domain. The functions of the scripts are the same as startDomainAdminServer, startManagedServer, and stopServer scripts in the 'JEUS_HOME/bin' directory, except that the users don't need to specify the file names.

  • config

    Contains backup files that store changes to domain.xml, a do main configuration file. For detailed information about domain configurations, refer to JEUS Domain Guide. "Chapter 3. Changing Domain Settings".

    DirectoryDescription
    security
    • SYSTEM_DOMAIN: Contains security domain files, including accounts.xml and policies.xml. Each XML file can be dynamically modified by using WebAdmin and jeusadmin. For detailed information about security domain configurations, refer to JEUS Security Guide. "2.2. Configuring the Security System Domain".

    • security.key: Contains the keys for symmetric key encryption. They are created when 'JEUS_HOME/bin/encryption' is executed. For detailed information about the security.key file, refer to JEUS Security Guide. "2.5.4. Configuring Password Security".

    • policy: Contains the Java permissions configuration file. This is used by Java SE Security Manager, separate from the JEUS security system.

    servlet
    • web.xml: This file is used when a Web module does not have a separate web.xml file. By default, the file is empty.

    • webcommon.xml: Settings that apply to all Web modules of the Web engines in the domain. For detailed information about the file, refer to JEUS Web Engine Guide. "1.5. Directory Structure".

  • lib/application

    Contains the shared application libraries for the domain. If a library conflicts with an application library in the SERVER_HOME directory, it is overridden by 'SERVER_HOME/lib/application' and a warning message appears. For detailed information about the 'lib/application' directory, refer to JEUS Applications & Deployment Guide. "3.3.1. The lib/application Directory".

  • servers

    Create the SERVER_HOME directory by using the server name in this directory. For detailed information about the directory structure, refer to JEUS Server Guide. "1.5. Directory Structure".

    DirectoryDescription
    .workspaceContains workspaces used by each JEUS server. Cannot be modified by the user.
    binContains scripts to start and stop the server. The scripts execute the same functions as those in 'JEUS_HOME/bin', except that there is no need to specify the names of the domains and servers in the scripts. DASs use the startDomainAdminServer and stopServer scripts, and MSs use the startManagedServer and stopServer scripts.
    lib/application

    Contains the shared application libraries for the domain. If a library conflicts with an application library in the SERVER_HOME directory, it is overridden by 'SERVER_HOME/lib/application' and a warning message appears.

    For detailed information about the 'lib/application' directory, refer to

    JEUS Applications & Deployment Guide. "3.3.1. The lib/application Directory".

    logsIncludes launcher logs, server logs, and access log files. For detailed information, refer to JEUS Server Guide. "Chapter 8. Logging".
    nodemanagerContains information used to determine whether a server is managed when a node manager restarts. This is a JEUS system directory with restricted user access.

2.3. Environment Variables

All JEUS environment variables are configured in 'JEUS_HOM/bin/jeus.properties' and are used by the scripts in 'JEUS_HOME/bin'.

The following table shows the environment variables used in JEUS.

Environment VariablesDescription
JEUS_HOME

Directory where JEUS is installed. This variable is required.

Example: JEUS_HOME=/home/jeus/jeus8

JAVA_HOME

Directory where JDK is installed.

Example: JAVA_HOME=/usr/jdk1.7

The variables can be changed when necessary, but they cannot be used in an XML configuration file. All environment variables are set to default values during installation. In most cases, the default values can be used without any changes.

Note

Changing the environment variables varies according to the OS. Refer to each OS manual for more information.

2.4. Environment Configuration Files

JEUS environment is configured by using XML. The configurations can be changed manually or with tools. The following tables describe the XML configuration files and their locations.

  • domain.xml (jeus-domain.xsd, ejb-engine.xsd, web-engine.xsd, jms-engine.xsd)

    LocationJEUS_HOME/domains/<domain_name>/config/
    DescriptionBasic configuration file that manages JEUS Manager and nodes.
    Related ManualJEUS Domain Guide, JEUS Server Guide
  • jeusnm.xml (jeus-nodemanager.xsd)

    LocationJEUS_HOME/nodemanager
    DescriptionConfiguration file that sets the operation method of the node manager in a node.
    Related ManualJEUS Node Manager Guide
  • jeus-web-dd.xml (jeus-web-dd.xsd)

    LocationWEB-INF directory in the web application archive.
    DescriptionJEUS Web application (servlet app) deployment descriptor file.
    Related ManualJEUS Web Engine Guide
  • jeus-ejb-dd.xml (jeus-ejb-dd.xsd)

    LocationMETA-INF directory in the EJB application archive.
    DescriptionJEUS EJB module deployment descriptor file.
    Related ManualJEUS EJB Guide
  • jeus-client-dd.xml (jeus-client-dd.xsd)

    LocationWEB-INF directory in the client application archive.
    DescriptionApplication client DD(Deployment Descriptors) file.
    Related ManualJEUS Application Client Guide
  • jeus-connector-dd.xml (jeus-connector-dd.xsd)

    LocationMETA-INF directory in the resource adapter archive.
    DescriptionResource adapter deployment descriptor file.
    Related ManualJEUS JCA Guide
  • policies.xml (policies.xsd)

    LocationJEUS_HOME/domains/<domainname>/config/security
    DescriptionJEUS security policies.
    Related ManualJEUS Security Guide
  • accounts.xml (accounts.xsd)

    LocationJEUS_HOME/domains/<domainname>/config/security
    DescriptionJEUS security accounts.
    Related ManualJEUS Security Guide
  • jeus-web-dd.xml (jeus-web-dd.xsd), jeus-ejb-dd.xml (jeus-ejb-dd.xsd), jeus-client-dd.xml (jeus-client-dd.xsd)

    LocationMETA-INF directory in the Web service client archive.
    DescriptionWeb service client information.
    Related ManualJEUS Web Service Guide
  • jeus-webservices-config.xml (jeus-webservices-config.xsd)

    LocationMETA-INF directory in the Web service client archive
    DescriptionAnt tasks for Web services
    Related ManualJEUS Web Service Guide

Note

1. The Java EE standard descriptor files, web.xml and ejb-jar.xml, are also used. For information about each file, refer to the Java EE specification.

2. All XML schema files are located in the 'JEUS_HOME/lib/schemas/jeus/' directory.