Home » DevOps » Open Liberty Override Configuration

About Sebastian Daschner

Sebastian Daschner
Sebastian Daschner is a self-employed Java consultant and trainer. He is the author of the book 'Architecting Modern Java EE Applications'. Sebastian is a Java Champion, Oracle Developer Champion and JavaOne Rockstar.

Open Liberty Override Configuration

Open Liberty can be easily configured using the server.xml file in it’s config directory. If you’re running your servers in Docker containers you might need to specify multiple levels of configuration, for instance company-internal base images, which might need to define specific properties that are overridden or extended by the applications. Open Liberty offers multiple XML configuration override locations to solve these situations in a practical way.

Besides the obvious server.xml file, there is default configuration which resides under {server.config.dir}/configDropins/defaults/. Files in this directory are applied first.

Next, Open Liberty applies the server.xml file which resides under {server.config.dir}.

If these possibilities aren’t enough, there is also a special override directory, {server.config.dir}/configDropins/overrides/. Configuration files in this location are applied last and might extend or override previously defined properties.

Default and override configuration files are applied in alphabetical order by their file names, and need to have the same format as the server.xml. Please note that the configDropins location doesn’t exist by default and needs to be added manually when you create your own server.

Postgres driver definition

Let’s look at a quick example.

Assuming we want to connect to a Postgres database that we set up as the default datasource. To leverage Docker’s Copy-on-Write file system, we add the Postgres driver in a lower images layer, for example in the base image. That is, the JAR file is added to the server’s lib/ directory, and we define a default configuration …​/defaults/postgres-driver.xml which defines the driver:

<?xml version="1.0" encoding="UTF-8"?>
<server description="OpenLiberty Java EE 8 Server">

  <jdbcDriver id="postgresql-driver"
      javax.sql.XADataSource="org.postgresql.xa.PGXADataSource"
      javax.sql.ConnectionPoolDataSource="org.postgresql.ds.PGConnectionPoolDataSource"
      libraryRef="postgresql-library"/>

  <library id="postgresql-library">
    <fileset id="PostgreSQLFileset" dir="/opt/wlp/lib"
        includes="postgresql-9.4.1212.jar"/>
  </library>

</server>

The JDBC driver in this default configuration can now be used in other configuration locations.

The Docker images of our application defines the datasource with the connection details in the server.xml:

<?xml version="1.0" encoding="UTF-8"?>
<server description="Coffee shop">

  <!-- Postgres coffee-shop-db definition -->
  <dataSource id="DefaultDataSource" jdbcDriverRef="postgresql-driver"
      type="javax.sql.ConnectionPoolDataSource" transactional="true">

    <properties serverName="coffee-shop-db" portNumber="5432"
        databaseName="postgres" user="postgres" password="postgres"/>

  </dataSource>

</server>

Again: we have two Docker images, one base image which ships Open Liberty and includes the postgres-driver.xml and JAR file, and our application image, that adds the server.xml configuration, and, of course, our application.

In this way, the application’s server configuration stays lean and doesn’t need to repeat all defaults that have been made in the company-internal base image.

Published on Java Code Geeks with permission by Sebastian Daschner, partner at our JCG program. See the original article here: Open Liberty Override Configuration

Opinions expressed by Java Code Geeks contributors are their own.

(0 rating, 0 votes)
You need to be a registered member to rate this.
Start the discussion Views Tweet it!
Do you want to know how to develop your skillset to become a Java Rockstar?
Subscribe to our newsletter to start Rocking right now!
To get you started we give you our best selling eBooks for FREE!
1. JPA Mini Book
2. JVM Troubleshooting Guide
3. JUnit Tutorial for Unit Testing
4. Java Annotations Tutorial
5. Java Interview Questions
6. Spring Interview Questions
7. Android UI Design
and many more ....
I agree to the Terms and Privacy Policy

Leave a Reply

avatar

This site uses Akismet to reduce spam. Learn how your comment data is processed.

  Subscribe  
Notify of