GlassFish / Sun Java System Application Server

Installation of GlassFish
Installation of CloverETL Server
Configuration of CloverETL Server on GlassFish
[Important]Important

See Application Server in system requirements for currently supported GlassFish versions and required Java versions.

GlassFish 3.1.2 contains a bug causing Launch Services to work improperly (see https://java.net/jira/browse/GLASSFISH-18444). We recommend version 3.1.2.2.

If you encounter any problems during the installation, the Possible Issues during Installation section may provide a solution.

Installation of GlassFish

  1. Choose and download the GlassFish release from the official download page.

    CloverETL Server is developed and tested with the GlassFish 3.1.2.2 container. Running the Server with other versions may result in unpredictable behavior.

  2. Extract the downloaded archive, or run the .exe file which will guide you through the setup.

  3. Run GlassFish.

    • Run [GlassFish_home]/bin/asadmin start-domain and enter a new password for administrator.

  4. Check whether GlassFish is running.

    • Open a new tab in your browser and type http://localhost:8080/ in the address bar.

      If the GlassFish welcome page appears (see below), the server is successfully installed.

    • The Admin Console is, by default, accessible at http://localhost:4848/.

      Glassfish welcome page

      Figure 3.6. Glassfish welcome page


Installation of CloverETL Server

  1. Check if you meet the prerequisites:

  2. It is strongly recommended to adjust the default limits for Memory allocation (see the Memory Settings section).

    You can set the minimum and maximum memory heap size by adjusting the "Xms" and "Xmx" JVM parameters and perm space by adjusting the "XX:MaxPermSize" parameter:

    • Edit the [GlassFish_home]/glassfish/domains/domain1/config/domain.xml file.

      Change/add the following sub-elements in the <java-config> section:

      <jvm-options>-XX:MaxPermSize=384m</jvm-options>
      <jvm-options>-XX:PermSize=256m</jvm-options>
      <jvm-options>-Xms512m</jvm-options>
      <jvm-options>-Xmx2g</jvm-options>
    • Restart GlassFish.

  3. Go to the download section of your CloverETL account and download the clover.war (web archive) file containing CloverETL Server for GlassFish 3.

  4. Deploy the clover.war file.

    • Open the GlassFish Administration Console (default URL: http://localhost:4848/).

    • Go to Applications and click Deploy ....

    • Upload the clover.war file or select the file from a filesystem if it is present on the machine running GlassFish.

    • Make sure the Web Application is selected in the Type field.

      Type "clover" in both the Application Name and the Context Root fields.

    • Click OK.

Configuration of CloverETL Server on GlassFish

[Tip]Tip
Default installation (without any configuration) is only recommended for evaluation purposes. For production use, at least a dedicated database and SMTP server configuration is recommended.

For detailed configuration of CloverETL Server, use a properties file. Here you can configure various properties, including the connection to the database, username and password, path to the license file, private properties, number of active threads, clusters and much more (see Chapter 9, List of Properties and Chapter 30, Cluster Configuration). The file can be placed either on a default, or specified location.

Content of such a file (example with MySQL database):

datasource.type=JDBC
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/clover?useUnicode=true&characterEncoding=utf8
jdbc.username=yourUsername
jdbc.password=yourPassword
jdbc.dialect=org.hibernate.dialect.MySQLDialect

Properties file in Specified Location

The properties file is loaded from a location which is specified by the environment/system property clover_config_file or clover.config.file.

  1. Create the cloverServer.properties file in a directory readable by GlassFish. (If you need an example of connection to any of supported databases, see Chapter 8, Examples of DB Connection Configuration.)

  2. Set system property clover.config.file pointing to the config properties file:

    1. Go to GlassFish Administration Console (default URL: http://localhost:4848/).

    2. Go to ConfigurationSystem Properties

    3. Create system property named clover.config.file whose value is a full path to the file on your file system (e.g.: /home/clover/cloverServer.properties).

  3. Copy the JDBC driver .jar file for a selected database into [GlassFish_home]/glassfish/domains/[domain-name]/lib

  4. Restart GlassFish.